Update a guest or resident profile by guest Id
put
/spms/v2/ships/{shipId}/profiles/guests/{profileId}
This is to update a new guest or resident profile details by guest Id
Request
Supported Media Types
- application/json
Path Parameters
-
profileId: integer
Profile Id
-
shipId: number
Ship Id
Guest Profile Object
Root Schema : Guest Profile Request
Type:
object
Title:
Guest Profile Request
Guest Profile Request Body
Show Source
-
accountCategory(optional):
string
Allowed Values:
[ "PAX" ]
accountCategoryExample:PAX
-
age(optional):
integer(int32)
Minimum Value:
1
Maximum Value:150
AgeExample:25
-
awardLevel(optional):
string
Award Level * `null` if emptyExample:
platinium
-
birthNation(optional):
string
Minimum Length:
1
Maximum Length:6
Birth Nation Code * `null` if emptyExample:US
-
birthPlace(optional):
string
Birth Place * `null` if emptyExample:
KL
-
classification(optional):
string
Classification * `null` if emptyExample:
CLASS I
-
contactDetails(optional):
object contactDetails
Contact Details
-
dateOfBirth(optional):
string(ISO 8601)
Date Of BirthExample:
2009-10-31
-
finNumber(optional):
number
FIN Number * `null` if emptyExample:
1234
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
First NameExample:Down
-
frequentNumber(optional):
number
Frequent Number * `null` if emptyExample:
1234
-
gender(optional):
string
GenderExample:
Male
-
intoxication(optional):
boolean
Is the guest intoxicated: * `true` - Intoxicated * `false` - Non-intoxicatedExample:
false
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
Last NameExample:Niel
-
maritalStatus(optional):
string
Marital Status CodeExample:
S
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
Middle Name * `null` if emptyExample:MB
-
nationalId(optional):
number
National Id * `null` if emptyExample:
1234
-
nationality(optional):
string
Country CodeExample:
US
-
otherFirstName(optional):
string
Minimum Length:
1
Maximum Length:80
Pattern:^[ a-zA-Z0-9_.??-??????-???]*$
Other First Name * `null` if emptyExample:null
-
otherLastName(optional):
string
Minimum Length:
1
Maximum Length:100
Pattern:^[ a-zA-Z0-9_.??-??????-???]*$
Other Last Name * `null` if emptyExample:null
-
passportDetails(optional):
object passportDetailsRequest
Passport Details
-
permanentResidentNumber(optional):
number
Permanent Resident Number * `null` if emptyExample:
1234
-
photo(optional):
string
PhotoExample:
/9j/4AAQSkZJRgABAQEASABIAAD==
-
preferredLanguage(optional):
string
Preferred Language CodeExample:
EN
-
profession(optional):
string
Profession * `null` if emptyExample:
Sales Executive
-
profileType(optional):
string
Allowed Values:
[ "Guest", "Resident" ]
Profile TypeExample:Resident
-
resident(optional):
boolean
Is the guest a resident: * `true` - resident * `false` - Not residentExample:
true
-
royaltyNumber(optional):
number
Royalty Number * `null` if emptyExample:
1234
-
salutation(optional):
string
Pattern:
^[a-zA-Z0-9.]*$
SalutationExample:Mr.
-
smoker(optional):
boolean
Is the guest a smoker: * `true` - Smoker * `false` - Non-smokerExample:
false
-
title(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Title * `null` if emptyExample:MR
-
VIP(optional):
string
VIP CodeExample:
S/VIP
Nested Schema : contactDetails
Type:
object
Contact Details
Show Source
-
alternativeNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:^[0-9+-]*$
Temporary Phone Number * `null` if emptyExample:4413563590
-
emailAddress(optional):
string
Minimum Length:
1
Maximum Length:49
Pattern:^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$
Email Address * `null` if emptyExample:abby@mail.com
-
emergencyContactMobileNumber(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^[0-9+-]*$
Emergency Contact Mobile Phone Number * `null` if emptyExample:0173443434
-
emergencyContactName(optional):
string
Minimum Length:
1
Maximum Length:40
Emergency Contact Name * `null` if emptyExample:Lanaya
-
emergencyContactPhoneNumber(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^[0-9+-]*$
Emergency Contact Phone Number * `null` if emptyExample:+6239629999
-
mobileNumber(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^[0-9]*$
Mobile Number * `null` if emptyExample:4413563590
Nested Schema : passportDetailsRequest
Type:
object
Passport Details
Show Source
-
passportExpiryDate(optional):
string(ISO 8601)
Passport Expiry DateExample:
2009-10-31
-
passportIssuedCountry(optional):
string
Country CodeExample:
US
-
passportIssuedDate(optional):
string(ISO 8601)
Passport Issued DateExample:
2009-10-31
-
passportIssuedPlace(optional):
string
Passport Issued PlaceExample:
Kuala Lumpur
-
passportNumber(optional):
string
Passport NumberExample:
ABC12345678
Response
Supported Media Types
- application/hal+json
200 Response
OK
Root Schema : Guest Profile
Type:
object
Title:
Guest Profile
Guest Profile Response
Show Source
-
_links(optional):
array _links
-
accountCategory(optional):
string
Allowed Values:
[ "PAX" ]
accountCategoryExample:PAX
-
age(optional):
integer(int32)
Minimum Value:
1
Maximum Value:150
AgeExample:25
-
awardLevel(optional):
string
Award Level * `null` if emptyExample:
platinium
-
birthNation(optional):
object birthNation
Birth Nation
-
birthPlace(optional):
string
Birth Place * `null` if emptyExample:
KL
-
classification(optional):
string
Classification * `null` if emptyExample:
CLASS I
-
contactDetails(optional):
object contactDetails
Contact Details
-
dateOfBirth(optional):
string(ISO 8601)
Date Of BirthExample:
2009-10-31
-
finNumber(optional):
number
FIN Number * `null` if emptyExample:
1234
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
First NameExample:Down
-
frequentNumber(optional):
number
Frequent Number * `null` if emptyExample:
1234
-
gender(optional):
string
GenderExample:
Male
-
guestId(optional):
integer
Minimum Value:
0
Guest IdExample:456789
-
intoxication(optional):
boolean
Is the guest intoxicated: * `true` - Intoxicated * `false` - Non-intoxicatedExample:
false
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
Last NameExample:Niel
-
maritalStatus(optional):
object maritalStatus
Marital Status
-
middleName(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
Middle Name * `null` if emptyExample:MB
-
nationalId(optional):
number
National Id * `null` if emptyExample:
1234
-
nationality(optional):
object nationality
Nationality
-
otherFirstName(optional):
string
Minimum Length:
1
Maximum Length:80
Pattern:^[ a-zA-Z0-9_.??-??????-???]*$
Other First Name * `null` if emptyExample:null
-
otherLastName(optional):
string
Minimum Length:
1
Maximum Length:100
Pattern:^[ a-zA-Z0-9_.??-??????-???]*$
Other Last Name * `null` if emptyExample:null
-
passportDetails(optional):
object passportDetailsResponse
Passport Details
-
permanentResidentNumber(optional):
number
Permanent Resident Number * `null` if emptyExample:
1234
-
photo(optional):
string
PhotoExample:
/9j/4AAQSkZJRgABAQEASABIAAD==
-
preferredLanguage(optional):
object preferredLanguage
Preferred Language
-
profession(optional):
string
Profession * `null` if emptyExample:
Sales Executive
-
profileType(optional):
string
Allowed Values:
[ "Guest", "Resident" ]
Profile TypeExample:Resident
-
resident(optional):
boolean
Is the guest a resident: * `true` - resident * `false` - Not residentExample:
true
-
royaltyNumber(optional):
number
Royalty Number * `null` if emptyExample:
1234
-
salutation(optional):
string
Pattern:
^[a-zA-Z0-9.]*$
SalutationExample:Mr.
-
smoker(optional):
boolean
Is the guest a smoker: * `true` - Smoker * `false` - Non-smokerExample:
false
-
title(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[ A-Za-z0-9,'_@./#&+-]*$
Title * `null` if emptyExample:MR
-
VIP(optional):
object VIP
VIP
Nested Schema : birthNation
Type:
object
Birth Nation
Show Source
-
code(optional):
string
Minimum Length:
1
Maximum Length:6
Birth Nation Code * `null` if emptyExample:US
-
description(optional):
string
Birth Nation Name * `null` if emptyExample:
United States
Nested Schema : contactDetails
Type:
object
Contact Details
Show Source
-
alternativeNumber(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:^[0-9+-]*$
Temporary Phone Number * `null` if emptyExample:4413563590
-
emailAddress(optional):
string
Minimum Length:
1
Maximum Length:49
Pattern:^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$
Email Address * `null` if emptyExample:abby@mail.com
-
emergencyContactMobileNumber(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^[0-9+-]*$
Emergency Contact Mobile Phone Number * `null` if emptyExample:0173443434
-
emergencyContactName(optional):
string
Minimum Length:
1
Maximum Length:40
Emergency Contact Name * `null` if emptyExample:Lanaya
-
emergencyContactPhoneNumber(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^[0-9+-]*$
Emergency Contact Phone Number * `null` if emptyExample:+6239629999
-
mobileNumber(optional):
string
Minimum Length:
1
Maximum Length:30
Pattern:^[0-9]*$
Mobile Number * `null` if emptyExample:4413563590
Nested Schema : maritalStatus
Type:
object
Marital Status
Show Source
-
code(optional):
string
Marital Status CodeExample:
S
-
description(optional):
string
Marital Status DescriptionExample:
Single
Nested Schema : nationality
Type:
object
Nationality
Show Source
-
code(optional):
string
Country CodeExample:
US
-
description(optional):
string
Country NameExample:
Malaysia
Nested Schema : passportDetailsResponse
Type:
object
Passport Details
Show Source
-
passportExpiryDate(optional):
string(ISO 8601)
Passport Expiry DateExample:
2009-10-31
-
passportIssuedCountry(optional):
object passportIssuedCountry
Passport Issued Country
-
passportIssuedDate(optional):
string(ISO 8601)
Passport Issued DateExample:
2009-10-31
-
passportIssuedPlace(optional):
string
Passport Issued PlaceExample:
Kuala Lumpur
-
passportNumber(optional):
string
Passport NumberExample:
ABC12345678
Nested Schema : preferredLanguage
Type:
object
Preferred Language
Show Source
-
code(optional):
string
Preferred Language CodeExample:
EN
-
description(optional):
string
Preferred Language DescriptionExample:
English
Nested Schema : VIP
Type:
object
VIP
Show Source
-
code(optional):
string
VIP CodeExample:
S/VIP
-
description(optional):
string
VIP DescriptionExample:
SUPERVIP
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/v2/ships/186000000117/profile/1001/addresses/home
-
operationId(optional):
string
Example:
getHomeAddress
Nested Schema : passportIssuedCountry
Type:
object
Passport Issued Country
Show Source
-
code(optional):
string
Country CodeExample:
US
-
description(optional):
string
Country NameExample:
Malaysia
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.1",
"title":"Bad Request",
"detail":"Malformed JSON request"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
Unauthorized
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
Forbidden
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 is forbidden"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
404 Response
Not Found
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.5",
"title":"Not Found",
"detail":"Profile ID - 1002 is invalid"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
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 Supported",
"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
410 Response
Gone
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.11",
"title":"Gone",
"detail":"Requested Resource no longer exists"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
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.16",
"title":"Invalid content",
"detail":"Content type not supported"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
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.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
501 Response
Not Implemented
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.5.2",
"title":"Not implemented",
"detail":"Resource is not implemented in this version of the API"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
503 Response
Service Unavailable
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.5.4",
"title":"Service Unavailable",
"detail":"Service not available"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source