NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
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
Return profile details for the visitor id
Root Schema : Oracle Response returned in singular object
Type:
object
Title:
Oracle Response returned in singular object
The object returned in Oracle Standard when function is executed successfully
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:
object
Profile Guest information that based on the Profile Configuration (Profile Setup)
Show Source
-
accountId(optional):
integer
Minimum Value:
1
Example: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:
1
Maximum Value:150
Example:57
-
boardCardNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:123456789
-
contactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
countryOfBirth(optional):
string
Minimum Length:
1
Maximum Length:3
Pattern:^[ A-Za-z0-9_@./#&+-]*$
Example:US
-
countryOfResidence(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[ 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:
1
Maximum Length:50
Pattern:^([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:
1
Maximum Length:40
Pattern:[a-z]
Example:NAME or FIRST NAME / SURNAME
-
emergencyContactNum(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^\+?(?:[0-9] ?){6,14}[0-9]$
Example:+0123456789
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:FIRST NAME
-
gender(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[A-Z]
Example:M or F
-
guestId(optional):
integer
Minimum Value:
0
Example:12345
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:LAST NAME
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:MIDDLE NAME
-
nationality(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:[a-z0-9]
Example:US
-
onboardStatus(optional):
boolean
Example:
true
-
passportNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A01234567
-
photo(optional):
string
Example:
/Images/People/
-
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
-
reservationCancelStatus(optional):
boolean
Example:
false
-
reservationId(optional):
integer
Minimum Value:
0
Example:12345
-
reservationStatus(optional):
string
Minimum Length:
2
Maximum Length:2
Allowed Values:[ "RR", "RE", "CC", "CL" ]
Example:CC
-
salutation(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:[a-z]
Example:MR
-
title(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:Mr
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:
http://example.com/spms/v1/guest/1000001
-
operationId(optional):
string
Example:
findByID
403 Response
This API is not allowed for the current user
Root Schema : Error Response
Type:
object
Title:
Error Response
Error 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:
object
Title:
Error Response
Error 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