1. Oracle Hospitality Cruise Property Management REST API 23.2.2
  2. Tasks
  3. Configurations
  4. Decks

Retrieve configured deck code records

get

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

This is to retrieve the configured deck codes

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Ok
Body ()
Root Schema : Deck Codes Success Oracle Responses list
Type: object
Title: Deck Codes Success Oracle Responses list
The wrapper object when returning successful values in Oracle standard
Show Source
Nested Schema : items
Type: array
Show Source
Example:
[
    {
        "Id":"12345678",
        "code":"OCEANC",
        "description":"Ocean Cay - Deck 16 - central area - portside",
        "comment":"Ocean Cay",
        "isActive":true
    },
    {
        "Id":"12345679",
        "code":"SUNDEC",
        "description":"Sun Deck",
        "comment":"Sun Deck top of the Ship",
        "isActive":true
    }
]
Nested Schema : configurationsDecks
Type: object
configurationsDecks
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^((?=[ A-Za-zÀ-ÖØ-öø-࿰-9~!@#$%`'^&*{}"\[\]\(\)_+-?|,./\\:;])(?![<>]).)*$
    Deck Code
    Example: Sun Dec
  • Maximum Length: 4000
    Pattern: ^((?=[ A-Za-zÀ-ÖØ-öø-࿰-9~!@#$%`'^&*{}"\[\]\(\)_+-?|,./\\:;])(?![<>]).)*$
    Deck comment * `null` if empty
    Example: Deck Code comment 1
  • Minimum Length: 1
    Maximum Length: 1000
    Pattern: ^((?=[ A-Za-zÀ-ÖØ-öø-࿰-9~!@#$%`'^&*{}"\[\]\(\)_+-?|,./\\:;])(?![<>]).)*$
    Deck Description
    Example: Sun Bath
  • Minimum Value: 1
    Pattern: ^[0-9]*$
    Deck Id
    Example: 11111111
  • This is to indicate switch to Active / InActive deck code (default value: true) * `true` - Active deck code * `false` - InActive deck code
    Example: true

204 Response

No Content

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter 'shipId' has incorrect format"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
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

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"You are forbidden to use this API"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

404 Response

Not found
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship Id could not be found"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

405 Response

Method Not Allowed
Body ()
Root Schema : schema
Match All
Show Source
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

406 Response

Not acceptable
Body ()
Root Schema : schema
Match All
Show Source
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

410 Response

Gone
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
    "title":"Gone",
    "detail":"Requested Resource no longer exists"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

415 Response

Unsupported Media Type
Body ()
Root Schema : schema
Match All
Show Source
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
Body ()
Root Schema : schema
Match All
Show Source
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

501 Response

Not Implemented
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
    "title":"Not implemented",
    "detail":"Resource is not implemented in this version of the API"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service not available"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source
Back to Top