Retrieve reservation and profile details based on criteria
get
/spms/v1/reservations
This is to retrieve reservation and profile details based on criterias.
Request
Supported Media Types
- application/json
Query Parameters
-
accountId: number
Minimum Value:
0Maximum Value:1.0E38Search for the account id. -
boardCardNumber: string
Minimum Length:
0Maximum Length:20Pattern:^[a-zA-Z0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Search for the boardcard number. -
crewManningNumber: string
Minimum Length:
0Maximum Length:38Pattern:^[a-zA-Z0-9 ]+?$Search for the crew manning number. -
disembarkDate: string
Search for the reservation debarkation date.
-
embarkDate: string
Search for the reservation embarkation date.
-
firstName: string
Minimum Length:
0Maximum Length:40Pattern:^[a-zA-Z0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Search for the input text which match the values in first name. -
lastName: string
Minimum Length:
0Maximum Length:40Pattern:^[a-zA-Z0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Search for the input text which match the values in last name -
limit: integer(int32)
Paging limit
-
middleName: string
Minimum Length:
0Maximum Length:40Pattern:^[a-zA-Z0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Search for the input text which match the values in middle name. -
nationality: string
Minimum Length:
0Maximum Length:6Search for the nationality code. -
offset: integer(int32)
Paging offset.
-
onboardStatus: integer
Search for the onboard status, supported values [0,1].
-
passportNumber: string
Minimum Length:
0Maximum Length:20Pattern:^[a-zA-Z0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Search for the passport number. -
profileType: string
Minimum Length:
0Maximum Length:1Pattern:^P|R|C|V|S$Search for the profile type, supported values are [P,C,R,V,S] and is supported multiple values. Can be used together with searchValue or reservation status. -
reservationBookingNumber: string
Minimum Length:
0Maximum Length:100Pattern:^[a-zA-Z0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Search for the reservation booking number. -
reservationStatus: string
Minimum Length:
0Maximum Length:2Pattern:^RR|RE|CC|CL|DD|RN|RXSearch for the reservation status, supported values [CC, RE, CL, DD, RR, RN, RX] and is supported multiple values. Can be used together with searchValue and/ or profile type. -
searchValue: string
Maximum Length:
100Pattern:^[a-zA-Z0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Search for the input text which match the values either in (First Name, Last Name, Stateroom number,Boardcard number, Set Sail Pass Number, Booking number, Passport number, Manning number). Can be used together with reservation status and/ or profile type. -
setSailPass: string
Minimum Length:
0Maximum Length:30Pattern:^[a-zA-Z0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Search for the Setsailpass number. -
stateRoomNumber: string
Minimum Length:
0Maximum Length:20Pattern:^[a-zA-Z0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Search for the stateroom number.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : List of reservation search
Type:
objectTitle:
List of reservation searchList of reservation search
Show Source
-
count(optional):
integer
Example:
2 -
items(optional):
object ReturnSearchData
data return
-
limit(optional):
integer
Example:
10 -
links(optional):
array links
-
offset(optional):
integer
Example:
0
Nested Schema : ReturnSearchData
Type:
objectdata return
Show Source
-
crew(optional):
object crewDetails
Crew information based on the Profile id passed
-
guest(optional):
object guestDetails
Guest information based on the Profile id passed
-
resident(optional):
object residentDetails
Resident information based on the Profile id passed
-
visitor(optional):
object visitorDetails
Visitor information based on the Profile id passed
Nested Schema : crewDetails
Type:
objectCrew information based on the Profile id passed
Show Source
-
accountId(optional):
integer
Minimum Value:
1Example:12345 -
accountType(optional):
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Pattern:^A|P|C|G|V|O$Example:System Account, Passenger, Crew, Group, Visitor -
actualDisembarkDate(optional):
string(date-time)
Example:
null or 2015-09-09 -
actualEmbarkDate(optional):
string(date-time)
Example:
2015-09-02 -
age(optional):
integer(int32)
Minimum Value:
1Maximum Value:150Example:57 -
alternativeContactNum(optional):
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
assemblyStationCode(optional):
string
Minimum Length:
0Maximum Length:6Pattern:[a-z0-9]Example:12345 -
assemblyStationName(optional):
string
Minimum Length:
1Maximum Length:50Pattern:[a-z0-9]Example:12345 -
boardCardNumber(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
cabinNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:11111 -
classification(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:[VIP] -
consentStatus(optional):
integer
Example:
0 -
contactNum(optional):
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
countryOfBirth(optional):
string
Minimum Length:
1Maximum Length:3Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
countryOfResidence(optional):
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
crewManningNumber(optional):
integer
Minimum Length:
0Maximum Length:38Example:123 -
dateOfBirth(optional):
string(date-time)
Example:
1961-04-01 -
disembarkDate(optional):
string(date-time)
Example:
2015-09-09 -
disembarkPort(optional):
integer
Example:
123 -
documentExpiryDate(optional):
string(date-time)
Example:
1961-04-01 -
documentIssuedCountry(optional):
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
documentIssuedDate(optional):
string(date-time)
Example:
1961-04-01 -
emailAddress(optional):
string
Minimum Length:
1Maximum Length:50Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$Example:EMAIL ADD -
embarkDate(optional):
string(date-time)
Example:
2015-09-02 -
embarkPort(optional):
integer
Example:
123 -
emergencyContactName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
emergencyContactNum(optional):
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
firstName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
gender(optional):
string
Minimum Length:
1Maximum Length:6Pattern:[A-Z]Example:M or F -
guestId(optional):
integer
Minimum Value:
0Example:12345 -
lastName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
middleName(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Andy -
nationalIdNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
nationality(optional):
string
Minimum Length:
1Maximum Length:6Pattern:[a-z0-9]Example:US -
onboardStatus(optional):
integer
Example:
0 -
operationalDepartment(optional):
string
Example:
Deck Officer -
operationalPosition(optional):
string
Example:
1st Engineer -
passportNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
photo(optional):
string
Example:
/Images/People/ -
reservationAccountReferenceId(optional):
integer(int32)
Example:
12345 -
reservationAccountType(optional):
string
Minimum Length:
1Maximum Length:1Allowed Values:[ "P", "R", "C", "V" ]Pattern:^P|R|C|V$Example:P -
reservationBookingNumber(optional):
string
Minimum Length:
1Maximum Length:100Pattern:[a-z0-9]Example:0123456789 -
reservationCancelStatus(optional):
boolean
Example:
false -
reservationId(optional):
integer
Minimum Value:
0Example:12345 -
reservationStatus(optional):
string
Minimum Length:
2Maximum Length:2Allowed Values:[ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]Example:CC -
salutation(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:MR -
title(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Mr -
travelDocumentNumber(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
unicodeName(optional):
string
Minimum Length:
1Maximum Length:100Example:
Nested Schema : guestDetails
Type:
objectGuest information based on the Profile id passed
Show Source
-
accountCategory(optional):
string
Minimum Length:
1Maximum Length:6Pattern:^SYS|GRP|CRW|PAX|VTO$Example:PAX -
accountId(optional):
integer
Minimum Value:
1Example:12345 -
accountType(optional):
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Pattern:^A|P|C|G|V|O$Example:System Account, Passenger, Crew, Group, Visitor -
actualDisembarkDate(optional):
string(date-time)
Example:
null or 2015-09-09 -
actualEmbarkDate(optional):
string(date-time)
Example:
2015-09-02 -
age(optional):
integer(int32)
Minimum Value:
1Maximum Value:150Example:57 -
alternativeContactNum(optional):
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
assemblyStationCode(optional):
string
Minimum Length:
0Maximum Length:6Pattern:[a-z0-9]Example:12345 -
assemblyStationName(optional):
string
Minimum Length:
1Maximum Length:50Pattern:[a-z0-9]Example:12345 -
boardCardNumber(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
cabinNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:11111 -
classification(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:[VIP] -
consentStatus(optional):
integer
Example:
0 -
contactNum(optional):
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
countryOfBirth(optional):
string
Minimum Length:
1Maximum Length:3Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
countryOfResidence(optional):
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
dateOfBirth(optional):
string(date-time)
Example:
1961-04-01 -
disembarkDate(optional):
string(date-time)
Example:
2015-09-09 -
disembarkPort(optional):
integer
Example:
123 -
documentExpiryDate(optional):
string(date-time)
Example:
1961-04-01 -
documentIssuedCountry(optional):
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
documentIssuedDate(optional):
string(date-time)
Example:
1961-04-01 -
emailAddress(optional):
string
Minimum Length:
1Maximum Length:50Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-]+)(\\.([a-zA-Z]{2,5})){1,}$Example:EMAIL ADD -
embarkCruiseId(optional):
integer(int32)
Example:
12345 -
embarkDate(optional):
string(date-time)
Example:
2015-09-02 -
embarkPort(optional):
integer
Example:
123 -
emergencyContactName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
emergencyContactNum(optional):
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
firstName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
gender(optional):
string
Minimum Length:
1Maximum Length:6Pattern:[A-Z]Example:M or F -
groupName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
groupReferenceId(optional):
integer(int32)
Example:
12345 -
guestId(optional):
integer
Minimum Value:
0Example:12345 -
lastName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
middleName(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Andy -
nationalIdNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
nationality(optional):
string
Minimum Length:
1Maximum Length:6Pattern:[a-z0-9]Example:US -
onboardStatus(optional):
integer
Example:
0 -
passportNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
photo(optional):
string
Example:
/Images/People/ -
reservationAccountReferenceId(optional):
integer(int32)
Example:
12345 -
reservationAccountType(optional):
string
Minimum Length:
1Maximum Length:1Allowed Values:[ "P", "R", "C", "V" ]Pattern:^P|R|C|V$Example:P -
reservationBookingNumber(optional):
string
Minimum Length:
1Maximum Length:100Pattern:[a-z0-9]Example:0123456789 -
reservationCancelStatus(optional):
boolean
Example:
false -
reservationExternalId(optional):
string
Minimum Length:
1Maximum Length:50Pattern:[a-z0-9]Example:12345 -
reservationId(optional):
integer
Minimum Value:
0Example:12345 -
reservationStatus(optional):
string
Minimum Length:
2Maximum Length:2Allowed Values:[ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]Example:CC -
routedAccountNumber(optional):
integer(int32)
Example:
12345 -
salutation(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:MR -
setSailPass(optional):
string
Minimum Length:
1Maximum Length:30Pattern:[a-z0-9]Example:12345 -
title(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Mr -
travelDocumentNumber(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
unicodeName(optional):
string
Minimum Length:
1Maximum Length:100Example:
Nested Schema : residentDetails
Type:
objectResident information based on the Profile id passed
Show Source
-
accountCategory(optional):
string
Minimum Length:
1Maximum Length:6Pattern:^SYS|GRP|CRW|PAX|VTO$Example:PAX -
accountId(optional):
integer
Minimum Value:
1Example:12345 -
accountType(optional):
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Pattern:^A|P|C|G|V|O$Example:System Account, Passenger, Crew, Group, Visitor -
actualDisembarkDate(optional):
string(date-time)
Example:
null or 2015-09-09 -
actualEmbarkDate(optional):
string(date-time)
Example:
2015-09-02 -
age(optional):
integer(int32)
Minimum Value:
1Maximum Value:150Example:57 -
alternativeContactNum(optional):
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
assemblyStationCode(optional):
string
Minimum Length:
0Maximum Length:6Pattern:[a-z0-9]Example:12345 -
boardCardNumber(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
cabinNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:11111 -
consentStatus(optional):
integer
Example:
0 -
contactNum(optional):
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
countryOfBirth(optional):
string
Minimum Length:
1Maximum Length:3Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
countryOfResidence(optional):
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
dateOfBirth(optional):
string(date-time)
Example:
1961-04-01 -
disembarkDate(optional):
string(date-time)
Example:
2015-09-09 -
disembarkPort(optional):
integer
Example:
123 -
documentExpiryDate(optional):
string(date-time)
Example:
1961-04-01 -
documentIssuedCountry(optional):
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
documentIssuedDate(optional):
string(date-time)
Example:
1961-04-01 -
emailAddress(optional):
string
Minimum Length:
1Maximum Length:50Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$Example:EMAIL ADD -
embarkCruiseId(optional):
integer(int32)
Example:
12345 -
embarkDate(optional):
string(date-time)
Example:
2015-09-02 -
embarkPort(optional):
integer
Example:
123 -
emergencyContactName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
emergencyContactNum(optional):
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
firstName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
gender(optional):
string
Minimum Length:
1Maximum Length:6Pattern:[A-Z]Example:M or F -
groupName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
groupReferenceId(optional):
integer(int32)
Example:
12345 -
guestId(optional):
integer
Minimum Value:
0Example:12345 -
lastName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
middleName(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Andy -
nationalIdNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
nationality(optional):
string
Minimum Length:
1Maximum Length:6Pattern:[a-z0-9]Example:US -
onboardStatus(optional):
integer
Example:
0 -
passportNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
photo(optional):
string
Example:
/Images/People/ -
reservationAccountReferenceId(optional):
integer(int32)
Example:
12345 -
reservationAccountType(optional):
string
Minimum Length:
1Maximum Length:1Allowed Values:[ "P", "R", "C", "V" ]Pattern:^P|R|C|V$Example:P -
reservationBookingNumber(optional):
string
Minimum Length:
1Maximum Length:100Pattern:[a-z0-9]Example:0123456789 -
reservationCancelStatus(optional):
boolean
Example:
false -
reservationExternalId(optional):
string
Minimum Length:
1Maximum Length:50Pattern:[a-z0-9]Example:12345 -
reservationId(optional):
integer
Minimum Value:
0Example:12345 -
reservationStatus(optional):
string
Minimum Length:
2Maximum Length:2Allowed Values:[ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]Example:CC -
routedAccountNumber(optional):
integer(int32)
Example:
12345 -
salutation(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:MR -
setSailPass(optional):
string
Minimum Length:
1Maximum Length:30Pattern:[a-z0-9]Example:12345 -
title(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Mr -
travelDocumentNumber(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
unicodeName(optional):
string
Minimum Length:
1Maximum Length:100Example:
Nested Schema : visitorDetails
Type:
objectVisitor information based on the Profile id passed
Show Source
-
accountId(optional):
integer
Minimum Value:
1Example:12345 -
accountType(optional):
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Pattern:^A|P|C|G|V|O$Example:System Account, Passenger, Crew, Group, Visitor -
actualDisembarkDate(optional):
string(date-time)
Example:
null or 2015-09-09 -
actualEmbarkDate(optional):
string(date-time)
Example:
2015-09-02 -
age(optional):
integer(int32)
Minimum Value:
1Maximum Value:150Example:57 -
boardCardNumber(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
consentStatus(optional):
integer
Example:
0 -
contactNum(optional):
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
countryOfBirth(optional):
string
Minimum Length:
1Maximum Length:3Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
countryOfResidence(optional):
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
dateOfBirth(optional):
string(date-time)
Example:
1961-04-01 -
disembarkDate(optional):
string(date-time)
Example:
2015-09-09 -
emailAddress(optional):
string
Minimum Length:
1Maximum Length:50Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$Example:EMAIL ADD -
embarkDate(optional):
string(date-time)
Example:
2015-09-02 -
embarkPort(optional):
integer
Example:
123 -
emergencyContactName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
emergencyContactNum(optional):
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
firstName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
gender(optional):
string
Minimum Length:
1Maximum Length:6Pattern:[A-Z]Example:M or F -
groupName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
guestId(optional):
integer
Minimum Value:
0Example:12345 -
lastName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
middleName(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Andy -
nationality(optional):
string
Minimum Length:
1Maximum Length:6Pattern:[a-z0-9]Example:US -
onboardStatus(optional):
integer
Example:
0 -
passportNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
photo(optional):
string
Example:
/Images/People/ -
reservationAccountType(optional):
string
Minimum Length:
1Maximum Length:1Allowed Values:[ "P", "R", "C", "V" ]Pattern:^P|R|C|V$Example:P -
reservationCancelStatus(optional):
boolean
Example:
false -
reservationId(optional):
integer
Minimum Value:
0Example:12345 -
reservationStatus(optional):
string
Minimum Length:
2Maximum Length:2Allowed Values:[ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]Example:CC -
salutation(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:MR -
title(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Mr -
travelDocumentNumber(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
visitorPassType(optional):
string
Minimum Length:
0Maximum Length:6Pattern:^[a-zA-Z0-9- ]*$Example:
Nested Schema : items
Match All
Show Source
-
object
linksReservations
links Reservations
-
object
items-allOf[1]
Nested Schema : linksReservations
Type:
objectlinks Reservations
Show Source
-
method(optional):
string
Example:
get -
rel(optional):
string
Example:
self
Nested Schema : items-allOf[1]
Type:
Show Source
object-
href(optional):
string
Example:
http://example.com/spms/v1/reservations?expand=all&serchTerm=john&offset=0&limit=2 -
operationId(optional):
string
Example:
search
Example Response (application/json)
{
"count":24,
"hasMore":true,
"links":[
{
"rel":"self",
"method":"get",
"href":"http://example.com/spms/v1/reservations?expand=all&serchTerm=john&offset=0&limit=10",
"operationId":"nextPage"
}
],
"items":[
{
"links":[
{
"rel":"guest",
"href":"http://localhost:8080/spms/v1/guest/12345",
"method":"get",
"operationId":"findByID"
},
{
"rel":"otherTravelDocument",
"href":"http://localhost:8080/spms/v1/guest/12345/otherTravelDocuments",
"method":"get",
"operationId":"getGuestOtherTravelDocuments"
}
]
},
{
"item":{
"guestId":12345,
"title":"Mr",
"salutation":"MR",
"firstName":"John",
"middleName":"Andy",
"lastName":"Smith",
"unicodeName":null,
"dateOfBirth":"1961-04-01",
"age":57,
"accountCategory":"PAX",
"accountType":"System Account Passenger Crew Group Visitor",
"passportNum":"A01234567",
"nationalIdNum":123456789,
"documentIssuedDate":"1961-04-01",
"documentExpiryDate":"1961-04-01",
"documentIssuedCountry":"US",
"countryOfBirth":"US",
"countryOfResidence":"US",
"contactNum":"+0123456789",
"alternativeContactNum":"+0123456789",
"emailAddress":"EMAIL ADD",
"emergencyContactName":"John",
"emergencyContactNum":"+0123456789",
"gender":"M or F",
"nationality":"US",
"reservationAccountReferenceId":12345,
"reservationStatus":"CC",
"cabinNum":12345,
"reservationAccountType":"P",
"routedAccountNumber":12345,
"onboardStatus":0,
"reservationCancelStatus":false,
"reservationBookingNumber":"0123456789",
"embarkCruiseId":12345,
"embarkDate":"2015-09-02",
"actualEmbarkDate":"2015-09-02",
"disembarkDate":"2015-09-09",
"actualDisembarkDate":"null or 2015-09-09",
"boardCardNumber":123456789,
"reservationId":12345,
"accountId":12345,
"reservationExternalId":12345,
"embarkPort":123,
"disembarkPort":123,
"groupReferenceId":12345,
"photo":"/Images/People/",
"classification":"VIP",
"setSailPass":12345,
"assemblyStationCode":12345,
"assemblyStationName":12345,
"groupName":"Smith",
"consentStatus":0,
"travelDocumentNumber":"A12345"
}
},
{
"links":{
"rel":"crew",
"href":"http://localhost:8080/spms/v1/crew/12345",
"method":"get",
"operationId":"findByID"
}
},
{
"item":{
"guestId":12345,
"title":"Mr",
"salutation":"MR",
"firstName":"John",
"middleName":"Andy",
"lastName":"Smith",
"unicodeName":null,
"dateOfBirth":"1961-04-01",
"age":57,
"accountType":"System Account Passenger Crew Group Visitor",
"passportNum":"A01234567",
"nationalIdNum":123456789,
"documentIssuedDate":"1961-04-01",
"documentExpiryDate":"1961-04-01",
"documentIssuedCountry":"US",
"countryOfBirth":"US",
"countryOfResidence":"US",
"contactNum":"+0123456789",
"alternativeContactNum":"+0123456789",
"emailAddress":"EMAIL ADD",
"emergencyContactName":"John",
"emergencyContactNum":"+0123456789",
"gender":"M or F",
"nationality":"US",
"reservationAccountReferenceId":12345,
"reservationStatus":"CC",
"cabinNum":12345,
"reservationAccountType":"P",
"onboardStatus":0,
"reservationCancelStatus":false,
"reservationBookingNumber":"0123456789",
"embarkDate":"2015-09-02",
"actualEmbarkDate":"2015-09-02",
"disembarkDate":"2015-09-09",
"actualDisembarkDate":"null or 2015-09-09",
"boardCardNumber":123456789,
"reservationId":12345,
"accountId":12345,
"embarkPort":123,
"disembarkPort":123,
"photo":"/Images/People/",
"classification":"VIP",
"assemblyStationCode":12345,
"assemblyStationName":12345,
"consentStatus":0,
"travelDocumentNumber":"A12345",
"operationalDepartment":"Deck Officer",
"operationalPosition":"1st Engineer",
"crewManningNumber":2,
"safetyPositionCode":2,
"safetyPositionName":"Master"
}
},
{
"links":{
"rel":"resident",
"href":"http://localhost:8080/spms/v1/resident/12345",
"method":"get",
"operationId":"findByID"
}
},
{
"item":{
"guestId":12345,
"title":"Mr",
"salutation":"MR",
"firstName":"John",
"middleName":"Andy",
"lastName":"Smith",
"unicodeName":null,
"dateOfBirth":"1961-04-01",
"age":57,
"accountCategory":"PAX",
"accountType":"System Account Passenger Crew Group Visitor",
"passportNum":"A01234567",
"nationalIdNum":123456789,
"documentIssuedDate":"1961-04-01",
"documentExpiryDate":"1961-04-01",
"documentIssuedCountry":"US",
"countryOfBirth":"US",
"countryOfResidence":"US",
"contactNum":"+0123456789",
"alternativeContactNum":"+0123456789",
"emailAddress":"EMAIL ADD",
"emergencyContactName":"John",
"emergencyContactNum":"+0123456789",
"gender":"M or F",
"nationality":"US",
"reservationAccountReferenceId":12345,
"reservationStatus":"CC",
"cabinNum":12345,
"reservationAccountType":"P",
"routedAccountNumber":12345,
"onboardStatus":0,
"reservationCancelStatus":false,
"reservationBookingNumber":"0123456789",
"embarkCruiseId":12345,
"embarkDate":"2015-09-02",
"actualEmbarkDate":"2015-09-02",
"disembarkDate":"2015-09-09",
"actualDisembarkDate":"null or 2015-09-09",
"boardCardNumber":123456789,
"reservationId":12345,
"accountId":12345,
"reservationExternalId":12345,
"embarkPort":123,
"disembarkPort":123,
"groupReferenceId":12345,
"photo":"/Images/People/",
"setSailPass":12345,
"assemblyStationCode":12345,
"groupName":"Smith",
"consentStatus":0,
"travelDocumentNumber":"A12345"
}
},
{
"links":{
"rel":"visitor",
"href":"http://localhost:8080/spms/v1/visitor/12345",
"method":"get",
"operationId":"findByID"
}
},
{
"item":{
"guestId":12345,
"title":"Mr",
"salutation":"MR",
"firstName":"John",
"middleName":"Andy",
"lastName":"Smith",
"dateOfBirth":"1961-04-01",
"age":57,
"accountType":"System Account Passenger Crew Group Visitor",
"passportNum":"A01234567",
"countryOfBirth":"US",
"countryOfResidence":"US",
"contactNum":"+0123456789",
"emailAddress":"EMAIL ADD",
"emergencyContactName":"John",
"emergencyContactNum":"+0123456789",
"gender":"M or F",
"nationality":"US",
"reservationStatus":"CC",
"reservationAccountType":"P",
"onboardStatus":0,
"reservationCancelStatus":false,
"embarkDate":"2015-09-02",
"actualEmbarkDate":"2015-09-02",
"disembarkDate":"2015-09-09",
"actualDisembarkDate":"null or 2015-09-09",
"boardCardNumber":123456789,
"reservationId":12345,
"accountId":12345,
"embarkPort":123,
"photo":"/Images/People/",
"consentStatus":0,
"travelDocumentNumber":"A12345",
"visitorPassType":"DEC10"
}
}
],
"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(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
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(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
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(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
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(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
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(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
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(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
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 not available",
"detail":"Service Unavailable. Try again later"
}Nested Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object...... -
title(optional):
string
Example:
validation fails for row with key={123} -
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1