Jump to

• Request
• Response

Retrieve configured muster stations

get

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

This is to retrieve the configured muster stations

Request

Supported Media Types

• application/json

Path Parameters

• shipId: number
  ship Id

Query Parameters

• limit: integer(int32)
  Minimum Value: 0

  Paging limit
• musterStationCode: string
  Muster station code
• musterStationId: number
  Muster station Id
• musterStationName: string
  Muster station Name
• musterStationTypeCode: string
  Type of muster station
• offset: integer(int32)
  Minimum Value: 0

  Paging offset
• orderBy: string
  Minimum Value: 0

  order by with format column1:asc/desc,column2:asc/desc,column3:asc/desc. Default ordering with musterStationName:asc

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Muster Station GET Response

Type: object

Title: Muster Station 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":"Muster Station 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/MusterStationGetResponseDetails"
            }
        },
        "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 Muster Station Configuration List
  Title: Muster Station Configuration List

  List of Musterstations

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

Nested Schema : Muster Station Configuration List

Type: object

Title: Muster Station Configuration List

List of Musterstations

Show Source

• drillDate(optional): string
  Pattern: (\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})

  Last Drill date

  Example: 2022-10-10 01:00:00
• emergencyContactNumber(optional): string
  Emergency Telephone number

  Example: +0123456789
• instructionNumberCode(optional): string
  Instruction number code

  Example: IPMCC1
• instructionNumberName(optional): string
  Instruction number name

  Example: IPM Group A
• lifeBoatTypeCode(optional): string
  Allowed Values: [ "LB", "LR", "T" ]

  Lifeboat type code. (LB - Lifeboat, LR - Life Raft, T - Tender)

  Example: LB
• lifeBoatTypeName(optional): string
  Allowed Values: [ "Life Boat", "Life Raft", "Tender" ]

  Lifeboat type name

  Example: Lifeboat
• musterStationCapacity(optional): integer
  Capacity of the muster station

  Example: 20
• musterStationCode(optional): string
  Muster Station Code

  Example: ECR001
• musterStationId(optional): integer
  Muster Station Id

  Example: 123456789
• musterStationName(optional): string
  Muster station name

  Example: Engine Control Room 1
• musterStationTypeCode(optional): string
  Allowed Values: [ "MS", "ES", "ESMS" ]

  Muster station type code (MS - Muster Station, ES - Emergency Station, ESMS - Emergency And Muster Station)

  Example: MS
• musterStationTypeName(optional): string
  Allowed Values: [ "Muster Station", "Emergency Station", "Emergency And Muster Station" ]

  Muster station type name

  Example: Muster Station
• stairWellCode(optional): string
  Stairwell code

  Example: SW1
• stairWellName(optional): string
  Stairwell name

  Example: Stairwell 1

{
    "title":"Muster Station Configuration List",
    "description":"List of Musterstations",
    "type":"object",
    "properties":{
        "musterStationId":{
            "type":"integer",
            "description":"Muster Station Id",
            "example":123456789
        },
        "musterStationCode":{
            "type":"string",
            "description":"Muster Station Code",
            "example":"ECR001"
        },
        "musterStationName":{
            "type":"string",
            "description":"Muster station name",
            "example":"Engine Control Room 1"
        },
        "musterStationCapacity":{
            "type":"integer",
            "description":"Capacity of the muster station",
            "example":"20"
        },
        "drillDate":{
            "description":"Last Drill date",
            "type":"string",
            "pattern":"(\\d{4})-(\\d{2})-(\\d{2}) (\\d{2}):(\\d{2}):(\\d{2})",
            "example":"2022-10-10 01:00:00"
        },
        "lifeBoatTypeCode":{
            "type":"string",
            "enum":[
                "LB",
                "LR",
                "T"
            ],
            "description":"Lifeboat type code. (LB - Lifeboat, LR - Life Raft, T - Tender)",
            "example":"LB"
        },
        "lifeBoatTypeName":{
            "type":"string",
            "enum":[
                "Life Boat",
                "Life Raft",
                "Tender"
            ],
            "description":"Lifeboat type name",
            "example":"Lifeboat"
        },
        "stairWellCode":{
            "type":"string",
            "description":"Stairwell code",
            "example":"SW1"
        },
        "stairWellName":{
            "type":"string",
            "description":"Stairwell name",
            "example":"Stairwell 1"
        },
        "musterStationTypeCode":{
            "type":"string",
            "enum":[
                "MS",
                "ES",
                "ESMS"
            ],
            "description":"Muster station type code (MS - Muster Station, ES - Emergency Station, ESMS - Emergency And Muster Station)",
            "example":"MS"
        },
        "musterStationTypeName":{
            "type":"string",
            "enum":[
                "Muster Station",
                "Emergency Station",
                "Emergency And Muster Station"
            ],
            "description":"Muster station type name",
            "example":"Muster Station"
        },
        "emergencyContactNumber":{
            "type":"string",
            "description":"Emergency Telephone number",
            "example":"+0123456789"
        },
        "instructionNumberCode":{
            "type":"string",
            "description":"Instruction number code",
            "example":"IPMCC1"
        },
        "instructionNumberName":{
            "type":"string",
            "description":"Instruction number name",
            "example":"IPM Group A"
        }
    }
}

