Retrieve list of predefined profile fields
get
/spms/v1/profiles
This is to retrieve list of predefined profile fields
Request
Supported Media Types
- application/json
Query Parameters
-
boardCardNumber: string
keyword(name)
-
firstName: string
keyword(name)
-
lastName: string
keyword(name)
-
manningNumber: string
keyword(name)
-
middleName: string
keyword(name)
-
otherTravelDocumentNumber: string
keyword(name)
-
passportNum: string
keyword(name)
-
reservationBookingNumber: string
keyword(name)
-
stateroom: string
keyword(name)
Response
Supported Media Types
- application/json
200 Response
Returns status
Root Schema : schema
Match All
Show Source
-
object
Profile Search Result
Title:
Profile Search Result
Profile Search Result
Nested Schema : Profile Search Result
Type:
object
Title:
Profile Search Result
Profile Search Result
Show Source
Nested Schema : Profile
Type:
object
links detail
Show Source
-
accountCategory(optional):
string
-
accountId(optional):
string
-
accountType(optional):
string
-
actualDisembarkDate(optional):
string
-
actualEmbarkDate(optional):
string
-
age(optional):
string
-
alternativeContactNum(optional):
string
-
assemblyStationCode(optional):
string
-
assemblyStationName(optional):
string
-
boardCardNumber(optional):
string
-
cabinNum(optional):
string
-
classification(optional):
string
-
consentStatus(optional):
string
-
contactNum(optional):
string
-
countryOfBirth(optional):
string
-
countryOfResidence(optional):
string
-
dateOfBirth(optional):
string
-
disembarkDate(optional):
string
-
disembarkPort(optional):
string
-
documentExpiryDate(optional):
string
-
documentIssuedCountry(optional):
string
-
documentIssuedDate(optional):
string
-
emailAddress(optional):
string
-
embarkCruiseId(optional):
string
-
embarkDate(optional):
string
-
embarkPort(optional):
string
-
emergencyContactName(optional):
string
-
emergencyContactNum(optional):
string
-
firstName(optional):
string
-
gender(optional):
string
-
groupReferenceId(optional):
string
-
guestId(optional):
string
-
lastName(optional):
string
-
middleName(optional):
string
-
nationalIdNum(optional):
string
-
nationality(optional):
string
-
onboardStatus(optional):
string
-
operationalDepartment(optional):
string
-
operationalPosition(optional):
string
-
passportNum(optional):
string
-
photo(optional):
string
-
reservationAccountReferenceId(optional):
string
-
reservationAccountType(optional):
string
-
reservationBookingNumber(optional):
string
-
reservationCancelStatus(optional):
string
-
reservationExternalId(optional):
string
-
reservationId(optional):
string
-
reservationStatus(optional):
string
-
routedAccountNumber(optional):
string
-
salutation(optional):
string
-
setSailPass(optional):
string
-
title(optional):
string
-
unicodeName(optional):
string
-
visitorPassType(optional):
string
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":"You are forbidden to use this API"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
accountCategory(optional):
string
-
accountId(optional):
string
-
accountType(optional):
string
-
actualDisembarkDate(optional):
string
-
actualEmbarkDate(optional):
string
-
age(optional):
string
-
alternativeContactNum(optional):
string
-
assemblyStationCode(optional):
string
-
assemblyStationName(optional):
string
-
boardCardNumber(optional):
string
-
cabinNum(optional):
string
-
classification(optional):
string
-
consentStatus(optional):
string
-
contactNum(optional):
string
-
countryOfBirth(optional):
string
-
countryOfResidence(optional):
string
-
dateOfBirth(optional):
string
-
disembarkDate(optional):
string
-
disembarkPort(optional):
string
-
documentExpiryDate(optional):
string
-
documentIssuedCountry(optional):
string
-
documentIssuedDate(optional):
string
-
emailAddress(optional):
string
-
embarkCruiseId(optional):
string
-
embarkDate(optional):
string
-
embarkPort(optional):
string
-
emergencyContactName(optional):
string
-
emergencyContactNum(optional):
string
-
firstName(optional):
string
-
gender(optional):
string
-
groupReferenceId(optional):
string
-
guestId(optional):
string
-
lastName(optional):
string
-
middleName(optional):
string
-
nationalIdNum(optional):
string
-
nationality(optional):
string
-
onboardStatus(optional):
string
-
operationalDepartment(optional):
string
-
operationalPosition(optional):
string
-
passportNum(optional):
string
-
photo(optional):
string
-
reservationAccountReferenceId(optional):
string
-
reservationAccountType(optional):
string
-
reservationBookingNumber(optional):
string
-
reservationCancelStatus(optional):
string
-
reservationExternalId(optional):
string
-
reservationId(optional):
string
-
reservationStatus(optional):
string
-
routedAccountNumber(optional):
string
-
salutation(optional):
string
-
setSailPass(optional):
string
-
title(optional):
string
-
unicodeName(optional):
string
-
visitorPassType(optional):
string
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":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
"title":"Internal Server Error",
"detail":"Error occured while processing this request"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
accountCategory(optional):
string
-
accountId(optional):
string
-
accountType(optional):
string
-
actualDisembarkDate(optional):
string
-
actualEmbarkDate(optional):
string
-
age(optional):
string
-
alternativeContactNum(optional):
string
-
assemblyStationCode(optional):
string
-
assemblyStationName(optional):
string
-
boardCardNumber(optional):
string
-
cabinNum(optional):
string
-
classification(optional):
string
-
consentStatus(optional):
string
-
contactNum(optional):
string
-
countryOfBirth(optional):
string
-
countryOfResidence(optional):
string
-
dateOfBirth(optional):
string
-
disembarkDate(optional):
string
-
disembarkPort(optional):
string
-
documentExpiryDate(optional):
string
-
documentIssuedCountry(optional):
string
-
documentIssuedDate(optional):
string
-
emailAddress(optional):
string
-
embarkCruiseId(optional):
string
-
embarkDate(optional):
string
-
embarkPort(optional):
string
-
emergencyContactName(optional):
string
-
emergencyContactNum(optional):
string
-
firstName(optional):
string
-
gender(optional):
string
-
groupReferenceId(optional):
string
-
guestId(optional):
string
-
lastName(optional):
string
-
middleName(optional):
string
-
nationalIdNum(optional):
string
-
nationality(optional):
string
-
onboardStatus(optional):
string
-
operationalDepartment(optional):
string
-
operationalPosition(optional):
string
-
passportNum(optional):
string
-
photo(optional):
string
-
reservationAccountReferenceId(optional):
string
-
reservationAccountType(optional):
string
-
reservationBookingNumber(optional):
string
-
reservationCancelStatus(optional):
string
-
reservationExternalId(optional):
string
-
reservationId(optional):
string
-
reservationStatus(optional):
string
-
routedAccountNumber(optional):
string
-
salutation(optional):
string
-
setSailPass(optional):
string
-
title(optional):
string
-
unicodeName(optional):
string
-
visitorPassType(optional):
string
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":"https://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
-
accountCategory(optional):
string
-
accountId(optional):
string
-
accountType(optional):
string
-
actualDisembarkDate(optional):
string
-
actualEmbarkDate(optional):
string
-
age(optional):
string
-
alternativeContactNum(optional):
string
-
assemblyStationCode(optional):
string
-
assemblyStationName(optional):
string
-
boardCardNumber(optional):
string
-
cabinNum(optional):
string
-
classification(optional):
string
-
consentStatus(optional):
string
-
contactNum(optional):
string
-
countryOfBirth(optional):
string
-
countryOfResidence(optional):
string
-
dateOfBirth(optional):
string
-
disembarkDate(optional):
string
-
disembarkPort(optional):
string
-
documentExpiryDate(optional):
string
-
documentIssuedCountry(optional):
string
-
documentIssuedDate(optional):
string
-
emailAddress(optional):
string
-
embarkCruiseId(optional):
string
-
embarkDate(optional):
string
-
embarkPort(optional):
string
-
emergencyContactName(optional):
string
-
emergencyContactNum(optional):
string
-
firstName(optional):
string
-
gender(optional):
string
-
groupReferenceId(optional):
string
-
guestId(optional):
string
-
lastName(optional):
string
-
middleName(optional):
string
-
nationalIdNum(optional):
string
-
nationality(optional):
string
-
onboardStatus(optional):
string
-
operationalDepartment(optional):
string
-
operationalPosition(optional):
string
-
passportNum(optional):
string
-
photo(optional):
string
-
reservationAccountReferenceId(optional):
string
-
reservationAccountType(optional):
string
-
reservationBookingNumber(optional):
string
-
reservationCancelStatus(optional):
string
-
reservationExternalId(optional):
string
-
reservationId(optional):
string
-
reservationStatus(optional):
string
-
routedAccountNumber(optional):
string
-
salutation(optional):
string
-
setSailPass(optional):
string
-
title(optional):
string
-
unicodeName(optional):
string
-
visitorPassType(optional):
string