Jump to

• Request
• Response

Retrieve configured Crew Operational Divisions Records

get

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

This is to retrieve all Crew Operational Divisions records

Request

Supported Media Types

• application/json

Path Parameters

• shipId(required): number
  Ship Id

Query Parameters

• isEnabled: boolean
  Activation status of the Crew Operational Divisions record: * `true` - Crew Operational Divisions record is enabled * `false` - Crew Operational Divisions record is disabled

  Default Value:
• limit: integer(int32)
  Minimum Value: 1

  Paging limit

  Default Value: 50
• offset: integer(int32)
  Minimum Value: 0

  Paging offset

  Default Value: 0
• operationalDivisionsCode: string
  Operational Division Code

  Default Value:
• orderBy: string
  order by isEnabled, operationalDivisionsCode with format column1:asc/desc,column2:asc/desc

  Default Value: id

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Oracle Responses list

Type: object

Title: Oracle Responses list

The wrapper object when returning successful values in Oracle standard

Show Source

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

  Example: 3
• hasMore: boolean
  Flag which indicates whether or not there are more items.

  Example: false
• items: array items
• limit: number
  Paging limit

  Example: 5
• offset: number
  Paging offset

  Example: 10

{
    "title":"Oracle Responses list",
    "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":"3"
        },
        "hasMore":{
            "description":"Flag which indicates whether or not there are more items.",
            "type":"boolean",
            "example":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/crewOperationalDivisions"
            },
            "example":[
                {
                    "id":"1",
                    "operationalDivisionsCode":"HSKEEP",
                    "description":"Housekeeper",
                    "comments":"Housekeeping services",
                    "isEnabled":true
                },
                {
                    "id":"2",
                    "operationalDivisionsCode":"FBSVRS",
                    "description":"F&B Services",
                    "comments":"Food and Beverage services",
                    "isEnabled":true
                },
                {
                    "id":"3",
                    "operationalDivisionsCode":"FOGSSV",
                    "description":"FO Guest Services",
                    "comments":"Front Office Guest Services",
                    "isEnabled":true
                }
            ]
        },
        "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 crewOperationalDivisions
  crewOperationalDivisions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/crewOperationalDivisions"
    },
    "example":[
        {
            "id":"1",
            "operationalDivisionsCode":"HSKEEP",
            "description":"Housekeeper",
            "comments":"Housekeeping services",
            "isEnabled":true
        },
        {
            "id":"2",
            "operationalDivisionsCode":"FBSVRS",
            "description":"F&B Services",
            "comments":"Food and Beverage services",
            "isEnabled":true
        },
        {
            "id":"3",
            "operationalDivisionsCode":"FOGSSV",
            "description":"FO Guest Services",
            "comments":"Front Office Guest Services",
            "isEnabled":true
        }
    ]
}

Example:

[
    {
        "id":"1",
        "operationalDivisionsCode":"HSKEEP",
        "description":"Housekeeper",
        "comments":"Housekeeping services",
        "isEnabled":true
    },
    {
        "id":"2",
        "operationalDivisionsCode":"FBSVRS",
        "description":"F&B Services",
        "comments":"Food and Beverage services",
        "isEnabled":true
    },
    {
        "id":"3",
        "operationalDivisionsCode":"FOGSSV",
        "description":"FO Guest Services",
        "comments":"Front Office Guest Services",
        "isEnabled":true
    }
]

Nested Schema : crewOperationalDivisions

Type: object

crewOperationalDivisions

Show Source

• comments: string
  Comments

  Example: General Assembly comments
• description: string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Amenity Description

  Example: Description
• id: number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Crew Operational Division Id

  Example: 1001
• isEnabled: boolean
  Is Amenity Code Enabled?

  Example: true
• operationalDivisionsCode: string
  Minimum Value: 1

  Pattern: ^[a-zA-Z0-9 ]+?$

  Crew Operational Division Code

  Example: HSKEEP

{
    "description":"crewOperationalDivisions",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/crewOperationDivisionId"
        },
        "operationalDivisionsCode":{
            "$ref":"#/definitions/crewOperationDivisionCode"
        },
        "description":{
            "$ref":"#/definitions/description"
        },
        "comments":{
            "$ref":"#/definitions/comments"
        },
        "isEnabled":{
            "$ref":"#/definitions/isEnabled"
        }
    }
}

204 Response

No Content

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/crewOperationalDivisionErrorResponse"
        }
    ],
    "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/crewOperationalDivisionErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"You are forbidden to use this API"
    }
}

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

• 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/crewOperationalDivisionErrorResponse"
        }
    ],
    "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/crewOperationalDivisionErrorResponse"
        }
    ],
    "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/crewOperationalDivisionErrorResponse"
        }
    ],
    "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 : 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"
        }
    }
}

410 Response

Gone

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/crewOperationalDivisionErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
        "title":"Gone",
        "detail":"Requested Resource no longer exists"
    }
}

Example:

{
    "type":"https://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

• 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"
        }
    }
}

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/crewOperationalDivisionErrorResponse"
        }
    ],
    "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: 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/crewOperationalDivisionErrorResponse"
        }
    ],
    "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"
        }
    }
}

501 Response

Not Implemented

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/crewOperationalDivisionErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
        "title":"Internal Server Error",
        "detail":"Resource is not implemented in this version of the API"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
    "title":"Internal Server Error",
    "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

• 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/crewOperationalDivisionErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service not available"
    }
}

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

• 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