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(required): 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
OK
Root Schema : List of profile search result
Type:
objectTitle:
List of profile search resultList of profile search result
Show Source
-
count:
integer
Example:
18 -
hasMore:
boolean
Example:
true -
items:
array items
-
limit:
integer
Example:
2 -
links:
array links
-
offset:
integer
Example:
0
Nested Schema : VisitorReturnSearchData
Type:
objectdata return
Show Source
-
item:
object VisitorProfileDetails
Profile Details
-
links:
links
Nested Schema : VisitorProfileDetails
Type:
objectProfile Details
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:+0123456789 -
classification:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:[VIP] -
contactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
countryOfBirth:
string
Minimum Length:
1Maximum Length:3Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
countryOfResidence:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
dateOfBirth:
string(date-time)
Example:
1961-04-01T16:00:00.000+0000 -
documentExpiryDate:
string(date-time)
Example:
1961-04-01T16:00:00.000+0000 -
documentIssuedCountry:
string
Minimum Length:
1Maximum Length:6Pattern:^[ A-Za-z0-9_@./#&+-]*$Example:US -
documentIssuedDate:
string(date-time)
Example:
1961-04-01T16:00:00.000+0000 -
emailAddress:
string
Minimum Length:
1Maximum Length:50Pattern:'^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$'Example:EMAIL ADD -
emergencyContactName:
string
Minimum Length:
1Maximum Length:40Pattern:^[a-zA-ZÀ-ÖØ-öø--9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Example:NAME or FIRST NAME / SURNAME -
emergencyContactNum:
string
Minimum Length:
1Maximum Length:30Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$Example:+0123456789 -
firstName:
string
Minimum Length:
1Maximum Length:40Pattern:^[a-zA-ZÀ-ÖØ-öø--9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Example:FIRST NAME -
gender:
string
Minimum Length:
1Maximum Length:6Pattern:[A-Z]Example:M or F -
guestId:
integer
Minimum Value:
0Example:1000001 -
lastName:
string
Minimum Length:
1Maximum Length:40Pattern:^[a-zA-ZÀ-ÖØ-öø--9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Example:LAST NAME -
middleName:
string
Minimum Length:
1Maximum Length:20Pattern:^[a-zA-ZÀ-ÖØ-öø--9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$Example:MIDDLE NAME -
nationalIdNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
nationality:
string
Minimum Length:
1Maximum Length:6Pattern:[a-z0-9]Example:US -
passportNumber:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A012345678 -
photo:
string
Example:
/Images/People/ -
reservationDetails:
array reservationDetails
-
salutation:
string
Minimum Length:
1Maximum Length:40Pattern:[a-z]Example:MR -
title:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:Mr -
unicodeName:
string
Minimum Length:
1Maximum Length:100Example:
Nested Schema : reservationDetails
Type:
Show Source
array-
Array of:
object VisitorReservationDetails
Reservation Details
Nested Schema : VisitorReservationDetails
Type:
objectReservation Details
Show Source
-
accountId:
integer
Minimum Value:
1Example:1000001 -
actualDisembarkDate:
string(date-time)
Example:
null or 2015-09-09T16:00:00.000+0000 -
actualEmbarkDate:
string(date-time)
Example:
2015-09-02T16:00:00.000+0000 -
assemblyStationCode:
string
Minimum Length:
0Maximum Length:6Pattern:[a-z0-9]Example:12345 -
assemblyStationName:
string
Minimum Length:
1Maximum Length:50Pattern:[a-z0-9]Example:12345 -
boardCardNumber:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
cabinNum:
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:12345 -
consentStatus:
boolean
Example:
false -
disembarkDate:
string(date-time)
Example:
2015-09-09T16:00:00.000+0000 -
disembarkPort:
integer
Example:
123 -
embarkCruiseId:
integer(int32)
Example:
12345 -
embarkDate:
string(date-time)
Example:
2015-09-02T16:00:00.000+0000 -
embarkPort:
integer
Example:
123 -
groupReferenceId:
integer(int32)
Example:
12345 -
onboardStatus:
boolean
Example:
true -
reservationAccountReferenceId:
integer(int32)
Example:
12345 -
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 for Pax -
reservationBookingNumber:
string
Minimum Length:
1Maximum Length:100Pattern:[a-z0-9]Example:0123456789 -
reservationCancelStatus:
boolean
Example:
false -
reservationExternalId:
string
Minimum Length:
1Maximum Length:50Pattern:[a-z0-9]Example:12345 -
reservationId:
integer
Minimum Value:
0Example:12345 -
reservationStatus:
string
Minimum Length:
2Maximum Length:2Allowed Values:[ "RR", "RX", "RE", "RN", "CC", "CL", "DD", "00" ]Example:CC -
routedAccountNumber:
integer(int32)
Example:
12345 -
setSailPass:
string
Minimum Length:
1Maximum Length:30Pattern:[a-z0-9]Example:12345
Nested Schema : linksProfile
Type:
objectlinks detail
Show Source
-
method:
string
Example:
get -
rel:
string
Example:
self
Nested Schema : links-allOf[1]
Type:
Show Source
object-
href:
string
Example:
http://[HOSTNAME]/spms/v1/guest/1000001 -
operationId:
string
Example:
findByID
Nested Schema : items-allOf[1]
Type:
Show Source
object-
href:
string
Example:
http://[HOSTNAME]/spms/v1/guest?q=john&offset=0&limit=2&orderBy=passportNumber -
operationId:
string
Example:
search
400 Response
Bad 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.4.2",
"title":"Bad Request",
"detail":"Empty request body."
}Nested Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
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
Not Found
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError Response returned when encountered error
Example:
{
"title":"Not Found",
"detail":"Profile configuration does not exist",
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
}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 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
415 Response
The media supplied is not supported
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError Response returned when encountered error
Example:
{
"title":"Invalid content",
"detail":"Content type not supported",
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16"
}Nested Schema : Error Response
Type:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
500 Response
Error occurred while processing this request
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 not available
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.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