1. Oracle Hospitality Cruise Property Management REST API 23.2.2
  2. Tasks
  3. Reservations
  4. Cruise Reservation V2

Retrieve reservation and profile details based on criteria

post

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

This is to retrieve reservation and profile details based on criterias.

Request

Supported Media Types
Path Parameters
Query Parameters
  • Paging limit
  • Paging offset.
  • Default sorting by account ID asc. Order by with format column1:asc/desc,column2:asc/desc * embarkationHarborCode * disembarkationHarborCode * embarkationHarborDescription * disembarkationHarborDescription * crewInternalId * crewExternalId * crewOperationalDepartmentCode * crewOperationalDepartmentDescription * crewOperationalPositionCode * crewOperationalPositionDescription * musterStationCode * musterStationDescription * contactlessId * profileType * firstName * lastName * middleName * accountId * nationalityCode * nationalityDescription * stateroomNumber * boardCardNumber * setSailPass * reservationBookingNumber * passportNumber * embarkationDate * embarkationDateByStatus * disembarkationDate * disembarkationDateByStatus * onboardStatus * reservationStatusCode * reservationStatusDescription * travelDocumentNumber * crewManningNumber * hasInternalLocations * locationAt * hasSpecialNeeds * totalSpecialNeeds
Body ()
POST Request Object
Root Schema : Reservation Search Request
Type: object
Title: Reservation Search Request
Reservation Search Optional Parameters
Show Source
  • Minimum Value: 1
    Maximum Value: 100000000000000000000000000000000000000
    Account ID * `Optional` (Do not provide if not in use) * For all Profile Types
    Example: 12345
  • Minimum Length: 1
    Maximum Length: 20
    Pattern: ^[a-zA-Z0-9 ]+?$
    Boardcard number * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: A9800000000001
  • Minimum Length: 1
    Maximum Length: 16
    Pattern: ^[a-zA-Z0-9 ]+?$
    RFID Contactless ID * `Optional` (Do not provide if not in use) * `null` if searching `null` * Does not return Cancelled/No Show/Checked Out Ashore reservations * For all Profile Types
    Example: AABB123
  • Minimum Length: 1
    Maximum Length: 20
    Crew External ID * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `C` Profile Type * Ignored if given only other Profile Types
    Example: aaa123
  • Minimum Length: 1
    Maximum Length: 20
    Crew Internal ID * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `C` Profile Type * Ignored if given only other Profile Types
    Example: aaa123
  • Minimum Length: 1
    Maximum Length: 20
    Pattern: ^[a-zA-Z0-9 ]+?$
    Crew manning number * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `C` Profile Type * Ignored if given only other Profile Types
    Example: A0002
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Crew Operational Department Code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `C` Profile Type * Ignored if given only other Profile Types
    Example: 120
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Crew Operational Position Code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `C` Profile Type * Ignored if given only other Profile Types
    Example: 106
  • Expected disembarkation date * `Optional` (Do not provide if not in use) * For all Profile Types
    Example: 2021-01-30
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Disembarkation Harbor Code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: AGSJO
  • Expected embarkation date * `Optional` (Do not provide if not in use) * For all Profile Types
    Example: 2021-01-26
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Embarkation Harbor Code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: AGSJO
  • Minimum Length: 1
    Maximum Length: 40
    First name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: Doe
  • If profile is in any internal gate locations * `Optional` (Do not provide if not in use) * For all Profile Types
    Example: true
  • If profile have any special needs * `Optional` (Do not provide if not in use) * For all Profile Types
    Example: true
  • Minimum Length: 1
    Maximum Length: 40
    Last name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: Jaden
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Reservation Internal Gate Location * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: ABC23
  • Minimum Length: 1
    Maximum Length: 20
    Middle name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: Jay
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Muster Station Code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `P`, `R`, `C` Profile Types * Ignored if given only other Profile Types
    Example: A
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Nationality code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: US
  • Onboard status * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: true
  • Minimum Length: 1
    Maximum Length: 20
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Passport number * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: A123409982
  • profileTypeList
    Profile type list. Support multiple values (Example: ['P', 'R']) * `Optional` (Do not provide if not in use)
  • Minimum Length: 1
    Maximum Length: 100
    Reservation booking number * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `P`, `R`, `C` Profile Types * Ignored if given only other Profile Types
    Example: ABC001
  • reservationStatusList
    Reservation status list. Support multiple values (Example: ['RX', 'RR']) * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
  • Minimum Length: 1
    Maximum Length: 100
    Value to search. Searches (First Name, Last Name, Stateroom number, Boardcard number, Set Sail Pass Number, Booking number, Passport number, Manning number, Crew Internal ID, Crew External ID, Contactless ID) * `Optional` (Do not provide if not in use) * When searching Contactless ID, it does not return Cancelled/No Show/Checked Out Ashore reservations * For all Profile Types
    Example: John
  • Minimum Length: 1
    Maximum Length: 30
    Setsailpass number * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `P`, `R` Profile Types * Ignored if given only other Profile Types
    Example: ABC001
  • Minimum Length: 1
    Maximum Length: 20
    Stateroom number / Cabin number * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `P`, `R`, `C` Profile Types * Ignored if given only other Profile Types
    Example: B1001
  • Minimum Length: 1
    Maximum Length: 20
    Pattern: ^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$
    Travel document number (Visa number) * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: AB11245
