Jump to

• Request
• Response

Retrieve configured Operational Position code records

get

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

This is to retrieve the configured operational position code listing

Request

Supported Media Types

• application/json

Path Parameters

• shipId(required): number
  Ship Id

Query Parameters

• code: string
  Operational position code
• description: string
  Operational position code description
• isActive: boolean
  This is to indicate switch to active / In-active Operational position code * `true` - active Operational position code * `false` - Inactive Operational position code
• limit: integer(int32)
  Minimum Value: 1

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

  Paging offset
• operationalDivisions: string
  Operational position code division
• orderBy: string
  order by isActive, code, description, operationDivisions with format column1:asc/desc,column2:asc/desc column3:asc/desc column4:asc/desc

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Operational Position Code Success Oracle Responses list

Type: object

Title: Operational Position Code Success 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: true
• items: array items
• limit: number
  Paging limit

  Example: 5
• offset: number
  Paging offset

  Example: 10

{
    "title":"Operational Position Code Success 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":true
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/configurationOperationalPositionCode"
            }
        },
        "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 configurationOperationalPositionCode
  configurationOperationalPositionCode

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

Nested Schema : configurationOperationalPositionCode

Type: object

configurationOperationalPositionCode

Show Source

• allowanceType: object allowanceType
  allowance Type
• apisReferences: object apisReferences
  apis References
• code: string
  Minimum Length: 1

  Maximum Length: 6

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

  Operational Position Code

  Example: D11111
• comment: string
  Minimum Length: 1

  Maximum Length: 2000

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

  Operational Position Code comment * `null` if empty

  Example: Operational Position Code Comment
• commonAreaAccess: object commonAreaAccess
  common Area Access
• description: string
  Minimum Length: 1

  Maximum Length: 50

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

  Operational Position Code Description

  Example: Operational Position Code Desc
• Id: number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Operational Position Code Id

  Example: 12345678
• isActive: boolean
  This is to indicate switch to Active / InActive Operational Position Code (default value: true) * `true` - Active Operational Position Code * `false` - InActive Operational Position Code

  Example: true
• positionDetails: object positionDetails
  position Details
• subLocationClockInOut: string
  Maximum Length: 50

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

  sub Location ClockInOut

  Example: Operational Position Code 1

{
    "description":"configurationOperationalPositionCode",
    "type":"object",
    "properties":{
        "Id":{
            "$ref":"#/definitions/OperationalPositionCodeId"
        },
        "code":{
            "$ref":"#/definitions/OperationalPositionCode"
        },
        "description":{
            "$ref":"#/definitions/OperationalPositionCodeDescription"
        },
        "comment":{
            "$ref":"#/definitions/OperationalPositionCodeComment"
        },
        "positionDetails":{
            "$ref":"#/definitions/positionDetails"
        },
        "allowanceType":{
            "$ref":"#/definitions/allowanceType"
        },
        "apisReferences":{
            "$ref":"#/definitions/apisReferences"
        },
        "subLocationClockInOut":{
            "$ref":"#/definitions/subLocationClockInOut"
        },
        "commonAreaAccess":{
            "$ref":"#/definitions/commonAreaAccess"
        },
        "isActive":{
            "$ref":"#/definitions/OperationalPositionCodeIsActive"
        }
    }
}

Nested Schema : allowanceType

Type: object

allowance Type

Show Source

• amount: number
  Pattern: ^[0-9]*$

  amount

  Example: 12345678
• periodicals: string
  Maximum Length: 1

  periodicals (daily, weekly, bi-weekly or monthly)

  Example: M

{
    "description":"allowance Type",
    "type":"object",
    "properties":{
        "amount":{
            "$ref":"#/definitions/amount"
        },
        "periodicals":{
            "$ref":"#/definitions/periodicals"
        }
    }
}

Nested Schema : apisReferences

Type: object

apis References

Show Source

• crewDutyCaricom: string
  Maximum Length: 50

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  crew Duty Caricom

  Example: S
• crewDutyOtherApis: string
  Maximum Length: 50

  crew Duty Other Apis

  Example: Single

