Jump to

• Request
• Response

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

Body ()

Required to create credit card terminal

Root Schema : CreateUpdateCreditCardTerminalRequest

Match All

Show Source

• object CreditCardTerminal
  Title: CreditCardTerminal
• object CreateUpdateCreditCardTerminalRequest-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardTerminal"
        },
        {
            "type":"object",
            "properties":{
                "deviceId":{
                    "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\\|,.\":;{}[]",
                    "type":"string"
                },
                "label":{
                    "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\\|,.\":;{}[]",
                    "type":"string"
                },
                "locationId":{
                    "$ref":"#/definitions/LocationId"
                }
            }
        }
    ],
    "required":[
        "deviceId",
        "label"
    ]
}

Nested Schema : CreditCardTerminal

Type: object

Title: CreditCardTerminal

Show Source

• deviceId(optional): string
  This value is refer to Terminal ID number. The Terminal ID number provided by the vendor

  Example: 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 devices

  Example: Terminal 101

{
    "title":"CreditCardTerminal",
    "type":"object",
    "properties":{
        "deviceId":{
            "type":"string",
            "description":"This value is refer to Terminal ID number. The Terminal ID number provided by the vendor",
            "example":"FO-01"
        },
        "label":{
            "type":"string",
            "description":"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 : CreateUpdateCreditCardTerminalRequest-allOf[1]

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "deviceId":{
            "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\\|,.\":;{}[]",
            "type":"string"
        },
        "label":{
            "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\\|,.\":;{}[]",
            "type":"string"
        },
        "locationId":{
            "$ref":"#/definitions/LocationId"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

Body ()

Root Schema : GetCreditCardTerminal

Match All

Show Source

• object CreditCardTerminal
  Title: CreditCardTerminal
• object GetCreditCardTerminal-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardTerminal"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"number",
                    "description":"This is the id of credit card terminal row id",
                    "example":"1"
                },
                "deviceId":{
                    "example":"FO-01",
                    "type":"string"
                },
                "label":{
                    "example":"Terminal 101",
                    "type":"string"
                },
                "location":{
                    "type":"object",
                    "$ref":"#/definitions/Location",
                    "description":"This is to let user know where is the credit card terminals located."
                }
            }
        }
    ]
}

Nested Schema : CreditCardTerminal

Type: object

Title: CreditCardTerminal

Show Source

• deviceId(optional): string
  This value is refer to Terminal ID number. The Terminal ID number provided by the vendor

  Example: 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 devices

  Example: Terminal 101

{
    "title":"CreditCardTerminal",
    "type":"object",
    "properties":{
        "deviceId":{
            "type":"string",
            "description":"This value is refer to Terminal ID number. The Terminal ID number provided by the vendor",
            "example":"FO-01"
        },
        "label":{
            "type":"string",
            "description":"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

• deviceId(optional): string
  Example: FO-01
• id(optional): number
  This is the id of credit card terminal row id

  Example: 1
• label(optional): string
  Example: Terminal 101
• location(optional): object GetLocation
  Title: GetLocation

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "description":"This is the id of credit card terminal row id",
            "example":"1"
        },
        "deviceId":{
            "example":"FO-01",
            "type":"string"
        },
        "label":{
            "example":"Terminal 101",
            "type":"string"
        },
        "location":{
            "type":"object",
            "$ref":"#/definitions/Location",
            "description":"This is to let user know where is the credit card terminals located."
        }
    }
}

Nested Schema : GetLocation

Type: object

Title: GetLocation

Show Source

• code(optional): string
  location code

  Example: Pool
• comment(optional): string
  location comment

  Example: oracle.doceng.json.BetterJsonNull@785dbe3a
• deck(optional): string
  location deck
• deckName(optional): string
  deck name
• description(optional): string
  location description

  Example: 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 location

  Example: true
• title(optional): string
  The location title

  Example: Art Gallery

{
    "title":"GetLocation",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/LocationId"
        },
        "code":{
            "type":"string",
            "description":"location code",
            "example":"Pool"
        },
        "title":{
            "type":"string",
            "description":"The location title",
            "example":"Art Gallery"
        },
        "description":{
            "type":"string",
            "description":"location description",
            "example":"Study Room"
        },
        "comment":{
            "type":"string",
            "description":"location comment",
            "example":null
        },
        "status":{
            "type":"boolean",
            "description":"The status of the location",
            "example":"true"
        },
        "deck":{
            "type":"string",
            "description":"location deck"
        },
        "deckName":{
            "type":"string",
            "description":"deck name"
        },
        "shouldWarnIfOverlap":{
            "type":"boolean",
            "description":"location overlap book (true - Warn, false - Do not Warn)"
        },
        "picFileName":{
            "type":"string",
            "description":"location picture filename"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardTerminalErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Bad Request",
        "detail":"Invalid status"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardTerminalErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardTerminalErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardTerminalErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardTerminalErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

409 Response

Conflict

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardTerminalErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
        "title":"Method Not Allowed",
        "detail":"Duplicated Device Id Found"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

415 Response

Unsupported Media Type

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardTerminalErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type Not supported"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardTerminalErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardTerminalErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable.  Try again later"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top