Nested Schema : profileTypeList
Type: array
Profile type list. Support multiple values (Example: ['P', 'R']) * `Optional` (Do not provide if not in use)
Show Source
  • Minimum Length: 1
    Maximum Length: 1
    Pattern: ^[PRCV]$
    Profile type
    Example: P
Nested Schema : reservationStatusList
Type: array
Reservation status list. Support multiple values (Example: ['RX', 'RR']) * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
Show Source
  • Minimum Length: 1
    Maximum Length: 2
    Pattern: ^(?:RR|RE|CC|CL|DD|RN|RX)$
    Reservation status code
    Example: RR
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Reservation search response
Type: object
Title: Reservation search response
reservation search response
Show Source
Nested Schema : reservationObjectList
Type: array
List of reservation objects
Show Source
Nested Schema : linkReservations
Type: object
link (Reservations)
Show Source
Nested Schema : reservationObject
Type: object
Reservation object
Show Source
Nested Schema : reservationRecord
Type: object
Reservation Record Response * There are 4 Profile Types: Guest, Crew, Resident, Visitor * Note: Object returned is based on the reservation record's profile type, it doesn't return all 4 types.
Show Source
Nested Schema : crewDetails
Type: object
Crew information based on the Profile id passed
Show Source
Nested Schema : guestDetails
Type: object
Guest information based on the Profile id passed
Show Source
Nested Schema : residentDetails
Type: object
Resident information based on the Profile id passed
Show Source
Nested Schema : visitorDetails
Type: object
Visitor information based on the Profile id passed
Show Source
Nested Schema : birthNation
Type: object
Birth Nation
Show Source
  • Minimum Length: 1
    Maximum Length: 3
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : countryOfResidence
Type: object
Country of residence
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : crewOperationalDepartment
Type: object
Show Source
  • Crew Operational Department Code
    Example: 120
  • Minimum Length: 1
    Maximum Length: 1000
    Crew Operational Department Name
    Example: Deck
Nested Schema : crewOperationalPosition
Type: object
Show Source
  • Crew Operational Position Code
    Example: 106
  • Minimum Length: 1
    Maximum Length: 50
    Crew Operational Position Name
    Example: 3rd Officer
Nested Schema : discountTemplate
Type: object
Show Source
Nested Schema : disembarkationHarbor
Type: object
Show Source
Nested Schema : embarkationHarbor
Type: object
Show Source
Nested Schema : gender
Type: object
Show Source
Nested Schema : musterStation
Type: object
Muster Station
Show Source
Nested Schema : nationality
Type: object
Nationality
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : passportIssuedCountry
Type: object
Passport Issued Country
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : reservationStatus
Type: object
Reservation Status
Show Source
  • Allowed Values: [ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]
    Reservation Status Code
    Example: CC
  • Reservation status description
    Example: Expected
