1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Configurations
  4. Lifeboats

Create a new Lifeboat record

post

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

This is to create a new Lifeboat record

Request

Supported Media Types
Path Parameters
Body ()
Lifeboat Object
Root Schema : Lifeboat Create
Type: object
Title: Lifeboat Create
The Lifeboat is executed successfully
Show Source
  • Minimum Length: 0
    Maximum Length: 6
    Which Side The Boat Is On. Linked to TYP_MSD.TYP_ART (this property only available if Advance Safety Drill is enabled in par)
    Example: Sside
  • Minimum Length: 0
    Maximum Length: 999
    Launch sequence (allow integer value only)
    Example: 2
  • Minimum Length: 0
    Maximum Length: 9999
    Pattern: ^[0-9]*$
    Maximum boat capacity (allow integer value only)
    Example: 20
  • Minimum Length: 1
    Maximum Length: 50
    Pattern: ^[a-zA-Z0-9 _,\?\/\.\-\\+\*\n~!@#$%&\{\}\[\]\(\)=<>\|^'":;`]*$
    Long name of boat
    Example: Lifeboat 02
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[a-zA-Z0-9 _,\?\/\.\-\\+\*\n~!@#$%&\{\}\[\]\(\)=<>\|^'":;`]*$
    Lifeboat short name
    Example: LB02
  • Minimum Length: 0
    Maximum Length: 4000
    Pattern: ^[a-zA-Z0-9 _,\?\/\.\-\\+\*\n~!@#$%&\{\}\[\]\(\)=<>\|^'":;`]*$
    Additional remarks for the boat
    Example: LB Remark
  • Minimum Length: 0
    Maximum Length: 6
    Type of boat. Linked to TYP_BRT.TYP_ART
    Example: LB
  • Minimum Length: 0
    Maximum Length: 9999
    Pattern: ^[0-9]*$
    Maximum certified capacity (this property only available if Advance Safety Drill is disabled in par. Allow integer value only)
    Example: 2
  • Minimum Length: 0
    Maximum Length: 9999
    Pattern: ^[0-9]*$
    Required minimum number of crew with CPSC certificates in boat (allow integer value only)
    Example: 2
  • Minimum Length: 0
    Maximum Length: 999
    Muster Station Raft Crane (allow integer value only)
    Example: 1
  • Minimum Length: 0
    Maximum Length: 9999
    Pattern: ^[0-9]*$
    Number of crew assigned to boat (allow integer value only)
    Example: 2
Back to Top

Response

Supported Media Types

201 Response

Created
Body ()
Root Schema : Lifeboat Configuration List
Type: object
Title: Lifeboat Configuration List
The Lifeboat Configuration is executed successfully
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":[
        {
            "errorPath":"lifeBoatName",
            "message":"must not be null"
        },
        {
            "errorPath":"lifeBoatDescription",
            "message":"must not be null"
        }
    ]
}
Nested Schema : Lifeboat Configurations Error Response
Type: object
Title: Lifeboat Configurations Error Response
Lifeboat Configurations 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 : Lifeboat Configurations Error Response
Type: object
Title: Lifeboat Configurations Error Response
Lifeboat Configurations 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 : Lifeboat Configurations Error Response
Type: object
Title: Lifeboat Configurations Error Response
Lifeboat Configurations 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 : Lifeboat Configurations Error Response
Type: object
Title: Lifeboat Configurations Error Response
Lifeboat Configurations 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 : Lifeboat Configurations Error Response
Type: object
Title: Lifeboat Configurations Error Response
Lifeboat Configurations 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":"Max certified capacity cannot be saved because parameter advanced safety drill is disabled."
}
Nested Schema : Lifeboat Configurations Error Response
Type: object
Title: Lifeboat Configurations Error Response
Lifeboat Configurations Error Response returned when encountered error
Show Source

409 Response

Conflict
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
    "title":"Conflict",
    "detail":"Lifeboat name already exists"
}
Nested Schema : Lifeboat Configurations Error Response
Type: object
Title: Lifeboat Configurations Error Response
Lifeboat Configurations Error Response returned when encountered error
Show Source

415 Response

Unsupported Media Type
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "detail":"Content type Not supported"
}
Nested Schema : Lifeboat Configurations Error Response
Type: object
Title: Lifeboat Configurations Error Response
Lifeboat Configurations 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 : Lifeboat Configurations Error Response
Type: object
Title: Lifeboat Configurations Error Response
Lifeboat Configurations 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 : Lifeboat Configurations Error Response
Type: object
Title: Lifeboat Configurations Error Response
Lifeboat Configurations 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 : Lifeboat Configurations Error Response
Type: object
Title: Lifeboat Configurations Error Response
Lifeboat Configurations Error Response returned when encountered error
Show Source
Back to Top