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
- application/json
Path Parameters
-
shipId: number(12345678)
Ship ID
Query Parameters
-
deviceId: string
-
label: string
-
limit: integer(int32)
Paging limit
-
locationCode: string
-
locationTitle: string
-
offset: integer(int32)
Paging offset
-
orderBy: string
order by id or deviceId or label or locationId or locationCode or locationTitle or locationDescription or locationDeck or locationDeckName or locationPicFileName or locationStatus or locationShouldWarnIfOverLap or locationComment with format column1:asc/desc,column2:asc/desc
-
searchValue: string
search on Credit Card Terminal Id or Credit Card label or location title with like condition
Response
Supported Media Types
- application/json
200 Response
OK
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
-
count(optional):
integer
The total number of items in the list.Example:
3
-
hasMore(optional):
boolean
Flag which indicates whether or not there are more items.Example:
false
-
items(optional):
array items
Nested Schema : items
Type:
Show Source
array
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
-
object
CreditCardTerminal
Title:
CreditCardTerminal
-
object
GetCreditCardTerminal-allOf[1]
Nested Schema : CreditCardTerminal
Type:
object
Title:
Show Source
CreditCardTerminal
-
deviceId(optional):
string
This value is refer to Terminal ID number. The Terminal ID number provided by the vendorExample:
FO-01
-
label(optional):
string
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 devicesExample:
Terminal 101
Nested Schema : GetCreditCardTerminal-allOf[1]
Type:
Show Source
object
-
deviceId(optional):
string
Example:
FO-01
-
id(optional):
number
This is the id of credit card terminal row idExample:
1
-
label(optional):
string
Example:
Terminal 101
-
location(optional):
object GetLocation
Title:
GetLocation
Nested Schema : GetLocation
Type:
object
Title:
Show Source
GetLocation
-
code(optional):
string
location codeExample:
Pool
-
comment(optional):
string
location commentExample:
oracle.doceng.json.BetterJsonNull@785dbe3a
-
deck(optional):
string
location deck
-
deckName(optional):
string
deck name
-
description(optional):
string
location descriptionExample:
Study Room
-
id(optional):
integer
This value is refer to Location ID number.Example:
1001
-
picFileName(optional):
string
location picture filename
-
shouldWarnIfOverlap(optional):
boolean
location overlap book (true - Warn, false - Do not Warn)
-
status(optional):
boolean
The status of the locationExample:
true
-
title(optional):
string
The location titleExample:
Art Gallery
204 Response
No Content
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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