{
    "description":"apis References",
    "type":"object",
    "properties":{
        "crewDutyCaricom":{
            "$ref":"#/definitions/crewDutyCaricom"
        },
        "crewDutyOtherApis":{
            "$ref":"#/definitions/crewDutyOtherApis"
        }
    }
}

Nested Schema : commonAreaAccess

Type: object

common Area Access

Show Source

• code: string
  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  common Area Access Code

  Example: S
• description: string
  common Area Access Description

  Example: Single

{
    "description":"common Area Access",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/commonAreaAccessCode"
        },
        "description":{
            "$ref":"#/definitions/commonAreaAccessDesc"
        }
    }
}

Nested Schema : positionDetails

Type: object

position Details

Show Source

• discTemplate: object discTemplate
  Disc Template
• externalID: string
  Minimum Length: 1

  Maximum Length: 15

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

  external ID

  Example: DS12323H
• headCount: number
  Pattern: ^[0-9]*$

  headCount

  Example: 12345678
• operationDivisions: object operationDivisions
  Operation Divisions
• positionCodeCMS: string
  Minimum Length: 1

  Maximum Length: 50

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

  position Code CMS * `null` if empty

  Example: Operational Position Code CMS
• positionRank: object positionRank
  Position Rank
• privileges: string
  Minimum Length: 1

  Maximum Length: 50

  privileges

  Example: English
• standardCabin: string
  Minimum Length: 1

  Maximum Length: 20

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

  standard Cabin

  Example: standard Cabin
• validDateFrom: string(date)
  Valid Date From

  Example: 01-01-23
• validDateTo: string(ISO 8601)
  valid Date To

  Example: 2009-10-31

{
    "description":"position Details",
    "type":"object",
    "properties":{
        "positionCodeCMS":{
            "$ref":"#/definitions/positionCodeCMS"
        },
        "externalID":{
            "$ref":"#/definitions/externalID"
        },
        "standardCabin":{
            "$ref":"#/definitions/standardCabin"
        },
        "positionRank":{
            "$ref":"#/definitions/positionRank"
        },
        "operationDivisions":{
            "$ref":"#/definitions/operationDivisions"
        },
        "headCount":{
            "$ref":"#/definitions/headCount"
        },
        "privileges":{
            "$ref":"#/definitions/privileges"
        },
        "discTemplate":{
            "$ref":"#/definitions/discTemplate"
        },
        "validDateFrom":{
            "$ref":"#/definitions/validDateFrom"
        },
        "validDateTo":{
            "$ref":"#/definitions/validDateTo"
        }
    }
}

Nested Schema : discTemplate

Type: object

Disc Template

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Disc Template Code

  Example: S12345
• description: string
  Disc Template Description

  Example: Single

{
    "description":"Disc Template",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/discTemplateCode"
        },
        "description":{
            "$ref":"#/definitions/discTemplateDesc"
        }
    }
}

Nested Schema : operationDivisions

Type: object

Operation Divisions

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Operation Divisions Code

  Example: S12345
• description: string
  Operation Divisions Description

  Example: Single

{
    "description":"Operation Divisions",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/operationDivisionsCode"
        },
        "description":{
            "$ref":"#/definitions/operationDivisionsDesc"
        }
    }
}

Nested Schema : positionRank

Type: object

Position Rank

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Position Rank Code

  Example: S
• description: string
  Position Rank Description

  Example: Single

{
    "description":"Position Rank",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/positionRankCode"
        },
        "description":{
            "$ref":"#/definitions/positionRankDesc"
        }
    }
}

204 Response

No Content

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

Example:

{
    "type":"https://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/OperationalPositionCodeErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Ship Id was not found"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship Id was 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"
        }
    }
}

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/OperationalPositionCodeErrorResponse"
        }
    ],
    "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: 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/OperationalPositionCodeErrorResponse"
        }
    ],
    "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/OperationalPositionCodeErrorResponse"
        }
    ],
    "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/OperationalPositionCodeErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type not supported"
    }
}

Example:

{
    "type":"https://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/OperationalPositionCodeErrorResponse"
        }
    ],
    "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: 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/OperationalPositionCodeErrorResponse"
        }
    ],
    "example":{
        "type":"https://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"
    }
}

Example:

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

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

Example:

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