Jump to

• Request
• Response

Retrieve all the active lifeboats count per safety mode

get

/spms/v2/ships/{shipId}/safety/{safetyMode}/analytics/lifeBoats/count

This is to retrieve all the active lifeboats count per safety mode

Request

Supported Media Types

• application/json

Path Parameters

• safetyMode(required): string
  Values: * `ASHSHP` - Abandon Ship

  Allowed Values: [ "ASHSHP" ]
• shipId(required): number
  ship Id

Query Parameters

• lifeBoatTypeCode: string
  Values: * `LB` - LifeBoat * `LR` - LifeRaft * `T` - Tender * `null` - Receive a response that shows a count of profiles that does not have designated lifeboat and designated/registered lifeboat without boat type defined

  Allowed Values: [ "LB", "LR", "T", "null" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Mustering all registration list

Type: object

Title: Mustering all registration list

The mustering all registration lifeboats list is retrieved successfully

Show Source

• lifeBoats: array lifeBoats
• pending: object allPendingLifeboatCategoryCountResponse
  Total count of people not yet register in lifeboat
• registered: object allRegisteredLifeboatCategoryCountResponse
  Total count of people registered in all lifeboats
• total: object allTotalLifeboatCategoryCountResponse
  Grand total (Sum of registered person count and pending registration person count)

{
    "title":"Mustering all registration list",
    "description":"The mustering all registration lifeboats list is retrieved successfully",
    "type":"object",
    "properties":{
        "registered":{
            "$ref":"#/definitions/allRegisteredLifeboatCategoryCountResponse"
        },
        "pending":{
            "$ref":"#/definitions/allPendingLifeboatCategoryCountResponse"
        },
        "total":{
            "$ref":"#/definitions/allTotalLifeboatCategoryCountResponse"
        },
        "lifeBoats":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/allLifeboatListResponse"
            }
        }
    }
}

Nested Schema : lifeBoats

Type: array

Show Source

• Array of: object allLifeboatListResponse
  Total count of people registered and unregistered for each lifeboat

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

Nested Schema : allPendingLifeboatCategoryCountResponse

Type: object

Total count of people not yet register in lifeboat

Show Source

• adult: integer
  Total adult count

  Example: 170
• all: integer
  Sum of guest, resident, visitor and crew.

  Example: 200
• crew: integer
  Total crew count

  Example: 30
• guest: integer
  Total guest count

  Example: 150
• minor: integer
  Total minor count

  Example: 30
• resident: integer
  Total resident count

  Example: 15
• specialNeeds: integer
  Total special needs count

  Example: 5
• unassigned: integer
  Total count of people with no lifeboat assigned

  Example: 10
• visitor: integer
  Total visitor count

  Example: 5

{
    "type":"object",
    "description":"Total count of people not yet register in lifeboat",
    "properties":{
        "all":{
            "type":"integer",
            "description":"Sum of guest, resident, visitor and crew.",
            "example":"200"
        },
        "guest":{
            "type":"integer",
            "description":"Total guest count",
            "example":"150"
        },
        "resident":{
            "type":"integer",
            "description":"Total resident count",
            "example":"15"
        },
        "visitor":{
            "type":"integer",
            "description":"Total visitor count",
            "example":"5"
        },
        "crew":{
            "type":"integer",
            "description":"Total crew count",
            "example":"30"
        },
        "adult":{
            "type":"integer",
            "description":"Total adult count",
            "example":"170"
        },
        "minor":{
            "type":"integer",
            "description":"Total minor count",
            "example":"30"
        },
        "specialNeeds":{
            "type":"integer",
            "description":"Total special needs count",
            "example":"5"
        },
        "unassigned":{
            "type":"integer",
            "description":"Total count of people with no lifeboat assigned",
            "example":"10"
        }
    }
}

Nested Schema : allRegisteredLifeboatCategoryCountResponse

Type: object

Total count of people registered in all lifeboats

Show Source

• adult: integer
  Total adult count

  Example: 170
• all: integer
  Sum of guest, resident, visitor and crew.

  Example: 200
• crew: integer
  Total crew count

  Example: 30
• guest: integer
  Total guest count

  Example: 150
• minor: integer
  Total minor count

  Example: 30
• resident: integer
  Total resident count

  Example: 15
• specialNeeds: integer
  Total special needs count

  Example: 5
• visitor: integer
  Total visitor count

  Example: 5

{
    "type":"object",
    "description":"Total count of people registered in all lifeboats",
    "properties":{
        "all":{
            "type":"integer",
            "description":"Sum of guest, resident, visitor and crew.",
            "example":"200"
        },
        "guest":{
            "type":"integer",
            "description":"Total guest count",
            "example":"150"
        },
        "resident":{
            "type":"integer",
            "description":"Total resident count",
            "example":"15"
        },
        "visitor":{
            "type":"integer",
            "description":"Total visitor count",
            "example":"5"
        },
        "crew":{
            "type":"integer",
            "description":"Total crew count",
            "example":"30"
        },
        "adult":{
            "type":"integer",
            "description":"Total adult count",
            "example":"170"
        },
        "minor":{
            "type":"integer",
            "description":"Total minor count",
            "example":"30"
        },
        "specialNeeds":{
            "type":"integer",
            "description":"Total special needs count",
            "example":"5"
        }
    }
}

