1. Oracle Hospitality Cruise Property Management REST API 23.1.4
  2. Tasks
  3. Mustering

Retrieve the active ship vertical zone count

get

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

This is to retrieve the ship vertical zone count

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Mustering all muster station registration list
Type: object
Title: Mustering all muster station registration list
The mustering all registration muster station list is retrieved successfully
Show Source
Nested Schema : shipVerticalZones
Type: array
Show Source
Nested Schema : total
Type: object
Total count of people onboard
Show Source
  • Total count of people
    Example: 60
  • Total count of people who have already reported to a muster station/lifeboat
    Example: 30
  • Total count of people who have yet to report to any muster stations/lifeboats
    Example: 30
Nested Schema : allShipVerticalZoneList
Type: object
Total count of people for each of the designated ship vertical zone included unassigned ship vertical zone
Show Source
  • Ship vertical zone capacity. Null represents unassigned ship vertical zone or no capacity is set for the stateroom.
    Example: 200
  • Ship vertical zone code. Null represents unassigned ship vertical zone for the stateroom.
    Example: ZA
  • Ship vertical zone name. Null represents unassigned ship vertical zone for the stateroom.
    Example: Zone A
  • total count of people from this ship's vertical zone who have already reported to a muster station/lifeboat
    Example: 120
  • total count of people from this ship's vertical zone who have not reported to a muster station/lifeboat
    Example: 80

400 Response

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

401 Response

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

403 Response

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

404 Response

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

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 : Users Error Response
Type: object
Title: Users Error Response
Users error response returned when encountered error
Show Source

406 Response

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

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 : Users Error Response
Type: object
Title: Users Error Response
Users 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":"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

500 Response

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

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 : Users Error Response
Type: object
Title: Users Error Response
Users error response returned when encountered error
Show Source

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
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
Back to Top