Jump to

• Request
• Response

Retrieve Stateroom Upgrade Charges and Parameters

post

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

This is to retrieve the configured stateroom upgrade charge item and parameters

Request

Supported Media Types

• application/json

Path Parameters

• shipId(required): number
  ship Id

Body ()

Required to retrieve charges

Root Schema : Stateroom Upgrade Charges Request

Type: object

Title: Stateroom Upgrade Charges Request

Stateroom Upgrade Charges Request

Show Source

• currentStateroomCategoryCode(required): string
  Maximum Length: 6

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=|^'":;@`]*$

  current stateroom category code

  Example: CAB1
• upgradeStateroomCategoryCode(required): string
  Maximum Length: 6

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=|^'":;@`]*$

  upgrade stateroom category code

  Example: CAB2

{
    "title":"Stateroom Upgrade Charges Request",
    "description":"Stateroom Upgrade Charges Request",
    "type":"object",
    "properties":{
        "currentStateroomCategoryCode":{
            "type":"string",
            "description":"current stateroom category code",
            "maxLength":6,
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=|^'\":;@`]*$",
            "example":"CAB1"
        },
        "upgradeStateroomCategoryCode":{
            "type":"string",
            "description":"upgrade stateroom category code",
            "maxLength":6,
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=|^'\":;@`]*$",
            "example":"CAB2"
        }
    },
    "required":[
        "currentStateroomCategoryCode",
        "upgradeStateroomCategoryCode"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Stateroom Upgrade Charges

Type: object

Title: Stateroom Upgrade Charges

Stateroom Upgrade Charges

Show Source

• chargeDepartment: object chargeDepartment
  Charge Department
• isStateroomUpgradeChargeRequired: boolean
  Title: is Stateroom Upgrade Charge Required

  is Stateroom Upgrade Charge Required

  Example: true
• isStateroomUpgradeReasonRequired: boolean
  Title: is Stateroom Upgrade Reason Required

  is Stateroom Upgrade Reason Required

  Example: true
• stateroomUpgradeItem: array stateroomUpgradeItem
• upgradeAmount: number
  Title: Upgrade Amount

  Upgrade Amount

  Example: 450

{
    "title":"Stateroom Upgrade Charges",
    "description":"Stateroom Upgrade Charges",
    "type":"object",
    "properties":{
        "stateroomUpgradeItem":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/statetoomUpgradeItem"
            }
        },
        "upgradeAmount":{
            "title":"Upgrade Amount",
            "description":"Upgrade Amount",
            "type":"number",
            "example":450
        },
        "chargeDepartment":{
            "type":"object",
            "description":"Charge Department",
            "allOf":[
                {
                    "$ref":"#/definitions/stateroomUpgradeDepartment"
                }
            ]
        },
        "isStateroomUpgradeReasonRequired":{
            "title":"is Stateroom Upgrade Reason Required",
            "description":"is Stateroom Upgrade Reason Required",
            "type":"boolean",
            "example":true
        },
        "isStateroomUpgradeChargeRequired":{
            "title":"is Stateroom Upgrade Charge Required",
            "description":"is Stateroom Upgrade Charge Required",
            "type":"boolean",
            "example":true
        }
    }
}

Nested Schema : chargeDepartment

Type: object

Charge Department

Match All

Charge Department

Show Source

• object Department
  Title: Department

  Department

{
    "type":"object",
    "description":"Charge Department",
    "allOf":[
        {
            "$ref":"#/definitions/stateroomUpgradeDepartment"
        }
    ]
}

Nested Schema : stateroomUpgradeItem

Type: array

Show Source

• Array of: array statetoomUpgradeItem
  Stateroom Upgrade item

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/statetoomUpgradeItem"
    }
}

Nested Schema : Department

Type: object

Title: Department

Department

Show Source

• code: string
  Title: Department Code

  Department Code

  Example: post
• description: string
  Title: Department Description

  Department Description

  Example: Posting Department

{
    "title":"Department",
    "description":"Department",
    "type":"object",
    "properties":{
        "code":{
            "title":"Department Code",
            "description":"Department Code",
            "type":"string",
            "example":"post"
        },
        "description":{
            "title":"Department Description",
            "description":"Department Description",
            "type":"string",
            "example":"Posting Department"
        }
    }
}

Nested Schema : statetoomUpgradeItem

Type: array

Stateroom Upgrade item

Show Source

• Array of: object items

{
    "description":"Stateroom Upgrade item",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "title":"id",
                "description":"ID",
                "type":"integer",
                "example":1
            },
            "stateroomCategoryCode":{
                "title":"Stateroom Category Code",
                "description":"Stateroom Category Code",
                "type":"string",
                "example":"01"
            },
            "stateroomCategoryDescription":{
                "title":"Stateroom Category Description",
                "description":"Stateroom Category Description",
                "type":"string",
                "example":"Suite"
            },
            "price":{
                "title":"Price",
                "description":"Price",
                "type":"number",
                "example":450
            },
            "sortNumber":{
                "title":"Sort Number",
                "description":"Sort Number",
                "type":"integer",
                "example":1
            },
            "maximumPerson":{
                "title":"Maximum Person",
                "description":"Maximum Person",
                "type":"integer",
                "example":4
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id: integer
  Title: id

  ID

  Example: 1
• maximumPerson: integer
  Title: Maximum Person

  Maximum Person

  Example: 4
• price: number
  Title: Price

  Price

  Example: 450
• sortNumber: integer
  Title: Sort Number

  Sort Number

  Example: 1
• stateroomCategoryCode: string
  Title: Stateroom Category Code

  Stateroom Category Code

  Example: 01
• stateroomCategoryDescription: string
  Title: Stateroom Category Description

  Stateroom Category Description

  Example: Suite

{
    "type":"object",
    "properties":{
        "id":{
            "title":"id",
            "description":"ID",
            "type":"integer",
            "example":1
        },
        "stateroomCategoryCode":{
            "title":"Stateroom Category Code",
            "description":"Stateroom Category Code",
            "type":"string",
            "example":"01"
        },
        "stateroomCategoryDescription":{
            "title":"Stateroom Category Description",
            "description":"Stateroom Category Description",
            "type":"string",
            "example":"Suite"
        },
        "price":{
            "title":"Price",
            "description":"Price",
            "type":"number",
            "example":450
        },
        "sortNumber":{
            "title":"Sort Number",
            "description":"Sort Number",
            "type":"integer",
            "example":1
        },
        "maximumPerson":{
            "title":"Maximum Person",
            "description":"Maximum Person",
            "type":"integer",
            "example":4
        }
    }
}

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/StateroomUpgradeChargesErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"ShipId not found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"ShipId not found"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: 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/StateroomUpgradeChargesErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: 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/StateroomUpgradeChargesErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource is forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/StateroomUpgradeChargesErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"This resource path does not exist"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"This resource path does not exist"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: 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/StateroomUpgradeChargesErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: 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/StateroomUpgradeChargesErrorResponse"
        }
    ],
    "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: string
• title: string
• type: 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/StateroomUpgradeChargesErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail: string
• title: string
• type: 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/StateroomUpgradeChargesErrorResponse"
        }
    ],
    "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: string
• title: string
• type: 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