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

Update the safety settings

put

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

This is to update the safety settings

Request

Supported Media Types
Path Parameters
Body ()
Required to update mustering safety settings
Root Schema : Update Mustering Safety Settings
Type: object
Title: Update Mustering Safety Settings
Show Source
  • Minimum Value: 1
    Maximum Value: 3
    Parameter Value (default value: 1) * `1` - Allow anyone to register at the selected muster station * `2` - Required user to decide if the mismatch person designated muster station allow to register at the selected muster station * `3` - Disallow the mismatch person designated muster station register at the selected muster station
    Example: 2
  • Minimum Length: 0
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Parameter Value (no default value)
    Example: A
  • Parameter Value is a flag which indicates whether the statistic count for today session only or a full session(previous + today) * `true` - today only * `false` - a full session (previous + today) (default value)
    Example: true
  • Minimum Value: 0
    Maximum Value: 2
    Parameter Value (default value: 0) * `0` - Emergency Passenger Drill * `1` - Assembly * `2` - Abandon Ship
    Example: 1
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Mustering Safety Settings
Type: object
Title: Mustering Safety Settings
Mustering Safety Settings
Show Source
Nested Schema : assemblyHandlingMode
Type: object
Show Source
  • Parameter Name
    Example: Current General Assembly Handling Mode
  • Parameter Value (1-Allow anyone to register at the selected muster station, 2-Required user to decide if the mismatch person designated muster station allow to register at the selected muster station, 3-Disallow the mismatch person designated muster station register at the selected muster station)
    Example: 2
Nested Schema : defaultMusterStation
Type: object
Show Source
Nested Schema : drillForTodayOnly
Type: object
Show Source
  • Parameter Name
    Example: Muster Drill For Today Only
  • Parameter Value is a flag which indicates whether the statistic count for today session only or a full session(previous + today) * `true` - today only * `false` - a full session (previous + today) (default value)
    Example: true
Nested Schema : safetyMode
Type: object
Show Source

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":"The parameter shipId has incorrect format"
}
Nested Schema : Mustering Safety Settings Error Response
Type: object
Title: Mustering Safety Settings Error Response
Mustering Safety Settings 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 : Mustering Safety Settings Error Response
Type: object
Title: Mustering Safety Settings Error Response
Mustering Safety Settings 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 : Mustering Safety Settings Error Response
Type: object
Title: Mustering Safety Settings Error Response
Mustering Safety Settings 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":"Ship 123 was not found"
}
Nested Schema : Mustering Safety Settings Error Response
Type: object
Title: Mustering Safety Settings Error Response
Mustering Safety Settings 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 : Mustering Safety Settings Error Response
Type: object
Title: Mustering Safety Settings Error Response
Mustering Safety Settings 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 : Mustering Safety Settings Error Response
Type: object
Title: Mustering Safety Settings Error Response
Mustering Safety Settings 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 : Mustering Safety Settings Error Response
Type: object
Title: Mustering Safety Settings Error Response
Mustering Safety Settings 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 : Mustering Safety Settings Error Response
Type: object
Title: Mustering Safety Settings Error Response
Mustering Safety Settings 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 : Mustering Safety Settings Error Response
Type: object
Title: Mustering Safety Settings Error Response
Mustering Safety Settings Error Response returned when encountered error
Show Source
Back to Top