1. Oracle Hospitality Cruise Property Management REST API 23.3.0
  2. Tasks
  3. Reservations
  4. Crew Reservations

Retrieve a crew reservation record

get

/spms/v2/ships/{shipId}/reservations/crews

This is to retrieve the crew reservation details.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Crew Reservation GET Success Oracle Responses list
Type: object
Title: Crew Reservation GET Success Oracle Responses list
The wrapper object when returning successful values in Oracle standard
Show Source
Nested Schema : items
Type: array
Show Source
Example:
[
    {
        "reservationId":10001,
        "guestCategories":[
            {
                "code":"GCAT",
                "description":"Guest Category"
            }
        ],
        "bookingNumber":"12345678",
        "shoreGId":"12345678",
        "extResId":"12345678",
        "boardCardNumber":"12345678",
        "setSailPassNumber":"1234",
        "finNumber":"12345678",
        "expectedEmbarkationDate":"2024-01-01",
        "expectedEmbarkationHarbor":"NEW YORK CITY",
        "expectedDisembarkationDate":"2025-01-01",
        "expectedDisembarkationHarbor":"DUBAI",
        "actualEmbarkationDate":"2024-01-01",
        "actualEmbarkationHarbor":"DUBAI",
        "reEmbarkationDate":"2024-01-01",
        "embarkationHarborComment":"Going to the sea",
        "disembarkationHarborComment":"Going to the land",
        "reservationStatus":"CC",
        "cabinNumber":"12345",
        "berthNumber":"A",
        "musterStation":{
            "code":"M",
            "description":"Guest Deck 1"
        },
        "lifeBoat":{
            "code":"L1",
            "description":"Guest Boat A"
        },
        "denyBoardingFlag":true,
        "denyBoardingReason":"Passport Issue",
        "pinCode":1234,
        "longShoremanWork":true,
        "assign":"A",
        "onboardStatus":true,
        "discountTemplate":"ABCD",
        "paymentDetails":{
            "paymentMethodCode":"1234",
            "paymentRemarks":"Example Payment Remark"
        },
        "otherParameter":{
            "isManifestPrintout":true,
            "isSwitchToPassengerManifest":true,
            "isStayOvernightTour":true,
            "isNoticeAndConsent":true
        },
        "onboardEmail":"example@email.com",
        "profileInformation":{
            "profileId":10001,
            "lastName":"Carleo",
            "firstName":"Fabiana",
            "middleName":"Alberto",
            "otherLastName":"Francis",
            "otherFirstName":"Frost",
            "title":"Mr.",
            "salutation":"Mr.",
            "gender":{
                "code":"M",
                "description":"Male"
            },
            "dateOfBirth":"2018-11-11",
            "nationality":{
                "code":"MY",
                "description":"Malaysia"
            },
            "nationId":"123456",
            "birthPlace":"Dubai",
            "hairColor":"Black",
            "eyeColor":"Brown",
            "height":"1.80 cm",
            "weight":70,
            "isSmoker":true,
            "isIntoxication":true,
            "passportNumber":"A123456",
            "passportIssuedDate":"2018-11-11",
            "passportIssuedExpiryDate":"2026-11-11",
            "passportIssuedCountry":{
                "code":"MY",
                "description":"Malaysia"
            },
            "passportIssuedPlace":"Shah Alam",
            "maritalStatus":{
                "code":"S",
                "description":"Single"
            },
            "seamanBookNumber":"12345678",
            "seamanBookIssuedDate":"2024-11-11",
            "seamanBookExpiryDate":"2025-11-11",
            "seamanBookIssuedPlace":"KL",
            "seamanBookIssuedCountry":{
                "code":"MY",
                "description":"Malaysia"
            },
            "operationalDepartment":{
                "code":"S1001",
                "descriptione":"DECK"
            },
            "departmentPosition":{
                "code":"D1001",
                "description":"STAFF CAPTAIN"
            },
            "externalId":"12345678",
            "internalId":"12345678",
            "crewPostId":"12345678",
            "orderEmpNo":12345678
        }
    }
]
Nested Schema : crewReservationResponse
Type: object
Crew Reservation response
Show Source
Nested Schema : discountTemplate
Type: object
Discount Template
Show Source
Nested Schema : guestCategoryGET
Type: array
Show Source
Nested Schema : lifeBoat
Type: object
Life Boat
Show Source
Nested Schema : musterStation
Type: object
Muster Station
Show Source
  • Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Muster Station Code
    Example: M
  • Muster Station Code Description
    Example: Guest Deck 1
Nested Schema : otherParameter
Type: object
Other Parameter
Show Source
Nested Schema : paymentDetails
Type: object
Payment Details
Show Source
Nested Schema : profileInformationResponse
Type: object
Profile information response
Show Source
Nested Schema : reservationId
Type: object
Reservation Id
Show Source
Nested Schema : guestCategoryGETGroup
Type: object
Guest Category Items
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[a-zA-Z0-9 _,\?/\.\-\\+\* ~!@#$%&{}\[\]()=<>\|\^\'\":;@`]*$
    Guest Category Code
    Example: GCAT
  • Guest Category Code Description
    Example: Guest Category
Nested Schema : departmentPosition
Type: object
Department Position
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Department Position Code
    Example: D1001
  • Department Position Description
    Example: STAFF CAPTAIN
Nested Schema : gender
Type: object
Gender
Show Source
Nested Schema : maritalStatus
Type: object
Marital Status
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[a-zA-Z0-9 ]{1,6}$
    Marital Status Code
    Example: D
  • Marital Status Description
    Example: Single
Nested Schema : nationality
Type: object
Nationality
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Nationality Code
    Example: MY
  • Nationality Code Description
    Example: Malaysia
Nested Schema : operationalDepartment
Type: object
Operational Department
Show Source
Nested Schema : passportIssuedCountry
Type: object
Passport Issued Country
Show Source
Nested Schema : seamanBookIssuedCountry
Type: object
Passport Issued Country
Show Source

204 Response

No Content

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter 'shipId' has incorrect format"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"You are forbidden to use this API"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

404 Response

Not found
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship Id could not be found"
}
Nested Schema : Error Response
Type: object
Title: Error Response
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 : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

406 Response

Not acceptable
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://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 : Error Response
Type: object
Title: Error Response
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":"Invalid content",
    "detail":"Content type not supported"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://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 : Error Response
Type: object
Title: Error Response
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 : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service not available"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source
Back to Top