1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Interfaces
  4. Credit Card Terminal

Retrieve a list of all credit card terminal records

get

/spms/v2/ships/{shipId}/interfaces/creditCardTerminals

This is to retrieve list of all credit card terminal records

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Oracle Responses - All Credit Card Terminals
Type: object
Title: Oracle Responses - All Credit Card Terminals
The wrapper object when returning successful values in Oracle standard
Show Source
Nested Schema : items
Type: array
Show Source
Example:
[
    {
        "id":1,
        "deviceId":"F-01",
        "label":"Credit Card Terminal 774",
        "location":{
            "id":1009,
            "code":"meet",
            "title":"Boutique",
            "description":"Meeting room",
            "comment":"room 3",
            "status":false,
            "deck":"3",
            "deckName":"deck 3",
            "ShouldWarnIfOverLap":false,
            "picFileName":"deck3.jpg"
        }
    },
    {
        "id":2,
        "deviceId":"F-030",
        "label":"Credit Card Terminal 722",
        "location":{
            "id":1001,
            "code":"pool",
            "title":"Baby Club Chicco",
            "description":"Pool Side",
            "comment":"30 meter within the pool",
            "status":true,
            "deck":"7",
            "deckName":"Roof Top",
            "ShouldWarnIfOverLap":false,
            "picFileName":"RoofTop.jpg"
        }
    },
    {
        "id":3,
        "deviceId":"F-094",
        "label":"Credit Card Terminal 356",
        "location":{
            "id":1001,
            "code":"pool",
            "title":"Baby Club Chicco",
            "description":"Pool Side",
            "comment":"30 meter within the pool",
            "status":true,
            "deck":"7",
            "deckName":"Roof Top",
            "ShouldWarnIfOverLap":false,
            "picFileName":"RoofTop.jpg"
        }
    }
]
Nested Schema : GetCreditCardTerminal
Match All
Show Source
Nested Schema : CreditCardTerminal
Type: object
Title: CreditCardTerminal
Show Source
  • This value is refer to Terminal ID number. The Terminal ID number provided by the vendor
    Example: FO-01
  • A label or description for the terminal/ device that identifies its physical location. This helps you easily identify the terminal/device when it appears in a list of devices
    Example: Terminal 101
Nested Schema : GetCreditCardTerminal-allOf[1]
Type: object
Show Source
Nested Schema : GetLocation
Type: object
Title: GetLocation
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.2",
    "title":"Bad Request",
    "detail":"limit must not be less than one!"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

401 Response

Unauthorised
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorised",
    "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":"Access to this resource was forbidden"
}
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 123 was not 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":"https://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

500 Response

Internal Server Error
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://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

503 Response

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