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:
object
travelling with container
Show Source
-
item(optional):
object reservationTravellingWith
Travelling with the selected guest
-
links(optional):
array links
Nested Schema : reservationTravellingWith
Type:
object
Travelling with the selected guest
Show Source
-
accountCategory(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^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:
1
Maximum Value:150
Example:57
-
alternativeContactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+(?:[0-9] ?){6,14}[0-9]$
Example:+123456789
-
closed(optional):
boolean
Example:
false
-
contactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+(?:[0-9] ?){6,14}[0-9]$
Example:+123456789
-
countryOfBirth(optional):
string
Minimum Length:
1
Maximum Length:3
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:IT
-
countryOfResidence(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:IT
-
dateOfBirth(optional):
string(date-time)
Example:
1961-04-01T16:00:00.000+0000
-
department(optional):
string
Pattern:
^[a-zA-Z0-9,.!? ]*$
Example:oracle.doceng.json.BetterJsonNull@25e07162
-
documentChecked(optional):
boolean
Example:
false
-
documentExpiryDate(optional):
string(date-time)
Example:
1961-04-01T16:00:00.000+0000
-
documentIssuedCountry(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:IT
-
documentIssuedDate(optional):
string(date-time)
Example:
1961-04-01T16:00:00.000+0000
-
documentType(optional):
string
Minimum Length:
1
Maximum Length:6
Example:oracle.doceng.json.BetterJsonNull@1d24c0f4
-
earlyBoard(optional):
integer(int32)
Minimum Value:
0
Maximum Value:2
Example:0
-
emailAddress(optional):
string(email)
Minimum Length:
1
Maximum Length:50
Example:email@oracle.com
-
emergencyContactName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:John
-
emergencyContactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+(?:[0-9] ?){6,14}[0-9]$
Example:+123456789
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:John
-
fullName(optional):
string
Example:
Mr BRITISH MAN
-
fullNameWithoutSalutation(optional):
string
Pattern:
^[a-zA-Z0-9,.!? ]*$
Example:BRITISH MAN
-
gateType(optional):
string
Minimum Length:
1
Maximum Length:100
Example:oracle.doceng.json.BetterJsonNull@4cf11591
-
gender(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[A-Z]
Example:M or F
-
guestId(optional):
integer
Minimum Value:
0
Example:12345
-
language(optional):
string
Minimum Length:
1
Maximum Length:6
Example:EN
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:Smith
-
lastPosting(optional):
integer(int32)
Minimum Value:
0
Maximum Value:9
Example:0
-
manifest(optional):
boolean
Example:
true
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:John
-
nationalIdNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A01234567
-
nationality(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[a-z0-9]
Example:IT
-
overnightTour(optional):
integer(int32)
Minimum Value:
0
Maximum Value:1
Example:0
-
passportNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A1234567
-
photo(optional):
string
Example:
/Images/People/
-
posCredit(optional):
number(double)
Minimum Value:
0
Maximum Value:1.0E14
Example:0
-
posDebit(optional):
number(double)
Minimum Value:
0
Example:0
-
posting(optional):
boolean
Example:
false
-
reservationDetails(optional):
object reservationDetails
Reservation Details
-
salutation(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:MR
-
security(optional):
string
Pattern:
int32
Example:oracle.doceng.json.BetterJsonNull@4fb4bccf
-
spas(optional):
string
Pattern:
^[a-zA-Z0-9,.!? ]*$
Example:oracle.doceng.json.BetterJsonNull@2fe9bb49
-
systemAccountNumber(optional):
string
Minimum Length:
0
Maximum Length:99999999
Pattern:^[a-zA-Z0-9,.!? ]*$
Example:oracle.doceng.json.BetterJsonNull@26ff428
-
title(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:Mr
-
trafficDirection(optional):
string
Minimum Length:
0
Maximum Length:2
Pattern:int32
Example:oracle.doceng.json.BetterJsonNull@73cae081
-
unicodeName(optional):
string
Minimum Length:
1
Maximum Length:100
Example:
Nested Schema : reservationDetails
Type:
object
Reservation Details
Show Source
-
accountId(optional):
integer
Minimum Value:
1
Example:1000001
-
actualDisembarkDate(optional):
string(date-time)
Example:
1961-04-01T16:00:00.000+0000
-
actualEmbarkDate(optional):
string(date-time)
Example:
2015-09-02T16:00:00.000+0000
-
actualEmbarkPCDate(optional):
string(date-time)
Example:
2015-09-02
-
boardCardNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:0123456789
-
cabinNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:10002
-
checkedDocuments(optional):
string
Minimum Length:
0
Maximum Length:1
Pattern:^[Y|N]$
Example:oracle.doceng.json.BetterJsonNull@66452ea7
-
collectedDocuments(optional):
string
Minimum Length:
0
Maximum Length:1
Pattern:^[Y|N]$
Example:oracle.doceng.json.BetterJsonNull@73171817
-
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
-
genenicDenyReason(optional):
string
Minimum Length:
0
Pattern:^[a-zA-Z0-9,.!? ]*$
Example:oracle.doceng.json.BetterJsonNull@3453ee38
-
genericDenyBoarding(optional):
string
Maximum Length:
1
Pattern:^[Y|N]$
Example:oracle.doceng.json.BetterJsonNull@17e7f4a0
-
groupReferenceId(optional):
integer(int32)
Example:
1025868
-
onboardStatus(optional):
boolean
Example:
true
-
overnightTour(optional):
string
Minimum Length:
0
Maximum Length:1
Pattern:int32
Example:0
-
paymentMethod(optional):
string
Maximum Length:
1
Pattern:^[0|1]$
Example:0
-
registrationComplete(optional):
boolean
Example:
false
-
reservationAccountReferenceId(optional):
integer(int32)
Example:
1000001
-
reservationAccountType(optional):
string
Minimum Length:
1
Maximum Length:1
Allowed Values:[ "P", "R", "C", "S", "V", "G", "A" ]
Pattern:^P|R|C|S|V|G|A$
Example:P
-
reservationBookingNumber(optional):
string
Minimum Length:
1
Maximum Length:100
Pattern:[a-z0-9]
Example:12345678
-
reservationCancelStatus(optional):
boolean
Example:
false
-
reservationClassification(optional):
string
Minimum Length:
0
Example:oracle.doceng.json.BetterJsonNull@2bca0115
-
reservationExternalId(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:[a-z0-9]
Example:1001
-
reservationId(optional):
integer
Minimum Value:
0
Example:900001
-
reservationStatus(optional):
string
Minimum Length:
2
Maximum Length:2
Allowed Values:[ "RR", "RX", "RE", "RN", "CC", "CL", "DD", "00" ]
Example:CC
-
residentOwner(optional):
boolean
Example:
false
-
resStation(optional):
string
Minimum Length:
0
Maximum Length:6
Pattern:^[a-zA-Z0-9- ]*$
Example:oracle.doceng.json.BetterJsonNull@2ff524eb
-
routedAccountNumber(optional):
integer(int32)
Example:
1064904
-
setSailPass(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:[a-z0-9]
Example: -
shordId(optional):
string
Minimum Length:
1
Maximum Length:60
Pattern:^[a-zA-Z0-9]*$
Example:oracle.doceng.json.BetterJsonNull@3760fc6a
-
specialNeedCode(optional):
string
Minimum Length:
0
Maximum Length:50
Pattern:^[a-zA-Z0-9,.!?]*$
Example:oracle.doceng.json.BetterJsonNull@54546cfe
-
specialNeedRemark(optional):
string
Minimum Length:
0
Maximum Length:500
Example: -
systemRandomNumber(optional):
integer(int32)
Example:
16193551
Nested Schema : linksProfile
Type:
object
links detail
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:
https:/abc.com/spms/v1/reservations/900001
-
operationId(optional):
string
Example:
findByID
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error 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:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error 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:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error 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:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error 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:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error 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:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error 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:
object
Title:
Error Response
Error Response returned when encountered error
Show Source