Nested Schema : safetyPosition
Type: object
Show Source
Nested Schema : rsSpecialNeeds
Type: array
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : List of special need code and description
Type: object
Title: List of special need code and description
List of special need code and description
Show Source
Nested Schema : birthNation
Type: object
Birth Nation
Show Source
  • Minimum Length: 1
    Maximum Length: 3
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : countryOfResidence
Type: object
Country of residence
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : discountTemplate
Type: object
Show Source
Nested Schema : disembarkationHarbor
Type: object
Show Source
Nested Schema : embarkationHarbor
Type: object
Show Source
Nested Schema : gender
Type: object
Show Source
Nested Schema : musterStation
Type: object
Muster Station
Show Source
Nested Schema : nationality
Type: object
Nationality
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : passportIssuedCountry
Type: object
Passport Issued Country
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : reservationStatus
Type: object
Reservation Status
Show Source
  • Allowed Values: [ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]
    Reservation Status Code
    Example: CC
  • Reservation status description
    Example: Expected
Nested Schema : birthNation
Type: object
Birth Nation
Show Source
  • Minimum Length: 1
    Maximum Length: 3
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : countryOfResidence
Type: object
Country of residence
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : discountTemplate
Type: object
Show Source
Nested Schema : disembarkationHarbor
Type: object
Show Source
Nested Schema : embarkationHarbor
Type: object
Show Source
Nested Schema : gender
Type: object
Show Source
Nested Schema : musterStation
Type: object
Muster Station
Show Source
Nested Schema : nationality
Type: object
Nationality
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : passportIssuedCountry
Type: object
Passport Issued Country
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : reservationStatus
Type: object
Reservation Status
Show Source
  • Allowed Values: [ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]
    Reservation Status Code
    Example: CC
  • Reservation status description
    Example: Expected
Nested Schema : birthNation
Type: object
Birth Nation
Show Source
  • Minimum Length: 1
    Maximum Length: 3
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : countryOfResidence
Type: object
Country of residence
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : disembarkationHarbor
Type: object
Show Source
Nested Schema : embarkationHarbor
Type: object
Show Source
Nested Schema : gender
Type: object
Show Source
Nested Schema : nationality
Type: object
Nationality
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    Country Code
    Example: US
  • Country Name
    Example: United States
Nested Schema : reservationStatus
Type: object
Reservation Status
Show Source
  • Allowed Values: [ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]
    Reservation Status Code
    Example: CC
  • Reservation status description
    Example: Expected
