Jump to

• Request
• Response

Retrieve configured ship vertical zones

get

/spms/v2/ships/{shipId}/configurations/safety/shipVerticalZones

This is to retrieve the configured ship vertical zones

Request

Supported Media Types

• application/json

Path Parameters

• shipId: number
  ship Id

Query Parameters

• limit: integer(int32)
  Minimum Value: 0

  Paging limit
• offset: integer(int32)
  Minimum Value: 0

  Paging offset
• orderBy: string
  Minimum Value: 0

  order by shipVerticalZoneCode, shipVerticalZoneName, shipVerticalZoneCapacity with format column1:asc/desc,column2:asc/desc,column3:asc/desc. Default ordering with shipVerticalZoneName:asc
• shipVerticalZoneCode: string
  Ship vertical zone code.
• shipVerticalZoneName: string
  Ship vertical zone name

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Ship Vertical Zone GET Response

Type: object

Title: Ship Vertical Zone GET Response

The wrapper object when returning successful values in Oracle standard

Show Source

• count(optional): number
  The total number of items in the list.

  Example: 1
• hasMore(optional): boolean
  Flag which indicates whether or not there are more items.

  Example: false
• items(optional): array items
• limit(optional): number
  Paging limit

  Example: 5
• offset(optional): number
  Paging offset

  Example: 10

{
    "title":"Ship Vertical Zone GET Response",
    "description":"The wrapper object when returning successful values in Oracle standard",
    "type":"object",
    "properties":{
        "count":{
            "description":"The total number of items in the list.",
            "type":"number",
            "example":1
        },
        "hasMore":{
            "description":"Flag which indicates whether or not there are more items.",
            "type":"boolean",
            "example":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ShipVerticalZonesGetResponseDetails"
            }
        },
        "limit":{
            "description":"Paging limit",
            "type":"number",
            "example":5
        },
        "offset":{
            "description":"Paging offset",
            "type":"number",
            "example":10
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Ship Vertical Zone Configuration List
  Title: Ship Vertical Zone Configuration List

  List of Ship Vertical Zones

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

Nested Schema : Ship Vertical Zone Configuration List

Type: object

Title: Ship Vertical Zone Configuration List

List of Ship Vertical Zones

Show Source

• shipVerticalZoneCapacity(optional): string
  Ship vertical zone capacity.

  Example: 200
• shipVerticalZoneCode(optional): string
  Ship vertical zone code. Null represents unassigned ship vertical zone for the stateroom.

  Example: ZA
• shipVerticalZoneName(optional): string
  Ship vertical zone name. Null represents unassigned ship vertical zone for the stateroom.

  Example: Zone A

{
    "title":"Ship Vertical Zone Configuration List",
    "description":"List of Ship Vertical Zones",
    "type":"object",
    "properties":{
        "shipVerticalZoneCode":{
            "type":"string",
            "description":"Ship vertical zone code. Null represents unassigned ship vertical zone for the stateroom.",
            "example":"ZA"
        },
        "shipVerticalZoneName":{
            "type":"string",
            "description":"Ship vertical zone name. Null represents unassigned ship vertical zone for the stateroom.",
            "example":"Zone A"
        },
        "shipVerticalZoneCapacity":{
            "type":"string",
            "description":"Ship vertical zone capacity.",
            "example":"200"
        }
    }
}

204 Response

No Content

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Ship Vertical Zone Error Response
  Title: Ship Vertical Zone Error Response

  Ship Vertical Zone Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ShipVerticalZonesErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter shipId has incorrect format"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter shipId has incorrect format"
}

Nested Schema : Ship Vertical Zone Error Response

Type: object

Title: Ship Vertical Zone Error Response

Ship Vertical Zone Error Response returned when encountered error

Show Source

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

{
    "title":"Ship Vertical Zone Error Response",
    "description":"Ship Vertical Zone 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 Ship Vertical Zone Error Response
  Title: Ship Vertical Zone Error Response

  Ship Vertical Zone Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ShipVerticalZonesErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorized",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource"
}

Nested Schema : Ship Vertical Zone Error Response

Type: object

Title: Ship Vertical Zone Error Response

Ship Vertical Zone Error Response returned when encountered error

Show Source

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

{
    "title":"Ship Vertical Zone Error Response",
    "description":"Ship Vertical Zone 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 Ship Vertical Zone Error Response
  Title: Ship Vertical Zone Error Response

  Ship Vertical Zone Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ShipVerticalZonesErrorResponse"
        }
    ],
    "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 : Ship Vertical Zone Error Response

Type: object

Title: Ship Vertical Zone Error Response

Ship Vertical Zone Error Response returned when encountered error

Show Source

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

{
    "title":"Ship Vertical Zone Error Response",
    "description":"Ship Vertical Zone 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 Ship Vertical Zone Error Response
  Title: Ship Vertical Zone Error Response

  Ship Vertical Zone Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ShipVerticalZonesErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Ship 123 was not found"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship 123 was not found"
}

Nested Schema : Ship Vertical Zone Error Response

Type: object

Title: Ship Vertical Zone Error Response

Ship Vertical Zone Error Response returned when encountered error

Show Source

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

{
    "title":"Ship Vertical Zone Error Response",
    "description":"Ship Vertical Zone 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 Ship Vertical Zone Error Response
  Title: Ship Vertical Zone Error Response

  Ship Vertical Zone Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ShipVerticalZonesErrorResponse"
        }
    ],
    "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 : Ship Vertical Zone Error Response

Type: object

Title: Ship Vertical Zone Error Response

Ship Vertical Zone Error Response returned when encountered error

Show Source

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

{
    "title":"Ship Vertical Zone Error Response",
    "description":"Ship Vertical Zone 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 Ship Vertical Zone Error Response
  Title: Ship Vertical Zone Error Response

  Ship Vertical Zone Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ShipVerticalZonesErrorResponse"
        }
    ],
    "example":{
        "type":"https://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":"https://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 : Ship Vertical Zone Error Response

Type: object

Title: Ship Vertical Zone Error Response

Ship Vertical Zone Error Response returned when encountered error

Show Source

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

{
    "title":"Ship Vertical Zone Error Response",
    "description":"Ship Vertical Zone 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 Ship Vertical Zone Error Response
  Title: Ship Vertical Zone Error Response

  Ship Vertical Zone Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ShipVerticalZonesErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Unsupported Media Type",
        "detail":"Content type not supported"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Unsupported Media Type",
    "detail":"Content type not supported"
}

Nested Schema : Ship Vertical Zone Error Response

Type: object

Title: Ship Vertical Zone Error Response

Ship Vertical Zone Error Response returned when encountered error

Show Source

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

{
    "title":"Ship Vertical Zone Error Response",
    "description":"Ship Vertical Zone 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 Ship Vertical Zone Error Response
  Title: Ship Vertical Zone Error Response

  Ship Vertical Zone Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ShipVerticalZonesErrorResponse"
        }
    ],
    "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 : Ship Vertical Zone Error Response

Type: object

Title: Ship Vertical Zone Error Response

Ship Vertical Zone Error Response returned when encountered error

Show Source

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

{
    "title":"Ship Vertical Zone Error Response",
    "description":"Ship Vertical Zone 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 Ship Vertical Zone Error Response
  Title: Ship Vertical Zone Error Response

  Ship Vertical Zone Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ShipVerticalZonesErrorResponse"
        }
    ],
    "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 : Ship Vertical Zone Error Response

Type: object

Title: Ship Vertical Zone Error Response

Ship Vertical Zone Error Response returned when encountered error

Show Source

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

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

Back to Top