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 * embarkationDateByStatus * disembarkationDate * disembarkationDateByStatus * onboardStatus * reservationStatusCode * reservationStatusDescription * travelDocumentNumber * crewManningNumber * hasInternalLocations * locationAt * hasSpecialNeeds * totalSpecialNeeds
POST Request Object
Root Schema : Reservation Search Request
Type:
objectTitle:
Reservation Search RequestReservation Search Optional Parameters
Show Source
-
ageType:
array ageTypeListRequest
Age type list. Support multiple values (Example: [0, 1, 2]) * `Optional` (Do not provide if not in use) * 0 - Adult, 1 - Minor, 2- Young Adult * No birthdate is a minor * For all Profile Types
-
analyticType(required):
string
Pattern:
^(?:onboard|ashore|checkingOutToday|checkedOut|expected|overnightTour)$Analytic Types. Support analytic requests * `Required` * onboard - profiles that are onboard * ashore - profiles that are ashore * checkingOutToday - profiles that are checking out today / disembarking * checkedOut - profiles that have checked out today / disembarked * expected - profiles that are expected * overnightTour - profiles that are on overnight tourExample:onboard -
profileType:
array profileTypeList
Profile type list. Support multiple values (Example: ['P', 'R']) * `Optional` (Do not provide if not in use)
-
searchValue:
string
Minimum Length:
1Maximum Length:100Value 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 TypesExample:John
Nested Schema : ageTypeListRequest
Type:
arrayAge type list. Support multiple values (Example: [0, 1, 2])
* `Optional` (Do not provide if not in use)
* 0 - Adult, 1 - Minor, 2- Young Adult
* No birthdate is a minor
* For all Profile Types
Show Source
-
Array of:
number
Minimum Length:
1Maximum Length:1Pattern:^[0-2]$Age typeExample:1
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
Minimum Length:
1Maximum Length:1Pattern:^[PRCV]$Profile typeExample:P
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Reservation search response
Type:
objectTitle:
Reservation search responsereservation search response
Show Source
-
count(required):
integer
Example:
2 -
items(required):
array reservationObjectList
List of reservation objects
-
limit(required):
integer
Example:
10 -
link(required):
object linkReservations
link (Reservations)
-
offset(required):
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(required):
string
Example:
http://[HOSTNAME]/spms/v2/ships/11100777/reservations?searchValue=john&offset=0&limit=2 -
method(required):
string
Example:
get -
operationId(required):
string
Example:
search -
rel(required):
string
Example:
self
Nested Schema : reservationObject
Type:
objectReservation object
Show Source
-
item(required):
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(required):
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(required):
integer
Example:
12345 -
accountType(required):
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Example:C -
actualDisembarkationDate(required):
string(date)
Actual Disembarkation DateExample:
2015-09-08 -
actualDisembarkationTime(required):
string
Pattern:
HH:mm:ssActual Disembarkation TimeExample:16:00:00 -
actualEmbarkationDate(required):
string(date)
Actual Embarkation DateExample:
2015-09-02 -
actualEmbarkationTime(required):
string
Pattern:
HH:mm:ssActual Embarkation TimeExample:07:00:00 -
age(required):
integer
Example:
19 -
ageType(required):
string
Age TypeExample:
Young Adult -
attendImmigrationInspection(required):
number
Immigration status flagExample:
1 -
birthNation(required):
object birthNation
Birth Nation
-
boardCardNumber(required):
string
Example:
123456789 -
cabinNumber(required):
string
Example:
11111 -
contactlessId(required):
array rsContactlessIdList
List of active Contactless Id (includes door key)
-
countryOfResidence(required):
object countryOfResidence
Country of residence
-
crewExternalId(required):
string
Crew External IDExample:
aaa123 -
crewInternalId(required):
string
Crew Internal IDExample:
aaa123 -
crewManningNumber(required):
integer
Example:
123 -
crewOperationalDepartment(required):
object crewOperationalDepartment
-
crewOperationalPosition(required):
object crewOperationalPosition
-
dateOfBirth(required):
string(date)
Example:
1961-04-01 -
discountTemplate(required):
object discountTemplate
-
disembarkationDate(required):
string(date)
Expected Disembarkation DateExample:
2015-09-09 -
disembarkationDateByStatus(required):
string
Disembarkation Date by Reservation Status * If reservation status is Checked Out, actual disembarkation date is returned. * For other reservation status, expected disembarkation date is returned.Example:
2015-09-08 -
disembarkationHarbor(required):
object disembarkationHarbor
-
emailAddress(required):
string
Example:
email@example.com -
embarkationDate(required):
string(date)
Expected Embarkation DateExample:
2015-09-02 -
embarkationDateByStatus(required):
string(date)
Embarkation Date by Reservation Status * If reservation status is Checked In/Leaving Today/Checked Out, actual embarkation date is returned. * For other reservation status, expected embarkation date is returned.Example:
2015-09-02 -
embarkationHarbor(required):
object embarkationHarbor
-
emergencyContactName(required):
string
Example:
John -
emergencyContactNumber(required):
string
Example:
+0123456789 -
firstName(required):
string
Example:
John -
fullName(required):
string
Full nameExample:
John Andy Smith -
gender(required):
object gender
-
hasInternalLocations(required):
boolean
Indicate if profile is at any internal gate locationsExample:
true -
hasOvernightTour(required):
boolean
Example:
true -
hasSpecialNeeds(required):
boolean
Indicate whether profile has any special needs. If profile's special need remark is not empty then it's considered as true. True: has special needs, False: No special need.Example:
true -
isNoticeAndConsent(required):
boolean
Example:
true -
lastName(required):
string
Example:
Smith -
locationAt(required):
string
Reservation Internal Gate LocationExample:
ABC23 -
middleName(required):
string
Example:
Andy -
musterStation(required):
object musterStation
Muster Station
-
nationalId(required):
string
Example:
123456789 -
nationality(required):
object nationality
Nationality
-
onboardStatus(required):
boolean
Onboard StatusExample:
true -
otherFirstName(required):
string
Other First NameExample:
伟 -
otherLastName(required):
string
Other Last NameExample:
李 -
passportExpiryDate(required):
string(date)
Example:
1961-04-01 -
passportIssuedCountry(required):
object passportIssuedCountry
Passport Issued Country
-
passportIssuedDate(required):
string(date)
Example:
1961-04-01 -
passportIssuedPlace(required):
string
Passport Issued PlaceExample:
Paramount -
passportNumber(required):
string
Passport NumberExample:
A01234567 -
phoneNumber(required):
string
Example:
+0123456789 -
photo(required):
string
Photo linkExample:
/Images/People/ -
profileId(required):
integer
Profile IDExample:
12345 -
reservationAccountReferenceId(required):
integer
Example:
12345 -
reservationAccountType(required):
string
Allowed Values:
[ "P", "R", "C", "V" ]Example:C -
reservationBookingNumber(required):
string
Example:
0123456789 -
reservationCancelStatus(required):
boolean
Example:
false -
reservationId(required):
integer
Example:
12345 -
reservationStatus(required):
object reservationStatus
Reservation Status
-
safetyPosition(required):
object safetyPosition
-
salutation(required):
string
Example:
MR -
skipImmigrationInspection(required):
boolean
To exclude from immigration gateExample:
true -
specialNeedRemarks(required):
string
Profile special need remarksExample:
Need special care -
specialNeeds(required):
array rsSpecialNeeds
-
temporaryPhoneNumber(required):
string
Temporary or Alternative Phone NumberExample:
+0123456789 -
title(required):
string
Example:
Mr -
totalSpecialNeeds(required):
integer
Total count of profile's special needs. If profile's special need remark is not empty then it's considered as one of the special needs.Example:
1
Nested Schema : guestDetails
Type:
objectGuest information based on the Profile id passed
Show Source
-
accountCategory(required):
string
Pattern:
^SYS|GRP|CRW|PAX|VTO$Example:PAX -
accountId(required):
integer
Account IDExample:
12345 -
accountType(required):
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Account TypeExample:P -
actualDisembarkationDate(required):
string(date)
Actual Disembarkation DateExample:
2015-09-08 -
actualDisembarkationTime(required):
string
Pattern:
HH:mm:ssActual Disembarkation TimeExample:16:00:00 -
actualEmbarkationDate(required):
string(date)
Actual Embarkation DateExample:
2015-09-02 -
actualEmbarkationTime(required):
string
Pattern:
HH:mm:ssActual Embarkation TimeExample:07:00:00 -
age(required):
integer
AgeExample:
17 -
ageType(required):
string
Age TypeExample:
Minor -
attendImmigrationInspection(required):
number
Immigration status flagExample:
1 -
birthNation(required):
object birthNation
Birth Nation
-
boardCardNumber(required):
string
Boardcard numberExample:
123456789 -
classification(required):
string
ClassificationExample:
CLASS I -
contactlessId(required):
array rsContactlessIdList
List of active Contactless Id (includes door key)
-
countryOfResidence(required):
object countryOfResidence
Country of residence
-
dateOfBirth(required):
string(date)
Date of birthExample:
1961-04-01 -
discountTemplate(required):
object discountTemplate
-
disembarkationDate(required):
string(date)
Expected Disembarkation DateExample:
2015-09-09 -
disembarkationDateByStatus(required):
string
Disembarkation Date by Reservation Status * If reservation status is Checked Out, actual disembarkation date is returned. * For other reservation status, expected disembarkation date is returned.Example:
2015-09-08 -
disembarkationHarbor(required):
object disembarkationHarbor
-
emailAddress(required):
string
Email AddressExample:
email@example.com -
embarkationDate(required):
string(date)
Expected Embarkation DateExample:
2015-09-02 -
embarkationDateByStatus(required):
string(date)
Embarkation Date by Reservation Status * If reservation status is Checked In/Leaving Today/Checked Out, actual embarkation date is returned. * For other reservation status, expected embarkation date is returned.Example:
2015-09-02 -
embarkationHarbor(required):
object embarkationHarbor
-
embarkCruiseId(required):
integer
Embark Cruise IDExample:
12345 -
emergencyContactName(required):
string
Emergency Contact NameExample:
John -
emergencyContactNumber(required):
string
Emergency Contact NumberExample:
+0123456789 -
firstName(required):
string
First NameExample:
John -
fullName(required):
string
Full nameExample:
John Andy Smith -
gender(required):
object gender
-
groupName(required):
string
Example:
Smith -
groupReferenceId(required):
integer
Group Reference IDExample:
12345 -
hasInternalLocations(required):
boolean
Indicate if profile is at any internal gate locationsExample:
true -
hasOvernightTour(required):
boolean
Example:
true -
hasSpecialNeeds(required):
boolean
Indicate whether profile has any special needs. If profile's special need remark is not empty then it's considered as true. True: has special needs, False: No special need.Example:
true -
isNoticeAndConsent(required):
boolean
Example:
true -
lastName(required):
string
Last NameExample:
Smith -
locationAt(required):
string
Reservation Internal Gate LocationExample:
ABC23 -
middleName(required):
string
Example:
Andy -
musterStation(required):
object musterStation
Muster Station
-
nationalId(required):
string
National IDExample:
123456789 -
nationality(required):
object nationality
Nationality
-
onboardStatus(required):
boolean
Onboard StatusExample:
true -
otherFirstName(required):
string
Example:
伟 -
otherLastName(required):
string
Example:
李 -
passportExpiryDate(required):
string(date)
Passport Expiry DateExample:
1961-04-01 -
passportIssuedCountry(required):
object passportIssuedCountry
Passport Issued Country
-
passportIssuedDate(required):
string(date)
Example:
1961-04-01 -
passportIssuedPlace(required):
string
Passport Issued PlaceExample:
Paramount -
passportNumber(required):
string
Passport NumberExample:
A01234567 -
phoneNumber(required):
string
Phone NumberExample:
+0123456789 -
photo(required):
string
PhotoExample:
/Images/People/ -
profileId(required):
integer
Profile IDExample:
12345 -
reservationAccountReferenceId(required):
integer
Reservation Account Reference IDExample:
12345 -
reservationAccountType(required):
string
Allowed Values:
[ "P", "R", "C", "V" ]Reservation Account TypeExample:P -
reservationBookingNumber(required):
string
Reservation Booking NumberExample:
0123456789 -
reservationCancelStatus(required):
boolean
Reservation Cancel StatusExample:
false -
reservationExternalId(required):
string
Reservation External IDExample:
12345 -
reservationId(required):
integer
Example:
12345 -
reservationStatus(required):
object reservationStatus
Reservation Status
-
routedAccountNumber(required):
integer
Routed Account NumberExample:
12345 -
salutation(required):
string
Example:
MR -
setSailPass(required):
string
Setsailpass numberExample:
ABC001 -
skipImmigrationInspection(required):
boolean
To exclude from immigration gateExample:
true -
specialNeedRemarks(required):
string
Profile special need remarksExample:
Need special care -
specialNeeds(required):
array rsSpecialNeeds
-
stateroomNumber(required):
string
Stateroom numberExample:
11111 -
temporaryPhoneNumber(required):
string
Temporary or Alternative Phone NumberExample:
+0123456789 -
title(required):
string
TitleExample:
Mr -
totalSpecialNeeds(required):
integer
Total count of profile's special needs. If profile's special need remark is not empty then it's considered as one of the special needs.Example:
1
Nested Schema : residentDetails
Type:
objectResident information based on the Profile id passed
Show Source
-
accountCategory(required):
string
Pattern:
^SYS|GRP|CRW|PAX|VTO$Example:PAX -
accountId(required):
integer
Example:
12345 -
accountType(required):
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Example:P -
actualDisembarkationDate(required):
string(date)
Actual Disembarkation DateExample:
2015-09-08 -
actualDisembarkationTime(required):
string
Pattern:
HH:mm:ssActual Disembarkation TimeExample:16:00:00 -
actualEmbarkationDate(required):
string(date)
Actual Embarkation DateExample:
2015-09-02 -
actualEmbarkationTime(required):
string
Pattern:
HH:mm:ssActual Embarkation TimeExample:07:00:00 -
age(required):
integer
Example:
57 -
ageType(required):
string
Age TypeExample:
Adult -
attendImmigrationInspection(required):
number
Immigration status flagExample:
1 -
birthNation(required):
object birthNation
Birth Nation
-
boardCardNumber(required):
string
Example:
123456789 -
classification(required):
string
Example:
CLASS I -
contactlessId(required):
array rsContactlessIdList
List of active Contactless Id (includes door key)
-
countryOfResidence(required):
object countryOfResidence
Country of residence
-
dateOfBirth(required):
string(date)
Example:
1961-04-01 -
discountTemplate(required):
object discountTemplate
-
disembarkationDate(required):
string(date)
Expected Disembarkation DateExample:
2015-09-09 -
disembarkationDateByStatus(required):
string
Disembarkation Date by Reservation Status * If reservation status is Checked Out, actual disembarkation date is returned. * For other reservation status, expected disembarkation date is returned.Example:
2015-09-08 -
disembarkationHarbor(required):
object disembarkationHarbor
-
emailAddress(required):
string
Example:
email@example.com -
embarkationDate(required):
string(date)
Expected Embarkation DateExample:
2015-09-02 -
embarkationDateByStatus(required):
string(date)
Embarkation Date by Reservation Status * If reservation status is Checked In/Leaving Today/Checked Out, actual embarkation date is returned. * For other reservation status, expected embarkation date is returned.Example:
2015-09-02 -
embarkationHarbor(required):
object embarkationHarbor
-
embarkCruiseId(required):
integer
Example:
12345 -
emergencyContactName(required):
string
Example:
John -
emergencyContactNumber(required):
string
Example:
+0123456789 -
firstName(required):
string
Example:
John -
fullName(required):
string
Full nameExample:
John Andy Smith -
gender(required):
object gender
-
groupName(required):
string
Example:
Smith -
groupReferenceId(required):
integer
Example:
12345 -
hasInternalLocations(required):
boolean
Indicate if profile is at any internal gate locationsExample:
true -
hasOvernightTour(required):
boolean
Example:
true -
hasSpecialNeeds(required):
boolean
Indicate whether profile has any special needs. If profile's special need remark is not empty then it's considered as true. True: has special needs, False: No special need.Example:
true -
isNoticeAndConsent(required):
boolean
Example:
true -
lastName(required):
string
Example:
Smith -
locationAt(required):
string
Reservation Internal Gate LocationExample:
ABC23 -
middleName(required):
string
Example:
Andy -
musterStation(required):
object musterStation
Muster Station
-
nationalId(required):
string
Example:
123456789 -
nationality(required):
object nationality
Nationality
-
onboardStatus(required):
boolean
Onboard StatusExample:
true -
otherFirstName(required):
string
Example:
伟 -
otherLastName(required):
string
Example:
李 -
passportExpiryDate(required):
string(date)
Example:
1961-04-01 -
passportIssuedCountry(required):
object passportIssuedCountry
Passport Issued Country
-
passportIssuedDate(required):
string(date)
Example:
1961-04-01 -
passportIssuedPlace(required):
string
Passport Issued PlaceExample:
Paramount -
passportNumber(required):
string
Example:
A01234567 -
phoneNumber(required):
string
Example:
+0123456789 -
photo(required):
string
Example:
/Images/People/ -
profileId(required):
integer
Profile IDExample:
12345 -
reservationAccountReferenceId(required):
integer
Example:
12345 -
reservationAccountType(required):
string
Allowed Values:
[ "P", "R", "C", "V" ]Example:R -
reservationBookingNumber(required):
string
Example:
0123456789 -
reservationCancelStatus(required):
boolean
Example:
false -
reservationExternalId(required):
string
Example:
12345 -
reservationId(required):
integer
Example:
12345 -
reservationStatus(required):
object reservationStatus
Reservation Status
-
routedAccountNumber(required):
integer
Example:
12345 -
salutation(required):
string
Example:
MR -
setSailPass(required):
string
Setsailpass numberExample:
ABC001 -
skipImmigrationInspection(required):
boolean
To exclude from immigration gateExample:
true -
specialNeedRemarks(required):
string
Profile special need remarksExample:
Need special care -
specialNeeds(required):
array rsSpecialNeeds
-
stateroomNumber(required):
string
Example:
11111 -
temporaryPhoneNumber(required):
string
Temporary or Alternative Phone NumberExample:
+0123456789 -
title(required):
string
Example:
Mr -
totalSpecialNeeds(required):
integer
Total count of profile's special needs. If profile's special need remark is not empty then it's considered as one of the special needs.Example:
1
Nested Schema : visitorDetails
Type:
objectVisitor information based on the Profile id passed
Show Source
-
accountId(required):
integer
Example:
12345 -
accountType(required):
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Example:V -
actualDisembarkationDate(required):
string(date)
Actual Disembarkation DateExample:
2015-09-08 -
actualDisembarkationTime(required):
string
Pattern:
HH:mm:ssActual Disembarkation TimeExample:16:00:00 -
actualEmbarkationDate(required):
string(date)
Actual Embarkation DateExample:
2015-09-02 -
actualEmbarkationTime(required):
string
Pattern:
HH:mm:ssActual Embarkation TimeExample:07:00:00 -
age(required):
integer
Example:
57 -
ageType(required):
string
Age TypeExample:
Adult -
attendImmigrationInspection(required):
number
Immigration status flagExample:
1 -
birthNation(required):
object birthNation
Birth Nation
-
boardCardNumber(required):
string
Example:
123456789 -
contactlessId(required):
array rsContactlessIdList
List of active Contactless Id (includes door key)
-
countryOfResidence(required):
object countryOfResidence
Country of residence
-
dateOfBirth(required):
string(date)
Example:
1961-04-01 -
disembarkationDate(required):
string(date)
Expected Disembarkation DateExample:
2015-09-09 -
disembarkationDateByStatus(required):
string
Disembarkation Date by Reservation Status * If reservation status is Checked Out, actual disembarkation date is returned. * For other reservation status, expected disembarkation date is returned.Example:
2015-09-08 -
disembarkationHarbor(required):
object disembarkationHarbor
-
earlyBoarding(required):
object earlyBoarding
-
emailAddress(required):
string
Example:
email@example.com -
embarkationDate(required):
string(date)
Expected Embarkation DateExample:
2015-09-02 -
embarkationDateByStatus(required):
string(date)
Embarkation Date by Reservation Status * If reservation status is Checked In/Leaving Today/Checked Out, actual embarkation date is returned. * For other reservation status, expected embarkation date is returned.Example:
2015-09-02 -
embarkationHarbor(required):
object embarkationHarbor
-
emergencyContactName(required):
string
Example:
John -
emergencyContactNumber(required):
string
Example:
+0123456789 -
firstName(required):
string
Example:
John -
fullName(required):
string
Full nameExample:
John Andy Smith -
gender(required):
object gender
-
hasInternalLocations(required):
boolean
Indicate if profile is at any internal gate locationsExample:
true -
hasOvernightTour(required):
boolean
Example:
true -
hasSpecialNeeds(required):
boolean
Indicate whether profile has any special needs. If profile's special need remark is not empty then it's considered as true. True: has special needs, False: No special need.Example:
true -
isNoticeAndConsent(required):
boolean
Example:
true -
lastName(required):
string
Example:
Smith -
locationAt(required):
string
Reservation Internal Gate LocationExample:
ABC23 -
middleName(required):
string
Example:
Andy -
nationality(required):
object nationality
Nationality
-
onboardStatus(required):
boolean
Onboard StatusExample:
true -
passportNumber(required):
string
Example:
A01234567 -
phoneNumber(required):
string
Example:
+0123456789 -
photo(required):
string
Example:
/Images/People/ -
profileId(required):
integer
Profile IDExample:
12345 -
reservationAccountType(required):
string
Allowed Values:
[ "P", "R", "C", "V" ]Example:V -
reservationCancelStatus(required):
boolean
Example:
false -
reservationId(required):
integer
Example:
12345 -
reservationStatus(required):
object reservationStatus
Reservation Status
-
salutation(required):
string
Example:
MR -
shipContact(required):
string
Example:
123456789 -
shipOperationContact(required):
object shipOperationContact
-
skipImmigrationInspection(required):
boolean
To exclude from immigration gateExample:
true -
specialNeedRemarks(required):
string
Profile special need remarksExample:
Need special care -
specialNeeds(required):
array rsSpecialNeeds
-
title(required):
string
Example:
Mr -
totalSpecialNeeds(required):
integer
Total count of profile's special needs. If profile's special need remark is not empty then it's considered as one of the special needs.Example:
1 -
visitorPassType(required):
string
Example:
Nested Schema : birthNation
Type:
objectBirth Nation
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Birth Nation CodeExample:MY -
description:
string
Country NameExample:
United States
Nested Schema : rsContactlessIdList
Type:
arrayList of active Contactless Id (includes door key)
Show Source
-
Array of:
string
Contactless IDExample:
1CA71546
Nested Schema : countryOfResidence
Type:
objectCountry of residence
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Country CodeExample:US -
description:
string
Country NameExample:
United States
Nested Schema : crewOperationalDepartment
Type:
Show Source
object-
code:
string
Crew Operational Department CodeExample:
120 -
description:
string
Minimum Length:
1Maximum Length:1000Crew Operational Department NameExample:Deck
Nested Schema : crewOperationalPosition
Type:
Show Source
object-
code:
string
Crew Operational Position CodeExample:
106 -
description:
string
Minimum Length:
1Maximum Length:50Crew Operational Position NameExample:3rd Officer
Nested Schema : discountTemplate
Type:
Show Source
object-
code:
string
Discount Template CodeExample:
LV2 -
description:
string
Discount Template NameExample:
Disc Template 2
Nested Schema : disembarkationHarbor
Type:
Show Source
object-
code:
string
Disembarkation Harbor CodeExample:
AGSJO -
description:
string
Disembarkation Harbor NameExample:
ST JOHNS
Nested Schema : embarkationHarbor
Type:
Show Source
object-
code:
string
Embarkation Harbor CodeExample:
AGSJO -
description:
string
Embarkation Harbor NameExample:
ST JOHNS
Nested Schema : gender
Type:
Show Source
object-
code:
string
Gender CodeExample:
F -
description:
string
Gender NameExample:
Female
Nested Schema : musterStation
Type:
objectMuster Station
Show Source
-
code:
string
Muster Station CodeExample:
A -
description:
string
Muster Station NameExample:
Musterstation A
Nested Schema : nationality
Type:
objectNationality
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Country CodeExample:US -
description:
string
Country NameExample:
United States
Nested Schema : passportIssuedCountry
Type:
objectPassport Issued Country
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Country CodeExample:US -
description:
string
Country NameExample:
United States
Nested Schema : reservationStatus
Type:
objectReservation Status
Show Source
-
code:
Allowed Values:
[ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]Reservation Status CodeExample:CC -
description:
string
Reservation status descriptionExample:
Expected
Nested Schema : safetyPosition
Type:
Show Source
object-
code:
string
Safety Position CodeExample:
004 -
description:
string
Safety Position NameExample:
Master
Nested Schema : items
Match All
Show Source
-
object
List of special need code and description
Title:
List of special need code and descriptionList of special need code and description
Nested Schema : List of special need code and description
Type:
objectTitle:
List of special need code and descriptionList of special need code and description
Show Source
-
code:
string
Special need codeExample:
WH -
description:
string
Special need descriptionExample:
Wheelchair
Nested Schema : birthNation
Type:
objectBirth Nation
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Birth Nation CodeExample:MY -
description:
string
Country NameExample:
United States
Nested Schema : countryOfResidence
Type:
objectCountry of residence
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Country CodeExample:US -
description:
string
Country NameExample:
United States
Nested Schema : discountTemplate
Type:
Show Source
object-
code:
string
Discount Template CodeExample:
LV2 -
description:
string
Discount Template NameExample:
Disc Template 2
Nested Schema : disembarkationHarbor
Type:
Show Source
object-
code:
string
Disembarkation Harbor CodeExample:
AGSJO -
description:
string
Disembarkation Harbor NameExample:
ST JOHNS
Nested Schema : embarkationHarbor
Type:
Show Source
object-
code:
string
Embarkation Harbor CodeExample:
AGSJO -
description:
string
Embarkation Harbor NameExample:
ST JOHNS
Nested Schema : gender
Type:
Show Source
object-
code:
string
Gender CodeExample:
F -
description:
string
Gender NameExample:
Female
Nested Schema : musterStation
Type:
objectMuster Station
Show Source
-
code:
string
Muster Station CodeExample:
A -
description:
string
Muster Station NameExample:
Musterstation A
Nested Schema : nationality
Type:
objectNationality
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Country CodeExample:US -
description:
string
Country NameExample:
United States
Nested Schema : passportIssuedCountry
Type:
objectPassport Issued Country
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Country CodeExample:US -
description:
string
Country NameExample:
United States
Nested Schema : reservationStatus
Type:
objectReservation Status
Show Source
-
code:
Allowed Values:
[ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]Reservation Status CodeExample:CC -
description:
string
Reservation status descriptionExample:
Expected
Nested Schema : birthNation
Type:
objectBirth Nation
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Birth Nation CodeExample:MY -
description:
string
Country NameExample:
United States
Nested Schema : countryOfResidence
Type:
objectCountry of residence
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Country CodeExample:US -
description:
string
Country NameExample:
United States
Nested Schema : discountTemplate
Type:
Show Source
object-
code:
string
Discount Template CodeExample:
LV2 -
description:
string
Discount Template NameExample:
Disc Template 2
Nested Schema : disembarkationHarbor
Type:
Show Source
object-
code:
string
Disembarkation Harbor CodeExample:
AGSJO -
description:
string
Disembarkation Harbor NameExample:
ST JOHNS
Nested Schema : embarkationHarbor
Type:
Show Source
object-
code:
string
Embarkation Harbor CodeExample:
AGSJO -
description:
string
Embarkation Harbor NameExample:
ST JOHNS
Nested Schema : gender
Type:
Show Source
object-
code:
string
Gender CodeExample:
F -
description:
string
Gender NameExample:
Female
Nested Schema : musterStation
Type:
objectMuster Station
Show Source
-
code:
string
Muster Station CodeExample:
A -
description:
string
Muster Station NameExample:
Musterstation A
Nested Schema : nationality
Type:
objectNationality
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Country CodeExample:US -
description:
string
Country NameExample:
United States
Nested Schema : passportIssuedCountry
Type:
objectPassport Issued Country
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Country CodeExample:US -
description:
string
Country NameExample:
United States
Nested Schema : reservationStatus
Type:
objectReservation Status
Show Source
-
code:
Allowed Values:
[ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]Reservation Status CodeExample:CC -
description:
string
Reservation status descriptionExample:
Expected
Nested Schema : birthNation
Type:
objectBirth Nation
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Birth Nation CodeExample:MY -
description:
string
Country NameExample:
United States
Nested Schema : countryOfResidence
Type:
objectCountry of residence
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Country CodeExample:US -
description:
string
Country NameExample:
United States
Nested Schema : disembarkationHarbor
Type:
Show Source
object-
code:
string
Disembarkation Harbor CodeExample:
AGSJO -
description:
string
Disembarkation Harbor NameExample:
ST JOHNS
Nested Schema : earlyBoarding
Type:
Show Source
object-
code:
string
Early Boarding CodeExample:
0 -
description:
string
Early Boarding DescriptionExample:
Normal Boarding
Nested Schema : embarkationHarbor
Type:
Show Source
object-
code:
string
Embarkation Harbor CodeExample:
AGSJO -
description:
string
Embarkation Harbor NameExample:
ST JOHNS
Nested Schema : gender
Type:
Show Source
object-
code:
string
Gender CodeExample:
F -
description:
string
Gender NameExample:
Female
Nested Schema : nationality
Type:
objectNationality
Show Source
-
code:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9,'_@./#&+-]*$Country CodeExample:US -
description:
string
Country NameExample:
United States
Nested Schema : reservationStatus
Type:
objectReservation Status
Show Source
-
code:
Allowed Values:
[ "RR", "RE", "CC", "CL", "DD", "RN", "RX" ]Reservation Status CodeExample:CC -
description:
string
Reservation status descriptionExample:
Expected
Nested Schema : shipOperationContact
Type:
Show Source
object-
code:
string
Ship Operation Contact CodeExample:
D1000 -
description:
string
Ship Operation Contact DescriptionExample:
Master
Nested Schema : profileLinkObject
Type:
objectProfile Link object
Show Source
-
href(required):
string
Example:
http://[HOSTNAME]/spms/v2/ships/11100777/profiles/crews/1 -
method(required):
string
Example:
get -
operationId(required):
string
Example:
getCrewProfile -
rel(required):
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":"+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",
"contactlessId":[
"1CA71546",
"DC650644"
]
}
},
{
"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",
"contactlessId":[
"1CA7154S",
"DC650645"
]
}
},
{
"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",
"contactlessId":[
"1CA71540",
"DC650640"
]
}
},
{
"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",
"contactlessId":[
"1CA71543",
"DC650643"
]
}
}
],
"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
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
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
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
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
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
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