Retrieve a visitor profile
get
/spms/v1/visitor/{id}
This is to retrieve a visitor profile by using account id
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Retrieve Visitor information
Type:
objectTitle:
Retrieve Visitor informationRetrieve Visitor information
Show Source
-
item(optional):
object ProfileVisitorDTO
Profile Guest information that based on the Profile Configuration (Profile Setup)
-
links(optional):
array links
Nested Schema : ProfileVisitorDTO
Type:
objectProfile Guest information that based on the Profile Configuration (Profile Setup)
Show Source
-
accountId(optional):
integer
Minimum Value:
1Example:12345 -
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 -
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 -
age(optional):
integer(int32)
Minimum Value:
1Maximum Value:150Example:57 -
boardCardNumber(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:123456789 -
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 -
disembarkDate(optional):
string(date-time)
Example:
2015-09-09T16: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 -
embarkDate(optional):
string(date-time)
Example:
2015-09-02T16:00:00.000+0000 -
embarkPort(optional):
integer
Example:
123 -
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:12345 -
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 -
nationality(optional):
string
Minimum Length:
1Maximum Length:6Pattern:[a-z0-9]Example:US -
onboardStatus(optional):
boolean
Example:
true -
passportNum(optional):
string
Minimum Length:
1Maximum Length:20Pattern:[a-z0-9]Example:A01234567 -
photo(optional):
string
Example:
/Images/People/ -
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 -
reservationCancelStatus(optional):
boolean
Example:
false -
reservationId(optional):
integer
Minimum Value:
0Example:12345 -
reservationStatus(optional):
string
Minimum Length:
2Maximum Length:2Allowed Values:[ "RR", "RE", "CC", "CL" ]Example:CC -
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
Nested Schema : linksProfile
Type:
objectlinks 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:
http://example.com/spms/v1/guest/1000001 -
operationId(optional):
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":"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
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":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
"title":"Method Not Supported",
"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":"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