Nested Schema : profileLinkObject
Type: object
Profile Link object
Show Source
Example Response (application/json)
{
    "count":"24",
    "hasMore":true,
    "link":[
        {
            "rel":"self",
            "method":"post",
            "href":"http://[HOSTNAME]/spms/v2/ships/111222333/reservations?offset=0&limit=10",
            "operationId":"nextPage"
        }
    ],
    "items":[
        {
            "links":[
                {
                    "rel":"guest",
                    "href":"http://[HOSTNAME]/spms/v2/ships/111222333/profiles/guests/12345",
                    "method":"get",
                    "operationId":"getGuestProfileDetails"
                },
                {
                    "rel":"otherTravelDocument",
                    "href":"http://[HOSTNAME]/spms/v1/guest/12345/otherTravelDocuments",
                    "method":"get",
                    "operationId":"getGuestOtherTravelDocuments"
                }
            ],
            "item":{
                "profileId":"12345",
                "title":"Mr",
                "salutation":"MR",
                "firstName":"John",
                "middleName":"Andy",
                "lastName":"Smith",
                "otherFirstName":null,
                "otherLastName":null,
                "dateOfBirth":"1961-04-01",
                "age":"57",
                "accountCategory":"PAX",
                "accountType":"P",
                "nationalId":"123456789",
                "passportNumber":"A01234567",
                "passportIssuedDate":"1961-04-01",
                "passportExpiryDate":"1961-04-01",
                "passportIssuedCountry":{
                    "code":"US",
                    "description":"United States"
                },
                "passportIssuedPlace":"Paramount",
                "birthNation":{
                    "code":"US",
                    "description":"United States"
                },
                "countryOfResidence":{
                    "code":"US",
                    "description":"United States"
                },
                "phoneNumber":"+0123456789",
                "temporaryPhoneNumber":"+0123456789",
                "emailAddress":"email@example.com",
                "emergencyContactName":"John",
                "emergencyContactNumber":"+0123456789",
                "gender":{
                    "code":"M",
                    "description":"Male"
                },
                "nationality":{
                    "code":"US",
                    "description":"United States"
                },
                "discountTemplate":{
                    "code":"LV1",
                    "description":"Disc Template 1 - 10%"
                },
                "reservationAccountReferenceId":"12345",
                "reservationStatus":{
                    "code":"CC",
                    "description":"Checked In"
                },
                "stateroomNumber":"12345",
                "reservationAccountType":"P",
                "routedAccountNumber":"12345",
                "onboardStatus":false,
                "reservationCancelStatus":false,
                "reservationBookingNumber":"0123456789",
                "embarkCruiseId":"12345",
                "embarkationDate":"2015-09-02",
                "actualEmbarkationTime":"07:30:00",
                "actualEmbarkationDate":"2015-09-03",
                "embarkationDateByStatus":"2015-09-03",
                "disembarkationDate":"2015-09-09",
                "actualDisembarkationTime":null,
                "actualDisembarkationDate":null,
                "disembarkationDateByStatus":"2015-09-09",
                "boardCardNumber":"123456789",
                "reservationId":"12345",
                "accountId":"12345",
                "reservationExternalId":"12345",
                "embarkationHarbor":{
                    "code":"AGSJO",
                    "description":"ST JOHNS"
                },
                "disembarkationHarbor":{
                    "code":"AGSJO",
                    "description":"ST JOHNS"
                },
                "groupReferenceId":"12345",
                "photo":"/Images/People/",
                "classification":"CLASS I",
                "setSailPass":"12345",
                "musterStation":{
                    "code":"A",
                    "description":"Musterstation A"
                },
                "groupName":"Smith",
                "isNoticeAndConsent":false,
                "hasInternalLocations":true,
                "locationAt":"ABC23",
                "attendImmigrationInspection":"1",
                "skipImmigrationInspection":false,
                "hasSpecialNeeds":true,
                "totalSpecialNeeds":"2",
                "specialNeeds":[
                    {
                        "code":"WH",
                        "description":"Wheelchair"
                    }
                ],
                "specialNeedRemarks":"Need special care"
            }
        },
        {
            "links":{
                "rel":"crew",
                "href":"http://[HOSTNAME]/spms/v2/ships/111222333/profiles/crews/12345",
                "method":"get",
                "operationId":"getCrewProfile"
            },
            "item":{
                "profileId":"12345",
                "title":"Mr",
                "salutation":"MR",
                "firstName":"John",
                "middleName":"Andy",
                "lastName":"Smith",
                "otherFirstName":null,
                "otherLastName":null,
                "dateOfBirth":"1961-04-01",
                "age":"57",
                "accountType":"C",
                "nationalId":"123456789",
                "passportNumber":"A01234567",
                "passportIssuedDate":"1961-04-01",
                "passportExpiryDate":"1961-04-01",
                "passportIssuedCountry":{
                    "code":"US",
                    "description":"United States"
                },
                "passportIssuedPlace":"Paramount",
                "birthNation":{
                    "code":"US",
                    "description":"United States"
                },
                "countryOfResidence":{
                    "code":"US",
                    "description":"United States"
                },
                "phoneNumber":"+0123456789",
                "temporaryPhoneNumber":"+0123456789",
                "emailAddress":"email@example.com",
                "emergencyContactName":"John",
                "emergencyContactNumber":"+0123456789",
                "gender":{
                    "code":"M",
                    "description":"Male"
                },
                "nationality":{
                    "code":"US",
                    "description":"United States"
                },
                "discountTemplate":{
                    "code":"LV1",
                    "description":"Disc Template 1 - 10%"
                },
                "reservationAccountReferenceId":"12345",
                "reservationStatus":{
                    "code":"CL",
                    "description":"Leaving Today"
                },
                "cabinNumber":"12345",
                "reservationAccountType":"C",
                "onboardStatus":false,
                "reservationCancelStatus":false,
                "reservationBookingNumber":"0123456789",
                "embarkationDate":"2015-09-02",
                "actualEmbarkationTime":"07:30:00",
                "actualEmbarkationDate":"2015-09-02",
                "embarkationDateByStatus":"2015-09-02",
                "disembarkationDate":"2015-09-09",
                "actualDisembarkationTime":null,
                "actualDisembarkationDate":null,
                "disembarkationDateByStatus":"2015-09-09",
                "boardCardNumber":"123456789",
                "reservationId":"12345",
                "accountId":"12345",
                "embarkationHarbor":{
                    "code":"AGSJO",
                    "description":"ST JOHNS"
                },
                "disembarkationHarbor":{
                    "code":"AGSJO",
                    "description":"ST JOHNS"
                },
                "photo":"/Images/People/",
                "musterStation":{
                    "code":"A",
                    "description":"Musterstation A"
                },
                "isNoticeAndConsent":false,
                "crewOperationalDepartment":{
                    "code":"120",
                    "description":"Deck"
                },
                "crewOperationalPosition":{
                    "code":"106",
                    "description":"3rd Officer"
                },
                "crewManningNumber":"0002",
                "safetyPosition":{
                    "code":"002",
                    "description":"Master"
                },
                "crewExternalId":"5566",
                "crewInternalId":"5588",
                "hasInternalLocations":true,
                "locationAt":"ABC23",
                "attendImmigrationInspection":"1",
                "skipImmigrationInspection":false,
                "hasSpecialNeeds":true,
                "totalSpecialNeeds":"2",
                "specialNeeds":[
                    {
                        "code":"WH",
                        "description":"Wheelchair"
                    }
                ],
                "specialNeedRemarks":"Need special care"
            }
        },
        {
            "links":{
                "rel":"resident",
                "href":"http://[HOSTNAME]/spms/v1/resident/12345",
                "method":"get",
                "operationId":"findByID"
            },
            "item":{
                "profileId":"12345",
                "title":"Mr",
                "salutation":"MR",
                "firstName":"John",
                "middleName":"Andy",
                "lastName":"Smith",
                "otherFirstName":null,
                "otherLastName":null,
                "dateOfBirth":"1961-04-01",
                "age":"57",
                "accountCategory":"PAX",
                "accountType":"P",
                "nationalId":"123456789",
                "passportNumber":"A01234567",
                "passportIssuedDate":"1961-04-01",
                "passportExpiryDate":"1961-04-01",
                "passportIssuedCountry":{
                    "code":"US",
                    "description":"United States"
                },
                "passportIssuedPlace":"Paramount",
                "birthNation":{
                    "code":"US",
                    "description":"United States"
                },
                "countryOfResidence":{
                    "code":"US",
                    "description":"United States"
                },
                "phoneNumber":"+0123456789",
                "temporaryPhoneNumber":"+0123456789",
                "emailAddress":"email@example.com",
                "emergencyContactName":"John",
                "emergencyContactNumber":"+0123456789",
                "gender":{
                    "code":"M",
                    "description":"Male"
                },
                "nationality":{
                    "code":"US",
                    "description":"United States"
                },
                "discountTemplate":{
                    "code":"LV1",
                    "description":"Disc Template 1 - 10%"
                },
                "reservationAccountReferenceId":"12345",
                "reservationStatus":{
                    "code":"RR",
                    "description":"Expected"
                },
                "stateroomNumber":"12345",
                "reservationAccountType":"R",
                "routedAccountNumber":"12345",
                "onboardStatus":false,
                "reservationCancelStatus":false,
                "reservationBookingNumber":"0123456789",
                "embarkCruiseId":"12345",
                "embarkationDate":"2015-09-02",
                "actualEmbarkationTime":null,
                "actualEmbarkationDate":null,
                "embarkationDateByStatus":"2015-09-02",
                "disembarkationDate":"2015-09-09",
                "actualDisembarkationTime":null,
                "actualDisembarkationDate":null,
                "disembarkationDateByStatus":"2015-09-09",
                "boardCardNumber":"123456789",
                "reservationId":"12345",
                "accountId":"12345",
                "reservationExternalId":"12345",
                "embarkationHarbor":{
                    "code":"AGSJO",
                    "description":"ST JOHNS"
                },
                "disembarkationHarbor":{
                    "code":"AGSJO",
                    "description":"ST JOHNS"
                },
                "groupReferenceId":"12345",
                "photo":"/Images/People/",
                "classification":"CLASS I",
                "setSailPass":"12345",
                "musterStation":{
                    "code":"A",
                    "description":"Musterstation A"
                },
                "groupName":"Smith",
                "isNoticeAndConsent":false,
                "hasInternalLocations":true,
                "locationAt":"ABC23",
                "attendImmigrationInspection":"1",
                "skipImmigrationInspection":false,
                "hasSpecialNeeds":true,
                "totalSpecialNeeds":"2",
                "specialNeeds":[
                    {
                        "code":"WH",
                        "description":"Wheelchair"
                    }
                ],
                "specialNeedRemarks":"Need special care"
            }
        },
        {
            "links":{
                "rel":"visitor",
                "href":"http://[HOSTNAME]/spms/v1/visitor/12345",
                "method":"get",
                "operationId":"findByID"
            },
            "item":{
                "profileId":"12345",
                "title":"Mr",
                "salutation":"MR",
                "firstName":"John",
                "middleName":"Andy",
                "lastName":"Smith",
                "dateOfBirth":"1961-04-01",
                "age":"57",
                "accountType":"V",
                "passportNumber":"A01234567",
                "birthNation":{
                    "code":"US",
                    "description":"United States"
                },
                "countryOfResidence":{
                    "code":"US",
                    "description":"United States"
                },
                "phoneNumber":"+0123456789",
                "emailAddress":"email@example.com",
                "emergencyContactName":"John",
                "emergencyContactNumber":"+0123456789",
                "gender":{
                    "code":"M",
                    "description":"Male"
                },
                "nationality":{
                    "code":"US",
                    "description":"United States"
                },
                "reservationStatus":{
                    "code":"DD",
                    "description":"Checked Out"
                },
                "reservationAccountType":"V",
                "onboardStatus":false,
                "reservationCancelStatus":false,
                "embarkationDate":"2015-09-02",
                "actualEmbarkationTime":"07:30:00",
                "actualEmbarkationDate":"2015-09-02",
                "embarkationDateByStatus":"2015-09-02",
                "disembarkationDate":"2015-09-09",
                "actualDisembarkationTime":"20:23:00",
                "actualDisembarkationDate":"2015-09-05",
                "disembarkationDateByStatus":"2015-09-05",
                "boardCardNumber":"123456789",
                "reservationId":"12345",
                "accountId":"12345",
                "embarkationHarbor":{
                    "code":"AGSJO",
                    "description":"ST JOHNS"
                },
                "disembarkationHarbor":{
                    "code":"AGSJO",
                    "description":"ST JOHNS"
                },
                "photo":"/Images/People/",
                "isNoticeAndConsent":false,
                "visitorPassType":"DEC10",
                "hasInternalLocations":true,
                "locationAt":"ABC23",
                "attendImmigrationInspection":"1",
                "skipImmigrationInspection":false,
                "hasSpecialNeeds":true,
                "totalSpecialNeeds":"2",
                "specialNeeds":[
                    {
                        "code":"WH",
                        "description":"Wheelchair"
                    }
                ],
                "specialNeedRemarks":"Need special care"
            }
        }
    ],
    "limit":"10",
    "offset":"0"
}

204 Response

No content is available

401 Response

You are not authorized to use this API
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

You are forbidden to use this API
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":"Access to this resource was forbidden"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

404 Response

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

405 Response

This method is not available
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

500 Response

Error occured while processing this request
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

503 Response

Service not available
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