1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Configurations
  4. Currency Exchange

Retrieve configured currency exchange

get

/spms/v2/ships/{shipId}/configurations/currencyExchanges

This is to retrieve the configured currency exchanges records.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Ok
Body ()
Root Schema : Currency Exchange Success Oracle Responses list
Type: object
Title: Currency Exchange Success Oracle Responses list
The wrapper object when returning successful values in Oracle standard
Show Source
Nested Schema : items
Type: array
Show Source
Example:
[
    {
        "id":12345,
        "code":"AUD",
        "description":"AUSTRALIAN DOLLAR",
        "validDateFrom":"01-08-23",
        "disableDateFrom":"31-12-30",
        "mininumBuyDenomination":1,
        "mininumSellDenomination":1,
        "baseCurrency":{
            "code":"USD",
            "description":"US DOLLAR"
        },
        "rateCalculation":"1 base=x foreign",
        "availableNotes":"Currency exchange details for Australian dollar",
        "rateRegularBuy":{
            "exchangeRate":2,
            "commissionPercentage":2,
            "mininumCommissionPercentage":2
        },
        "rateRegularSell":{
            "exchangeRate":3,
            "commissionPercentage":3,
            "mininumCommissionPercentage":3
        },
        "rateCrewBuy":{
            "exchangeRate":4,
            "commissionPercentage":4,
            "mininumCommissionPercentage":4
        },
        "rateCrewSell":{
            "exchangeRate":5,
            "commissionPercentage":5,
            "mininumCommissionPercentage":5
        },
        "safeExchangeRate":0.5
    },
    {
        "id":99999,
        "code":"USD",
        "description":"US DOLLAR",
        "validDateFrom":"01-08-23",
        "disableDateFrom":"31-12-30",
        "mininumBuyDenomination":1,
        "mininumSellDenomination":1,
        "baseCurrency":{
            "code":"AUD",
            "description":"AUSTRALIAN DOLLAR"
        },
        "rateCalculation":"1 base=x foreign",
        "availableNotes":"Currency exchange details for US dollar",
        "rateRegularBuy":{
            "exchangeRate":2,
            "commissionPercentage":2,
            "mininumCommissionPercentage":2
        },
        "rateRegularSell":{
            "exchangeRate":3,
            "commissionPercentage":3,
            "mininumCommissionPercentage":3
        },
        "rateCrewBuy":{
            "exchangeRate":4,
            "commissionPercentage":4,
            "mininumCommissionPercentage":4
        },
        "rateCrewSell":{
            "exchangeRate":5,
            "commissionPercentage":5,
            "mininumCommissionPercentage":5
        },
        "safeExchangeRate":0.6
    }
]
Nested Schema : configurationCurrencyExchange
Type: object
configurationCurrencyExchange
Show Source
Nested Schema : baseCurrency
Type: object
Base Currency
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Base Currency Code
    Example: USD
  • Minimum Length: 1
    Maximum Length: 50
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Base Currency Description
    Example: US DOLLAR
Nested Schema : rateCrewBuy
Type: object
Rate Crew Buy
Show Source
Nested Schema : rateCrewSell
Type: object
Rate Crew Sell
Show Source
Nested Schema : rateRegularBuy
Type: object
Rate Regular Buy
Show Source
Nested Schema : rateRegularSell
Type: object
Rate Regular Sell
Show Source

204 Response

No Content

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter 'shipId' has incorrect format"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"You are forbidden to use this API"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

404 Response

Not found
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship Id could not be found"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

405 Response

Method Not Allowed
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

406 Response

Not acceptable
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"Request a Mime type that is supported for this Resource"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

410 Response

Gone
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
    "title":"Gone",
    "detail":"Requested Resource no longer exists"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

415 Response

Unsupported Media Type
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "detail":"Content type not supported"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Issue fulfilling request. Please retry or contact support"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

501 Response

Not Implemented
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
    "title":"Not implemented",
    "detail":"Resource is not implemented in this version of the API"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service not available"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source
Back to Top