NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Retrieve list of guests that are travelling with the selected guest
get
/spms/v1/reservations/{reservationId}/travellingWith/profileSearchTemplate/{templateId}
This is to retrieve a list of guests that are travelling with the selected guest
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
Returns a list of guests that are travelling with the selected guest
Root Schema : Oracle Response object
Type:
objectTitle:
Oracle Response objectThe object returned in Oracle Standard when function is executed successfully
Show Source
-
count(optional):
integer
Example:
18 -
hasMore(optional):
boolean
Example:
true -
items(optional):
array items
-
limit(optional):
integer
Example:
2 -
links(optional):
array links
-
offset(optional):
integer
Example:
0
Nested Schema : items
Type:
Show Source
array-
Array of:
object travellingWithContainer
travelling with container
Nested Schema : travellingWithContainer
Type:
objecttravelling with container
Show Source
-
item(optional):
object travellingWith
Travelling with the selected guest
-
links(optional):
links
Nested Schema : travellingWith
Type:
objectTravelling with the selected guest
Show Source
-
accountCategory(optional):
string
Minimum Length:
1Maximum Length:6Pattern:^SYS|GRP|CRW|PAX|VTO$Example:PAX -
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 -
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:+123456789 -
contactNum(optional):
string
Minimum Length:
1Maximum Length:30Pattern:^\+(?:[0-9] ?){6,14}[0-9]$Example:+123456789 -
countryOfBirth(optional):
string
Minimum Length:
1Maximum Length:3Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:IT -
countryOfResidence(optional):
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:IT -
dateOfBirth(optional):
string(date-time)
Example:
1961-04-01T16:00:00.000+0000 -
documentExpiryDate(optional):
string(date-time)
Example:
1961-04-01T16:00:00.000+0000 -
documentIssuedCountry(optional):
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:IT -
documentIssuedDate(optional):
string(date-time)
Example:
1961-04-01T16:00:00.000+0000 -
emailAddress(optional):
string(email)
Minimum Length:
1Maximum Length:50Example:email@oracle.com -
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:+123456789 -
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:John -
nationalIdNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
nationality(optional):
string
Minimum Length:
1Maximum Length:6Pattern:[a-z0-9]Example:IT -
passportNumber(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A1234567 -
photo(optional):
string
Example:
/Images/People/ -
reservationDetails(optional):
array reservationDetails
-
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 -
unicodeName(optional):
string
Minimum Length:
1Maximum Length:100Example:
Nested Schema : reservationDetails
Type:
Show Source
array-
Array of:
object reservationDetails
Reservation Details
Nested Schema : reservationDetails
Type:
objectReservation Details
Show Source
-
accountId(optional):
integer
Minimum Value:
1Example:1000001 -
actualDisembarkDate(optional):
string(date-time)
Example:
null -
actualEmbarkDate(optional):
string(date-time)
Example:
2015-09-02T16:00:00.000+0000 -
boardCardNumber(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:0123456789 -
cabinNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:10002 -
consentStatus(optional):
boolean
Example:
false -
disembarkDate(optional):
string(date-time)
Example:
2015-09-09T16:00:00.000+0000 -
disembarkPort(optional):
integer
Example:
123 -
embarkCruiseId(optional):
integer(int32)
Example:
10582 -
embarkDate(optional):
string(date-time)
Example:
2015-09-02T16:00:00.000+0000 -
embarkPort(optional):
integer
Example:
123 -
groupReferenceId(optional):
integer(int32)
Example:
1025868 -
onboardStatus(optional):
boolean
Example:
true -
reservationAccountReferenceId(optional):
integer(int32)
Example:
1000001 -
reservationAccountType(optional):
string
Minimum Length:
1Maximum Length:1Allowed Values:[ "P", "R", "C", "S", "V", "G", "A" ]Pattern:^P|R|C|S|V|G|A$Example:P -
reservationBookingNumber(optional):
string
Minimum Length:
1Maximum Length:100Pattern:[a-z0-9]Example:12345678 -
reservationCancelStatus(optional):
boolean
Example:
false -
reservationExternalId(optional):
string
Minimum Length:
1Maximum Length:50Pattern:[a-z0-9]Example:1001 -
reservationId(optional):
integer
Minimum Value:
0Example:900001 -
reservationStatus(optional):
string
Minimum Length:
2Maximum Length:2Allowed Values:[ "RR", "RX", "RE", "RN", "CC", "CL", "DD", "00" ]Example:CC -
routedAccountNumber(optional):
integer(int32)
Example:
1064904 -
setSailPass(optional):
string
Minimum Length:
1Maximum Length:30Pattern:[a-z0-9]Example:
Nested Schema : linksProfile
Type:
objectlinks detail
Show Source
-
method(optional):
string
Example:
get -
rel(optional):
string
Example:
self
Nested Schema : links-allOf[1]
Type:
Show Source
object-
href(optional):
string
Example:
https:/abc.com/spms/v1/reservations/900001 -
operationId(optional):
string
Example:
findByID
Nested Schema : items-allOf[1]
Type:
Show Source
object-
href(optional):
string
Example:
http://example.com/spms/v1/reservations/900001/travellingWith -
operationId(optional):
string
Example:
search
400 Response
The supplied parameter(s) is not valid
Root 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
401 Response
You are not authorized to use this API
Root 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 : 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
The selected guest does not exist
Root 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 : 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
415 Response
The media supplied is not supported
Root 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 occurred while processing this request
Root 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
502 Response
Bad Gateway
503 Response
Service not available