Create/ Add credit card terminal record
post
/spms/v2/ships/{shipId}/interfaces/creditCardTerminals
This is to create/ add credit card terminal record
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number(12345678)
Ship ID
Required to create credit card terminal
Root Schema : CreateUpdateCreditCardTerminalRequest
Match All
Show Source
-
object
CreditCardTerminal
Title:
CreditCardTerminal
-
object
CreateUpdateCreditCardTerminalRequest-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 : CreateUpdateCreditCardTerminalRequest-allOf[1]
Type:
Show Source
object
-
deviceId(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
-
label(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
-
locationId(optional):
integer
This value is refer to Location ID number.Example:
1001
Response
Supported Media Types
- application/json
201 Response
Created
Root 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@38379575
-
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
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":"Invalid status"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
Unauthorized
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
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
409 Response
Conflict
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.10",
"title":"Method Not Allowed",
"detail":"Duplicated Device Id Found"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
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.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
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