Nested Schema : allTotalLifeboatCategoryCountResponse

Type: object

Grand total (Sum of registered person count and pending registration person count)

Show Source

• adult: integer
  Total adult count

  Example: 340
• all: integer
  Sum of guest, resident, visitor and crew.

  Example: 400
• crew: integer
  Total crew count

  Example: 60
• guest: integer
  Total guest count

  Example: 300
• minor: integer
  Total minor count

  Example: 60
• resident: integer
  Total resident count

  Example: 30
• specialNeeds: integer
  Total special needs count

  Example: 10
• visitor: integer
  Total visitor count

  Example: 10

{
    "type":"object",
    "description":"Grand total (Sum of registered person count and pending registration person count)",
    "properties":{
        "all":{
            "type":"integer",
            "description":"Sum of guest, resident, visitor and crew.",
            "example":"400"
        },
        "guest":{
            "type":"integer",
            "description":"Total guest count",
            "example":"300"
        },
        "resident":{
            "type":"integer",
            "description":"Total resident count",
            "example":"30"
        },
        "visitor":{
            "type":"integer",
            "description":"Total visitor count",
            "example":"10"
        },
        "crew":{
            "type":"integer",
            "description":"Total crew count",
            "example":"60"
        },
        "adult":{
            "type":"integer",
            "description":"Total adult count",
            "example":"340"
        },
        "minor":{
            "type":"integer",
            "description":"Total minor count",
            "example":"60"
        },
        "specialNeeds":{
            "type":"integer",
            "description":"Total special needs count",
            "example":"10"
        }
    }
}

Nested Schema : allLifeboatListResponse

Type: object

Total count of people registered and unregistered for each lifeboat

Show Source

• lifeBoatCode: string
  Lifeboat code. Null represents unassigned lifeboat.

  Example: LB02
• lifeBoatId: integer
  Unique lifeboat Identifier. Null represents unassigned lifeboat.

  Example: 123456789
• lifeBoatName: string
  Lifeboat name. Null represents unassigned lifeboat.

  Example: Lifeboat 02
• lifeBoatTypeCode: string
  Allowed Values: [ "LB", "LR", "T", "null" ]

  Values: * `LB` - LifeBoat * `LR` - LifeRaft * `T` - Tender * `null` - Unassigned lifeboat or no lifeboat type
• lifeBoatTypeName: string
  Allowed Values: [ "LifeBoat", "LifeRaft", "Tender", "null" ]

  Lifeboat type name. Null represents unassigned lifeboat or no lifeboat type.
• totalDesignated: integer
  Total count of people designated at this lifeboat

  Example: 300
• totalPending: integer
  Total count of people not yet register at this lifeboat

  Example: 200
• totalRegistered: integer
  Total count of people registered at this lifeboat

  Example: 200

{
    "type":"object",
    "description":"Total count of people registered and unregistered for each lifeboat",
    "properties":{
        "lifeBoatId":{
            "type":"integer",
            "description":"Unique lifeboat Identifier. Null represents unassigned lifeboat.",
            "example":"123456789"
        },
        "lifeBoatCode":{
            "type":"string",
            "description":"Lifeboat code. Null represents unassigned lifeboat.",
            "example":"LB02"
        },
        "lifeBoatName":{
            "type":"string",
            "description":"Lifeboat name. Null represents unassigned lifeboat.",
            "example":"Lifeboat 02"
        },
        "lifeBoatTypeCode":{
            "type":"string",
            "description":"Values:\n * `LB` - LifeBoat\n * `LR` - LifeRaft\n * `T` - Tender\n * `null` - Unassigned lifeboat or no lifeboat type\n",
            "enum":[
                "LB",
                "LR",
                "T",
                "null"
            ]
        },
        "lifeBoatTypeName":{
            "type":"string",
            "enum":[
                "LifeBoat",
                "LifeRaft",
                "Tender",
                "null"
            ],
            "description":"Lifeboat type name. Null represents unassigned lifeboat or no lifeboat type."
        },
        "totalRegistered":{
            "type":"integer",
            "description":"Total count of people registered at this lifeboat",
            "example":"200"
        },
        "totalPending":{
            "type":"integer",
            "description":"Total count of people not yet register at this lifeboat",
            "example":"200"
        },
        "totalDesignated":{
            "type":"integer",
            "description":"Total count of people designated at this lifeboat",
            "example":"300"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Users Error Response
  Title: Users Error Response

  Users error response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CommonErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Safety mode ABC is invalid."
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Safety mode ABC is invalid."
}

Nested Schema : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

  Users error response returned when encountered error

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

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

  Users error response returned when encountered error

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

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

  Users error response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CommonErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"This resource path does not exist"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"This resource path does not exist"
}

Nested Schema : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

  Users error response returned when encountered error

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

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

  Users error response returned when encountered error

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

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

  Users error response returned when encountered error

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

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
    "title":"Gone",
    "detail":"Requested Resource no longer exists"
}

Nested Schema : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

  Users error response returned when encountered error

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

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

  Users error response returned when encountered error

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

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

  Users error response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CommonErrorResponse"
        }
    ],
    "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"
    }
}

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 : Users Error Response

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

  Users error response returned when encountered error

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

Type: object

Title: Users Error Response

Users error response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

Back to Top