Retrieve guests profile by the selected reservation id
get
/spms/v1/reservations/{id}
This is to retrieve a guest profile by reservation id.
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : travellingWithContainer
Type:
objecttravelling with container
Show Source
-
item:
object reservationTravellingWith
Travelling with the selected guest
-
links:
array links
Nested Schema : reservationTravellingWith
Type:
objectTravelling with the selected guest
Show Source
-
accountCategory:
string
Minimum Length:
1Maximum Length:6Pattern:^SYS|GRP|CRW|PAX|VTO$Example:PAX -
accountType:
string
Allowed Values:
[ "A", "P", "C", "G", "V", "O" ]Pattern:^A|P|C|G|V|O$Example:System Account, Passenger, Crew, Group, Visitor -
age:
integer(int32)
Minimum Value:
1Maximum Value:150Example:57 -
alternativeContactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+(?:[0-9] ?){6,14}[0-9]$Example:+123456789 -
closed:
boolean
Example:
false -
contactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+(?:[0-9] ?){6,14}[0-9]$Example:+123456789 -
countryOfBirth:
string
Minimum Length:
1Maximum Length:3Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:IT -
countryOfResidence:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:IT -
dateOfBirth:
string(date-time)
Example:
1961-04-01T16:00:00.000+0000 -
department:
string
Pattern:
^[a-zA-Z0-9,.!? ]*$Example:oracle.doceng.json.BetterJsonNull@3c7279a5 -
documentChecked:
boolean
Example:
false -
documentExpiryDate:
string(date-time)
Example:
1961-04-01T16:00:00.000+0000 -
documentIssuedCountry:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:IT -
documentIssuedDate:
string(date-time)
Example:
1961-04-01T16:00:00.000+0000 -
documentType:
string
Minimum Length:
1Maximum Length:6Example:oracle.doceng.json.BetterJsonNull@79ecc507 -
earlyBoard:
integer(int32)
Minimum Value:
0Maximum Value:2Example:0 -
emailAddress:
string(email)
Minimum Length:
1Maximum Length:50Example:email@oracle.com -
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:+123456789 -
firstName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:John -
fullName:
string
Example:
Mr BRITISH MAN -
fullNameWithoutSalutation:
string
Pattern:
^[a-zA-Z0-9,.!? ]*$Example:BRITISH MAN -
gateType:
string
Minimum Length:
1Maximum Length:100Example:oracle.doceng.json.BetterJsonNull@7abeabe9 -
gender:
string
Minimum Length:
1Maximum Length:6Pattern:[A-Z]Example:M or F -
guestId:
integer
Minimum Value:
0Example:12345 -
language:
string
Minimum Length:
1Maximum Length:6Example:EN -
lastName:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:Smith -
lastPosting:
integer(int32)
Minimum Value:
0Maximum Value:9Example:0 -
manifest:
boolean
Example:
true -
middleName:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:John -
nationalIdNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
nationality:
string
Minimum Length:
1Maximum Length:6Pattern:[a-z0-9]Example:IT -
overnightTour:
integer(int32)
Minimum Value:
0Maximum Value:1Example:0 -
passportNumber:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A1234567 -
photo:
string
Example:
/Images/People/ -
posCredit:
number(double)
Minimum Value:
0Maximum Value:100000000000000Example:0 -
posDebit:
number(double)
Minimum Value:
0Example:0 -
posting:
boolean
Example:
false -
reservationDetails:
object reservationDetails
Reservation Details
-
salutation:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:MR -
security:
string
Pattern:
int32Example:oracle.doceng.json.BetterJsonNull@7a04f730 -
spas:
string
Pattern:
^[a-zA-Z0-9,.!? ]*$Example:oracle.doceng.json.BetterJsonNull@357f6391 -
systemAccountNumber:
string
Minimum Length:
0Maximum Length:99999999Pattern:^[a-zA-Z0-9,.!? ]*$Example:oracle.doceng.json.BetterJsonNull@7a31ca20 -
title:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Mr -
trafficDirection:
string
Minimum Length:
0Maximum Length:2Pattern:int32Example:oracle.doceng.json.BetterJsonNull@2fd39436 -
unicodeName:
string
Minimum Length:
1Maximum Length:100Example:
Nested Schema : reservationDetails
Type:
objectReservation Details
Show Source
-
accountId:
integer
Minimum Value:
1Example:1000001 -
actualDisembarkDate:
string(date-time)
Example:
1961-04-01T16:00:00.000+0000 -
actualEmbarkDate:
string(date-time)
Example:
2015-09-02T16:00:00.000+0000 -
actualEmbarkPCDate:
string(date-time)
Example:
2015-09-02 -
boardCardNumber:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:0123456789 -
cabinNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:10002 -
checkedDocuments:
string
Minimum Length:
0Maximum Length:1Pattern:^[Y|N]$Example:oracle.doceng.json.BetterJsonNull@21f7e537 -
collectedDocuments:
string
Minimum Length:
0Maximum Length:1Pattern:^[Y|N]$Example:oracle.doceng.json.BetterJsonNull@58f254b1 -
consentStatus:
boolean
Example:
false -
disembarkDate:
string(date-time)
Example:
2015-09-09T16:00:00.000+0000 -
disembarkPort:
integer
Example:
123 -
embarkCruiseId:
integer(int32)
Example:
10582 -
embarkDate:
string(date-time)
Example:
2015-09-02T16:00:00.000+0000 -
embarkPort:
integer
Example:
123 -
genenicDenyReason:
string
Minimum Length:
0Pattern:^[a-zA-Z0-9,.!? ]*$Example:oracle.doceng.json.BetterJsonNull@320be73 -
genericDenyBoarding:
string
Maximum Length:
1Pattern:^[Y|N]$Example:oracle.doceng.json.BetterJsonNull@4aed311e -
groupReferenceId:
integer(int32)
Example:
1025868 -
onboardStatus:
boolean
Example:
true -
overnightTour:
string
Minimum Length:
0Maximum Length:1Pattern:int32Example:0 -
paymentMethod:
string
Maximum Length:
1Pattern:^[0|1]$Example:0 -
registrationComplete:
boolean
Example:
false -
reservationAccountReferenceId:
integer(int32)
Example:
1000001 -
reservationAccountType:
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:
string
Minimum Length:
1Maximum Length:100Pattern:[a-z0-9]Example:12345678 -
reservationCancelStatus:
boolean
Example:
false -
reservationClassification:
string
Minimum Length:
0Example:oracle.doceng.json.BetterJsonNull@6897a4a -
reservationExternalId:
string
Minimum Length:
1Maximum Length:50Pattern:[a-z0-9]Example:1001 -
reservationId:
integer
Minimum Value:
0Example:900001 -
reservationStatus:
string
Minimum Length:
2Maximum Length:2Allowed Values:[ "RR", "RX", "RE", "RN", "CC", "CL", "DD", "00" ]Example:CC -
residentOwner:
boolean
Example:
false -
resStation:
string
Minimum Length:
0Maximum Length:6Pattern:^[a-zA-Z0-9- ]*$Example:oracle.doceng.json.BetterJsonNull@7c950b3b -
routedAccountNumber:
integer(int32)
Example:
1064904 -
setSailPass:
string
Minimum Length:
1Maximum Length:30Pattern:[a-z0-9]Example: -
shordId:
string
Minimum Length:
1Maximum Length:60Pattern:^[a-zA-Z0-9]*$Example:oracle.doceng.json.BetterJsonNull@6424e613 -
specialNeedCode:
string
Minimum Length:
0Maximum Length:50Pattern:^[a-zA-Z0-9,.!?]*$Example:oracle.doceng.json.BetterJsonNull@e62319f -
specialNeedRemark:
string
Minimum Length:
0Maximum Length:500Example: -
systemRandomNumber:
integer(int32)
Example:
16193551
Nested Schema : linksProfile
Type:
objectlinks detail
Show Source
-
method:
string
Example:
get -
rel:
string
Example:
self
Nested Schema : items-allOf[1]
Type:
Show Source
object-
href:
string
Example:
https:/abc.com/spms/v1/reservations/900001 -
operationId:
string
Example:
findByID
401 Response
Unauthorized
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":"Unauthorised",
"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
Forbidden
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
405 Response
Method Not Allowed
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 Allowed",
"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
Internal Server Error
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.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 Unavailable
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 Unavailable. Try again later"
}Nested Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source