204 Response

No Content

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Muster Station Error Response
  Title: Muster Station Error Response

  Muster Station Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MusterStationErrorResponse"
        }
    ],
    "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 : Muster Station Error Response

Type: object

Title: Muster Station Error Response

Muster Station Error Response returned when encountered error

Show Source

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

{
    "title":"Muster Station Error Response",
    "description":"Muster Station 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 Muster Station Error Response
  Title: Muster Station Error Response

  Muster Station Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MusterStationErrorResponse"
        }
    ],
    "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 : Muster Station Error Response

Type: object

Title: Muster Station Error Response

Muster Station Error Response returned when encountered error

Show Source

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

{
    "title":"Muster Station Error Response",
    "description":"Muster Station 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 Muster Station Error Response
  Title: Muster Station Error Response

  Muster Station Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MusterStationErrorResponse"
        }
    ],
    "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 : Muster Station Error Response

Type: object

Title: Muster Station Error Response

Muster Station Error Response returned when encountered error

Show Source

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

{
    "title":"Muster Station Error Response",
    "description":"Muster Station 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 Muster Station Error Response
  Title: Muster Station Error Response

  Muster Station Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MusterStationErrorResponse"
        }
    ],
    "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 : Muster Station Error Response

Type: object

Title: Muster Station Error Response

Muster Station Error Response returned when encountered error

Show Source

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

{
    "title":"Muster Station Error Response",
    "description":"Muster Station 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 Muster Station Error Response
  Title: Muster Station Error Response

  Muster Station Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MusterStationErrorResponse"
        }
    ],
    "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 : Muster Station Error Response

Type: object

Title: Muster Station Error Response

Muster Station Error Response returned when encountered error

Show Source

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

{
    "title":"Muster Station Error Response",
    "description":"Muster Station 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 Muster Station Error Response
  Title: Muster Station Error Response

  Muster Station Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MusterStationErrorResponse"
        }
    ],
    "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 : Muster Station Error Response

Type: object

Title: Muster Station Error Response

Muster Station Error Response returned when encountered error

Show Source

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

{
    "title":"Muster Station Error Response",
    "description":"Muster Station 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 Muster Station Error Response
  Title: Muster Station Error Response

  Muster Station Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MusterStationErrorResponse"
        }
    ],
    "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 : Muster Station Error Response

Type: object

Title: Muster Station Error Response

Muster Station Error Response returned when encountered error

Show Source

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

{
    "title":"Muster Station Error Response",
    "description":"Muster Station 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 Muster Station Error Response
  Title: Muster Station Error Response

  Muster Station Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MusterStationErrorResponse"
        }
    ],
    "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 : Muster Station Error Response

Type: object

Title: Muster Station Error Response

Muster Station Error Response returned when encountered error

Show Source

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

{
    "title":"Muster Station Error Response",
    "description":"Muster Station 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 Muster Station Error Response
  Title: Muster Station Error Response

  Muster Station Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/MusterStationErrorResponse"
        }
    ],
    "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 : Muster Station Error Response

Type: object

Title: Muster Station Error Response

Muster Station Error Response returned when encountered error

Show Source

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

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

Back to Top