Update guest profile details
post
/spms/v1/guest/infoUpdate
This is to update a guest profile details
Request
Supported Media Types
- application/json
Profile Details
Root Schema : ProfileDetails
Type:
object
Profile Details
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:+0123456789
-
classification(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:[VIP]
-
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
-
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:US
-
documentIssuedDate(optional):
string(date-time)
Example:
1961-04-01T16: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
-
emergencyContactName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
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-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
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:1000001
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
Example:LAST NAME
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
Example:MIDDLE NAME
-
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:US
-
passportNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A012345678
-
photo(optional):
string
Example:
/Images/People/
-
reservationDetails(optional):
array reservationDetails
-
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
-
unicodeName(optional):
string
Minimum Length:
1
Maximum Length:100
Example:
Nested Schema : reservationDetails
Type:
Show Source
array
-
Array of:
object ReservationDetails
Reservation Details
Nested Schema : ReservationDetails
Type:
object
Reservation Details
Show Source
-
accountId(optional):
integer
Minimum Value:
1
Example: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:
0
Maximum Length:6
Pattern:[a-z0-9]
Example:12345
-
assemblyStationName(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:[a-z0-9]
Example:12345
-
boardCardNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:123456789
-
cabinNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[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:
1
Maximum Length:1
Allowed 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:
1
Maximum Length:100
Pattern:[a-z0-9]
Example:0123456789
-
reservationCancelStatus(optional):
boolean
Example:
false
-
reservationExternalId(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:[a-z0-9]
Example:12345
-
reservationId(optional):
integer
Minimum Value:
0
Example:12345
-
reservationStatus(optional):
string
Minimum Length:
2
Maximum Length:2
Allowed Values:[ "RR", "RX", "RE", "RN", "CC", "CL", "DD", "00" ]
Example:CC
-
routedAccountNumber(optional):
integer(int32)
Example:
12345
-
setSailPass(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:[a-z0-9]
Example:12345
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Profile Search
Type:
object
Title:
Profile Search
Profile Search
Show Source
-
item(optional):
object ProfileDetails
Profile Details
-
links(optional):
array links
Nested Schema : ProfileDetails
Type:
object
Profile Details
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:+0123456789
-
classification(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:[VIP]
-
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
-
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:US
-
documentIssuedDate(optional):
string(date-time)
Example:
1961-04-01T16: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
-
emergencyContactName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
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-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
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:1000001
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
Example:LAST NAME
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
Example:MIDDLE NAME
-
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:US
-
passportNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:A012345678
-
photo(optional):
string
Example:
/Images/People/
-
reservationDetails(optional):
array reservationDetails
-
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
-
unicodeName(optional):
string
Minimum Length:
1
Maximum Length:100
Example:
Nested Schema : reservationDetails
Type:
Show Source
array
-
Array of:
object ReservationDetails
Reservation Details
Nested Schema : ReservationDetails
Type:
object
Reservation Details
Show Source
-
accountId(optional):
integer
Minimum Value:
1
Example: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:
0
Maximum Length:6
Pattern:[a-z0-9]
Example:12345
-
assemblyStationName(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:[a-z0-9]
Example:12345
-
boardCardNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[a-z0-9]
Example:123456789
-
cabinNum(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:[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:
1
Maximum Length:1
Allowed 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:
1
Maximum Length:100
Pattern:[a-z0-9]
Example:0123456789
-
reservationCancelStatus(optional):
boolean
Example:
false
-
reservationExternalId(optional):
string
Minimum Length:
1
Maximum Length:50
Pattern:[a-z0-9]
Example:12345
-
reservationId(optional):
integer
Minimum Value:
0
Example:12345
-
reservationStatus(optional):
string
Minimum Length:
2
Maximum Length:2
Allowed Values:[ "RR", "RX", "RE", "RN", "CC", "CL", "DD", "00" ]
Example:CC
-
routedAccountNumber(optional):
integer(int32)
Example:
12345
-
setSailPass(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:[a-z0-9]
Example:12345
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://[HOSTNAME]/spms/v1/guest/1000001
-
operationId(optional):
string
Example:
findByID
400 Response
Bad Request
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":"Bad Request",
"detail":"Empty request body."
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error 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 Response
Error 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:
object
Title:
Error Response
Error 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 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
This method is not available
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
415 Response
The media supplied is not supported
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error 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:
object
Title:
Error Response
Error 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 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 not available
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.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