NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Retrieve guests profile with criteria search
get
/spms/v1/guest
This is to retrieve guests profile with criteria search using keyword. When the keyword is not defined in the search criteria, all profile records will be return. Otherwise only specific profile records will be listed based on the defined search criteria.
Request
Supported Media Types
- application/json
Query Parameters
-
limit: integer(int32)
Paging limit
-
offset: integer(int32)
Paging offset
-
orderBy: string
-
profileSearchTemplate: integer(int32)
profile search template id
-
q: string
keyword(first name, last name, cabin number, booking number, passport number)
Response
Supported Media Types
- application/json
200 Response
Return a list of profile details
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 : ReturnSearchData
Type:
objectdata return
Show Source
-
item(optional):
object ProfileDetails
Profile Details
-
links(optional):
links
Nested Schema : ProfileDetails
Type:
objectProfile Details
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:+0123456789 -
classification(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:[VIP] -
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-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:US -
documentIssuedDate(optional):
string(date-time)
Example:
1961-04-01T16:00:00.000+0000 -
emailAddress(optional):
string
Minimum Length:
1Maximum Length:50Pattern:^([a-zA-Z0-9_\\-\\.]+)@([a-zA-Z0-9_\\-\\.]+)\\.([a-zA-Z]{2,5})$Example:EMAIL ADD -
emergencyContactName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:NAME or FIRST NAME / SURNAME -
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:FIRST NAME -
gender(optional):
string
Minimum Length:
1Maximum Length:6Pattern:[A-Z]Example:M or F -
guestId(optional):
integer
Minimum Value:
0Example:1000001 -
lastName(optional):
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:LAST NAME -
middleName(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:MIDDLE NAME -
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:US -
passportNumber(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A012345678 -
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 or 2015-09-09T16:00:00.000+0000 -
actualEmbarkDate(optional):
string(date-time)
Example:
2015-09-02T16:00:00.000+0000 -
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:12345 -
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:
12345 -
embarkDate(optional):
string(date-time)
Example:
2015-09-02T16:00:00.000+0000 -
embarkPort(optional):
integer
Example:
123 -
groupReferenceId(optional):
integer(int32)
Example:
12345 -
onboardStatus(optional):
boolean
Example:
true -
reservationAccountReferenceId(optional):
integer(int32)
Example:
12345 -
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 for Pax -
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", "RX", "RE", "RN", "CC", "CL", "DD", "00" ]Example:CC -
routedAccountNumber(optional):
integer(int32)
Example:
12345 -
setSailPass(optional):
string
Minimum Length:
1Maximum Length:30Pattern:[a-z0-9]Example:12345
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:
http://[HOSTNAME]/spms/v1/guest/1000001 -
operationId(optional):
string
Example:
findByID
Nested Schema : items-allOf[1]
Type:
Show Source
object-
href(optional):
string
Example:
http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber -
operationId(optional):
string
Example:
search
403 Response
This API is not allowed for the current user
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