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

Retrieve attendances list

get

/spms/v2/ships/{shipId}/safety/{safetyMode}/registrations

This is to retrieve attendances list

Request

Supported Media Types
Path Parameters
Query Parameters
  • Profile actual registered lifeboat's code
  • Profile actual registered lifeboat type's code
    Values: * `LB` - LifeBoat * `LR` - LifeRaft * `T` - Tender
    Allowed Values: [ "LB", "LR", "T" ]
  • Profile actual registered muster station's code
  • Profile contactless serial id.
  • Profile designated lifeboat's code
  • Profile designated lifeboat type's code
    Values: * `LB` - LifeBoat * `LR` - LifeRaft * `T` - Tender
    Allowed Values: [ "LB", "LR", "T" ]
  • Profile designated muster station's code.
  • Indicate profile whether has any special needs. If profile's special need remak is not empty then it's considered as true. True: has special needs, False: No special need.
  • Indicate profile whether is an adult. True: Adult, False: Minor
  • Indicate profile registration status in current safety mode. True: Registered, False: Unregistered.
  • Minimum Value: 0
    Paging limit
  • Minimum Value: 0
    Paging offset
  • Profile onboard status, True: onboard, False: offboard
  • Minimum Value: 0
    order by profileType, profileId, title, salutation, firstName, lastName, middleName, otherFirstName, otherLastName, photo, dateOfBirth, isAdult, reservationStatus, onboardStatus, cruiseId, registrationId, isRegistered, lastRegistrationDateTime, expectedLifeBoatCode, expectedLifeBoatName, expectedMusterStationCode, expectedMusterStationName, actualLifeBoatTypeName, actualLifeBoatCode, actualLifeBoatName, actualMusterStationTypeName, actualMusterStationCode, actualMusterStationName, stateroomNumber, hasSpecialNeeds, totalSpecialNeeds, specialNeedRemarks, crewManningNumber, crewOperationalDepartmentCode, crewOperationalDepartmentDescription, boardCardNumber, externalBoardCardNumber, shipVerticalZoneCode, shipVerticalZoneName with format column1:asc/desc,column2:asc/desc,column3:asc/desc,column4:asc/desc,column5:asc/desc,column6:asc/desc,column7:asc/desc,column8:asc/desc,column9:asc/desc,column10:asc/desc,column11:asc/desc,column12:asc/desc,column13:asc/desc,column14:asc/desc,column15:asc/desc,column16:asc/desc,column17:asc/desc,column18:asc/desc,column19:asc/desc,column20:asc/desc,column21:asc/desc,column22:asc/desc,column23:asc/desc,column24:asc/desc,column25:asc/desc,column26:asc/desc,column27:asc/desc,column28:asc/desc,column29:asc/desc,column30:asc/desc,column31:asc/desc,column32:asc/desc,column33:asc/desc,column34:asc/desc,column35:asc/desc,column36:asc/desc,column37:asc/desc,column38:asc/desc,column39:asc/desc,column40:asc/desc,column41:asc/desc
  • Search for the profile id.
  • Search for the profile type.
    Values: * `guest` - Guest * `crew` - Crew * `resident` - Resident * `visitor` - Visitor
    Allowed Values: [ "guest", "crew", "resident", "visitor" ]
  • Search for the reservation status and is supported multiple values.
    Values: * `CC` - Checked In * `RR` - Reservation * `RE` - Embark Today * `CL` - Leaving Today * `DD` - Disembarked
    Allowed Values: [ "CC", "RR", "RE", "CL", "DD" ]
  • Maximum Length: 100
    Pattern: ^[a-zA-Z0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Search for the input text which match the values either in (First Name, Last Name, Stateroom number, Crew manning number, Board card number, External board card number).
  • Ship vertical zone code. Response show all unassigned ship vertical zone if value is 'null' (case insensitive)
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Profile Response List
Type: object
Title: Profile Response List
The wrapper object when returning successful values in Oracle standard
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Profile List
Type: object
Title: Profile List
The safety profiles are retrieved successfully
Show Source
Nested Schema : contactlessSerialIds
Type: array
Show Source
  • Title: List of profile contactless serial id
    List of profile contactless serial id
    Example: 888888888888888, 999999999999999
Nested Schema : specialNeeds
Type: array
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : List of special need code and name
Type: object
Title: List of special need code and name
List of special need code and name
Show Source

204 Response

No Content

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 : 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