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
- application/json
Path Parameters
-
shipId(required): number
Ship Id
Query Parameters
-
limit: integer(int32)
Paging limit
-
offset: integer(int32)
Paging offset.
-
orderBy: string
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 * disembarkationDate * onboardStatus * reservationStatusCode * reservationStatusDescription * travelDocumentNumber * crewManningNumber * locationAt
POST Request Object
Root Schema : Reservation Search Request
Type:
objectTitle:
Reservation Search RequestReservation Search Optional Parameters
Show Source
-
accountId:
number
Minimum Value:
1Maximum Value:100000000000000000000000000000000000000Account ID * `Optional` (Do not provide if not in use) * For all Profile TypesExample:12345 -
boardCardNumber:
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]Board Card NumberExample:100500333 -
contactlessId:
string
Minimum Length:
1Maximum Length:16Pattern:^[a-zA-Z0-9 ]+?$RFID Contactless ID * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile TypesExample:AABB123 -
crewExternalId:
string
Minimum Length:
1Maximum Length:20Pattern:^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$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 TypesExample:aaa123 -
crewInternalId:
string
Minimum Length:
1Maximum Length:20Pattern:^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$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 TypesExample:aaa123 -
crewManningNumber:
string
Minimum Length:
1Maximum Length:20Pattern:^[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 TypesExample:A0002 -
crewOperationalDepartmentCode:
string
Minimum Length:
1Maximum Length:6Pattern:^[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 TypesExample:120 -
crewOperationalPositionCode:
string
Minimum Length:
1Maximum Length:6Pattern:^[a-zA-Z0-9 _,\?\/\.\-\\+\*\n~!@#$%&\{\}\[\]\(\)=<>\|^'":;`]*$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 TypesExample:106 -
disembarkationDate:
string(date)
Disembarkation DateExample:
2018-11-11 -
disembarkationHarborCode:
string
Minimum Length:
1Maximum Length:6Pattern:^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$Disembarkation Harbor CodeExample:D1 -
embarkationDate:
string(date)
Embarkation DateExample:
2018-11-11 -
embarkationHarborCode:
string
Minimum Length:
1Maximum Length:6Pattern:^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$Embarkation Harbor CodeExample:E1 -
firstName:
string
Minimum Length:
1Maximum Length:40The first name of the guestExample:Kobe -
lastName:
string
Minimum Length:
1Maximum Length:40The last name of the guestExample:James -
locationAt:
string
Minimum Length:
1Maximum Length:6Pattern:^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$Reservation Internal Gate Location * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile TypesExample:ABC23 -
middleName:
string
Minimum Length:
1Maximum Length:20The middle name of the guestExample:Bean -
musterStationCode:
string
Minimum Length:
1Maximum Length:6Pattern:^[a-zA-Z0-9 ]*$Musterstation CodeExample:M1 -
nationalityCode:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Nationality code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile TypesExample:US -
onboardStatus:
boolean
onboardStatusExample:
false -
passportNumber:
string
Minimum Length:
1Maximum Length:20Pattern:^[a-zA-Z0-9 ]+?$Passport NumberExample:A145611 -
profileType:
array profileTypeList
Profile type list. Support multiple values (Example: ['P', 'R']) * `Optional` (Do not provide if not in use)
-
reservationBookingNumber:
string
Minimum Length:
1Maximum Length:100Pattern:^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$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 TypesExample:ABC001 -
reservationStatus:
array 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
-
searchValue:
string
Minimum Length:
1Maximum Length:100Pattern:^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$Value to search. Searches (First Name, Last Name, Stateroom number, Boardcard number, Set Sail Pass Number, Booking number, Passport number, Manning number, Contactless ID) * `Optional` (Do not provide if not in use) * For all Profile TypesExample:John -
setSailPass:
string
Minimum Length:
1Maximum Length:30Pattern:^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$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 TypesExample:ABC001 -
stateroomNumber:
string
Minimum Length:
1Maximum Length:20Pattern:^[a-zA-Z0-9- ]*$stateroomNumberExample:1001 -
travelDocumentNumber:
string
Minimum Length:
1Maximum Length:20Pattern:^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$Travel document number (Visa number) * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile TypesExample:AB11245
Nested Schema : profileTypeList
Type:
arrayProfile type list. Support multiple values (Example: ['P', 'R'])
* `Optional` (Do not provide if not in use)
Show Source
-
Array of:
string
Profile TypeExample:
Crew
Nested Schema : reservationStatusList
Type:
arrayReservation 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
-
Array of:
string
Minimum Length:
1Maximum Length:2Pattern:^(?:RR|RE|CC|CL|DD|RN|RX)$Reservation status codeExample:RR
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Reservation search response
Type:
objectTitle:
Reservation search responsereservation search response
Show Source
-
count:
integer
Example:
2 -
items:
array reservationObjectList
List of reservation objects
-
limit:
integer
Example:
10 -
link:
object linkReservations
link (Reservations)
-
offset:
integer
Example:
0
Nested Schema : reservationObjectList
Type:
arrayList of reservation objects
Show Source
-
Array of:
object reservationObject
Reservation object
Nested Schema : linkReservations
Type:
objectlink (Reservations)
Show Source
-
href:
string
Example:
http://[HOSTNAME]/spms/v2/ships/11100777/reservations?searchValue=john&offset=0&limit=2 -
method:
string
Example:
get -
operationId:
string
Example:
search -
rel:
string
Example:
self
Nested Schema : reservationObject
Type:
objectReservation object
Show Source
-
item:
object reservationRecord
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.
-
links:
array links
Nested Schema : reservationRecord
Type:
objectReservation 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
-
crew:
object crewDetails
Crew information based on the Profile id passed
-
guest:
object guestDetails
Guest information based on the Profile id passed
-
resident:
object residentDetails
Resident information based on the Profile id passed
-
visitor:
object visitorDetails
Visitor information based on the Profile id passed
Nested Schema : links
Type:
Show Source
array-
Array of:
object profileLinkObject
Profile Link object
Nested Schema : crewDetails
Type:
objectCrew information based on the Profile id passed
Show Source
-
accountId:
integer
Minimum Value:
1Example:12345 -
accountType:
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Pattern:^A|P|C|G|V|O$Example:System Account, Passenger, Crew, Group, Visitor -
actualDisembarkDate:
string(date-time)
Example:
null or 2015-09-09 -
actualEmbarkDate:
string(date-time)
Example:
2015-09-02 -
age:
integer(int32)
Minimum Value:
1Maximum Value:150Example:57 -
alternativeContactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
assemblyStationCode:
string
Minimum Length:
0Maximum Length:6Pattern:[a-z0-9]Example:12345 -
assemblyStationName:
string
Minimum Length:
1Maximum Length:50Pattern:[a-z0-9]Example:12345 -
boardCardNumber:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
cabinNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:11111 -
classification:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:[VIP] -
consentStatus:
integer
Example:
0 -
contactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
countryOfBirth:
string
Minimum Length:
1Maximum Length:3Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
countryOfResidence:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
crewManningNumber:
integer
Minimum Length:
0Maximum Length:38Example:123 -
dateOfBirth:
string(date-time)
Example:
1961-04-01 -
disembarkDate:
string(date-time)
Example:
2015-09-09 -
disembarkPort:
integer
Example:
123 -
documentExpiryDate:
string(date-time)
Example:
1961-04-01 -
documentIssuedCountry:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
documentIssuedDate:
string(date-time)
Example:
1961-04-01 -
emailAddress:
string
Minimum Length:
1Maximum Length:50Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$Example:EMAIL ADD -
embarkDate:
string(date-time)
Example:
2015-09-02 -
embarkPort:
integer
Example:
123 -
emergencyContactName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
emergencyContactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
firstName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
gender:
string
Minimum Length:
1Maximum Length:6Pattern:[A-Z]Example:M or F -
guestId:
integer
Minimum Value:
0Example:12345 -
lastName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
middleName:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Andy -
nationalIdNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
nationality:
string
Minimum Length:
1Maximum Length:6Pattern:[a-z0-9]Example:US -
onboardStatus:
integer
Example:
0 -
operationalDepartment:
string
Example:
Deck Officer -
operationalPosition:
string
Example:
1st Engineer -
passportNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
photo:
string
Example:
/Images/People/ -
reservationAccountReferenceId:
integer(int32)
Example:
12345 -
reservationAccountType:
string
Minimum Length:
1Maximum Length:1Allowed Values:[ "P", "R", "C", "V" ]Pattern:^P|R|C|V$Example:P -
reservationBookingNumber:
string
Minimum Length:
1Maximum Length:100Pattern:[a-z0-9]Example:0123456789 -
reservationCancelStatus:
boolean
Example:
false -
reservationId:
integer
Minimum Value:
0Example:12345 -
reservationStatus:
string
Reservation status descriptionExample:
Checked In -
salutation:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:MR -
title:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Mr -
unicodeName:
string
Minimum Length:
1Maximum Length:100Example:
Nested Schema : guestDetails
Type:
objectGuest information based on the Profile id passed
Show Source
-
accountCategory:
string
Minimum Length:
1Maximum Length:6Pattern:^SYS|GRP|CRW|PAX|VTO$Example:PAX -
accountId:
integer
Minimum Value:
1Example:12345 -
accountType:
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Pattern:^A|P|C|G|V|O$Example:System Account, Passenger, Crew, Group, Visitor -
actualDisembarkDate:
string(date-time)
Example:
null or 2015-09-09 -
actualEmbarkDate:
string(date-time)
Example:
2015-09-02 -
age:
integer(int32)
Minimum Value:
1Maximum Value:150Example:57 -
alternativeContactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
assemblyStationCode:
string
Minimum Length:
0Maximum Length:6Pattern:[a-z0-9]Example:12345 -
assemblyStationName:
string
Minimum Length:
1Maximum Length:50Pattern:[a-z0-9]Example:12345 -
boardCardNumber:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
cabinNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:11111 -
classification:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:[VIP] -
consentStatus:
integer
Example:
0 -
contactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
countryOfBirth:
string
Minimum Length:
1Maximum Length:3Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
countryOfResidence:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
dateOfBirth:
string(date-time)
Example:
1961-04-01 -
disembarkDate:
string(date-time)
Example:
2015-09-09 -
disembarkPort:
integer
Example:
123 -
documentExpiryDate:
string(date-time)
Example:
1961-04-01 -
documentIssuedCountry:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
documentIssuedDate:
string(date-time)
Example:
1961-04-01 -
emailAddress:
string
Minimum Length:
1Maximum Length:50Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-]+)(\\.([a-zA-Z]{2,5})){1,}$Example:EMAIL ADD -
embarkCruiseId:
integer(int32)
Example:
12345 -
embarkDate:
string(date-time)
Example:
2015-09-02 -
embarkPort:
integer
Example:
123 -
emergencyContactName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
emergencyContactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
firstName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
gender:
string
Minimum Length:
1Maximum Length:6Pattern:[A-Z]Example:M or F -
groupName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
groupReferenceId:
integer(int32)
Example:
12345 -
guestId:
integer
Minimum Value:
0Example:12345 -
lastName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
middleName:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Andy -
nationalIdNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
nationality:
string
Minimum Length:
1Maximum Length:6Pattern:[a-z0-9]Example:US -
onboardStatus:
integer
Example:
0 -
passportNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
photo:
string
Example:
/Images/People/ -
reservationAccountReferenceId:
integer(int32)
Example:
12345 -
reservationAccountType:
string
Minimum Length:
1Maximum Length:1Allowed Values:[ "P", "R", "C", "V" ]Pattern:^P|R|C|V$Example:P -
reservationBookingNumber:
string
Minimum Length:
1Maximum Length:100Pattern:[a-z0-9]Example:0123456789 -
reservationCancelStatus:
boolean
Example:
false -
reservationExternalId:
string
Minimum Length:
1Maximum Length:50Pattern:[a-z0-9]Example:12345 -
reservationId:
integer
Minimum Value:
0Example:12345 -
reservationStatus:
string
Reservation status descriptionExample:
Checked In -
routedAccountNumber:
integer(int32)
Example:
12345 -
salutation:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:MR -
setSailPass:
string
Minimum Length:
1Maximum Length:30Pattern:[a-z0-9]Example:12345 -
title:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Mr -
unicodeName:
string
Minimum Length:
1Maximum Length:100Example:
Nested Schema : residentDetails
Type:
objectResident information based on the Profile id passed
Show Source
-
accountCategory:
string
Minimum Length:
1Maximum Length:6Pattern:^SYS|GRP|CRW|PAX|VTO$Example:PAX -
accountId:
integer
Minimum Value:
1Example:12345 -
accountType:
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Pattern:^A|P|C|G|V|O$Example:System Account, Passenger, Crew, Group, Visitor -
actualDisembarkDate:
string(date-time)
Example:
null or 2015-09-09 -
actualEmbarkDate:
string(date-time)
Example:
2015-09-02 -
age:
integer(int32)
Minimum Value:
1Maximum Value:150Example:57 -
alternativeContactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
assemblyStationCode:
string
Minimum Length:
0Maximum Length:6Pattern:[a-z0-9]Example:12345 -
boardCardNumber:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
cabinNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:11111 -
consentStatus:
integer
Example:
0 -
contactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
countryOfBirth:
string
Minimum Length:
1Maximum Length:3Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
countryOfResidence:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
dateOfBirth:
string(date-time)
Example:
1961-04-01 -
disembarkDate:
string(date-time)
Example:
2015-09-09 -
disembarkPort:
integer
Example:
123 -
documentExpiryDate:
string(date-time)
Example:
1961-04-01 -
documentIssuedCountry:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
documentIssuedDate:
string(date-time)
Example:
1961-04-01 -
emailAddress:
string
Minimum Length:
1Maximum Length:50Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$Example:EMAIL ADD -
embarkCruiseId:
integer(int32)
Example:
12345 -
embarkDate:
string(date-time)
Example:
2015-09-02 -
embarkPort:
integer
Example:
123 -
emergencyContactName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
emergencyContactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
firstName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
gender:
string
Minimum Length:
1Maximum Length:6Pattern:[A-Z]Example:M or F -
groupName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
groupReferenceId:
integer(int32)
Example:
12345 -
guestId:
integer
Minimum Value:
0Example:12345 -
lastName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
middleName:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Andy -
nationalIdNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
nationality:
string
Minimum Length:
1Maximum Length:6Pattern:[a-z0-9]Example:US -
onboardStatus:
integer
Example:
0 -
passportNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
photo:
string
Example:
/Images/People/ -
reservationAccountReferenceId:
integer(int32)
Example:
12345 -
reservationAccountType:
string
Minimum Length:
1Maximum Length:1Allowed Values:[ "P", "R", "C", "V" ]Pattern:^P|R|C|V$Example:P -
reservationBookingNumber:
string
Minimum Length:
1Maximum Length:100Pattern:[a-z0-9]Example:0123456789 -
reservationCancelStatus:
boolean
Example:
false -
reservationExternalId:
string
Minimum Length:
1Maximum Length:50Pattern:[a-z0-9]Example:12345 -
reservationId:
integer
Minimum Value:
0Example:12345 -
reservationStatus:
string
Reservation status descriptionExample:
Checked In -
routedAccountNumber:
integer(int32)
Example:
12345 -
salutation:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:MR -
setSailPass:
string
Minimum Length:
1Maximum Length:30Pattern:[a-z0-9]Example:12345 -
title:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Mr -
unicodeName:
string
Minimum Length:
1Maximum Length:100Example:
Nested Schema : visitorDetails
Type:
objectVisitor information based on the Profile id passed
Show Source
-
accountId:
integer
Minimum Value:
1Example:12345 -
accountType:
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Pattern:^A|P|C|G|V|O$Example:System Account, Passenger, Crew, Group, Visitor -
actualDisembarkDate:
string(date-time)
Example:
null or 2015-09-09 -
actualEmbarkDate:
string(date-time)
Example:
2015-09-02 -
age:
integer(int32)
Minimum Value:
1Maximum Value:150Example:57 -
boardCardNumber:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
consentStatus:
integer
Example:
0 -
contactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
countryOfBirth:
string
Minimum Length:
1Maximum Length:3Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
countryOfResidence:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
dateOfBirth:
string(date-time)
Example:
1961-04-01 -
disembarkDate:
string(date-time)
Example:
2015-09-09 -
emailAddress:
string
Minimum Length:
1Maximum Length:50Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$Example:EMAIL ADD -
embarkDate:
string(date-time)
Example:
2015-09-02 -
embarkPort:
integer
Example:
123 -
emergencyContactName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
emergencyContactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
firstName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
gender:
string
Minimum Length:
1Maximum Length:6Pattern:[A-Z]Example:M or F -
groupName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
guestId:
integer
Minimum Value:
0Example:12345 -
lastName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
middleName:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Andy -
nationality:
string
Minimum Length:
1Maximum Length:6Pattern:[a-z0-9]Example:US -
onboardStatus:
integer
Example:
0 -
passportNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
photo:
string
Example:
/Images/People/ -
reservationAccountType:
string
Minimum Length:
1Maximum Length:1Allowed Values:[ "P", "R", "C", "V" ]Pattern:^P|R|C|V$Example:P -
reservationCancelStatus:
boolean
Example:
false -
reservationId:
integer
Minimum Value:
0Example:12345 -
reservationStatus:
string
Reservation status descriptionExample:
Checked In -
salutation:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:MR -
title:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Mr -
visitorPassType:
string
Minimum Length:
0Maximum Length:6Pattern:^[a-zA-Z0-9- ]*$Example:
Nested Schema : profileLinkObject
Type:
objectProfile Link object
Show Source
-
href:
string
Example:
http://[HOSTNAME]/spms/v2/ships/11100777/profiles/crews/1 -
method:
string
Example:
get -
operationId:
string
Example:
getCrewProfile -
rel:
string
Example:
crew
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":"123456789",
"temporaryPhoneNumber":"123456789",
"emailAddress":"sample@mail.com",
"emergencyContactName":"John",
"emergencyContactNumber":"123456789",
"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":"123456789",
"embarkCruiseId":"12345",
"embarkationDate":"2015-09-02",
"actualEmbarkationTime":"07:30:00",
"actualEmbarkationDate":"2015-09-02",
"disembarkationDate":"2015-09-09",
"actualDisembarkationTime":"20:23:00",
"actualDisembarkationDate":null,
"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,
"contactlessId":"abc456",
"locationAt":"ABC23",
"attendImmigrationInspection":"1",
"skipImmigrationInspection":false
}
},
{
"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":"123456789",
"temporaryPhoneNumber":"123456789",
"emailAddress":"sample@mail.com",
"emergencyContactName":"John",
"emergencyContactNumber":"123456789",
"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"
},
"cabinNumber":"12345",
"reservationAccountType":"C",
"onboardStatus":false,
"reservationCancelStatus":false,
"reservationBookingNumber":"123456789",
"embarkationDate":"2015-09-02",
"actualEmbarkationTime":"07:30:00",
"actualEmbarkationDate":"2015-09-02",
"disembarkationDate":"2015-09-09",
"actualDisembarkationTime":"20:23:00",
"actualDisembarkationDate":"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",
"contactlessId":"abc456",
"locationAt":"ABC23",
"attendImmigrationInspection":"1",
"skipImmigrationInspection":false
}
},
{
"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":"123456789",
"temporaryPhoneNumber":"123456789",
"emailAddress":"sample@mail.com",
"emergencyContactName":"John",
"emergencyContactNumber":"123456789",
"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":"R",
"routedAccountNumber":"12345",
"onboardStatus":false,
"reservationCancelStatus":false,
"reservationBookingNumber":"123456789",
"embarkCruiseId":"12345",
"embarkationDate":"2015-09-02",
"actualEmbarkationTime":"07:30:00",
"actualEmbarkationDate":"2015-09-02",
"disembarkationDate":"2015-09-09",
"actualDisembarkationTime":"20:23:00",
"actualDisembarkationDate":"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,
"contactlessId":"abc456",
"locationAt":"ABC23",
"attendImmigrationInspection":"1",
"skipImmigrationInspection":false
}
},
{
"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":"123456789",
"emailAddress":"sample@mail.com",
"emergencyContactName":"John",
"emergencyContactNumber":"123456789",
"gender":{
"code":"M",
"description":"Male"
},
"nationality":{
"code":"US",
"description":"United States"
},
"reservationStatus":{
"code":"CC",
"description":"Checked In"
},
"reservationAccountType":"V",
"onboardStatus":false,
"reservationCancelStatus":false,
"embarkationDate":"2015-09-02",
"actualEmbarkationTime":"07:30:00",
"actualEmbarkationDate":"2015-09-02",
"disembarkationDate":"2015-09-09",
"actualDisembarkationTime":"20:23:00",
"actualDisembarkationDate":null,
"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",
"contactlessId":"abc456",
"locationAt":"ABC23",
"attendImmigrationInspection":"1",
"skipImmigrationInspection":false
}
}
],
"limit":"10",
"offset":"0"
}204 Response
No content is available
401 Response
You are not authorized to use this API
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError Response returned when encountered error
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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail:
string
Example:
There are validation errors for the object...... -
title:
string
Example:
validation fails for row with key={123} -
type:
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
403 Response
You are forbidden to use this API
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError Response returned when encountered error
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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail:
string
Example:
There are validation errors for the object...... -
title:
string
Example:
validation fails for row with key={123} -
type:
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
404 Response
Record not found
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError Response returned when encountered error
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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail:
string
Example:
There are validation errors for the object...... -
title:
string
Example:
validation fails for row with key={123} -
type:
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
405 Response
This method is not available
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError Response returned when encountered error
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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail:
string
Example:
There are validation errors for the object...... -
title:
string
Example:
validation fails for row with key={123} -
type:
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError Response returned when encountered error
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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail:
string
Example:
There are validation errors for the object...... -
title:
string
Example:
validation fails for row with key={123} -
type:
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
500 Response
Error occured while processing this request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError Response returned when encountered error
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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail:
string
Example:
There are validation errors for the object...... -
title:
string
Example:
validation fails for row with key={123} -
type:
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
503 Response
Service not available
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError Response returned when encountered error
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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail:
string
Example:
There are validation errors for the object...... -
title:
string
Example:
validation fails for row with key={123} -
type:
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1