Jump to

• Request
• Response

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)

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns status

Body ()

Root Schema : schema

Match All

Show Source

• object Profile Search Result
  Title: Profile Search Result

  Profile Search Result

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileSearchResult"
        }
    ]
}

Nested Schema : Profile Search Result

Type: object

Title: Profile Search Result

Profile Search Result

Show Source

• items(optional): array items

{
    "title":"Profile Search Result",
    "description":"Profile Search Result",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Profile"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Profile
  links detail

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Profile"
    }
}

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

{
    "description":"links detail",
    "type":"object",
    "properties":{
        "accountCategory":{
            "type":"string"
        },
        "accountType":{
            "type":"string"
        },
        "age":{
            "type":"string"
        },
        "alternativeContactNum":{
            "type":"string"
        },
        "contactNum":{
            "type":"string"
        },
        "countryOfBirth":{
            "type":"string"
        },
        "countryOfResidence":{
            "type":"string"
        },
        "dateOfBirth":{
            "type":"string"
        },
        "documentExpiryDate":{
            "type":"string"
        },
        "documentIssuedCountry":{
            "type":"string"
        },
        "documentIssuedDate":{
            "type":"string"
        },
        "emailAddress":{
            "type":"string"
        },
        "emergencyContactName":{
            "type":"string"
        },
        "emergencyContactNum":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "gender":{
            "type":"string"
        },
        "guestId":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "middleName":{
            "type":"string"
        },
        "nationalIdNum":{
            "type":"string"
        },
        "nationality":{
            "type":"string"
        },
        "passportNum":{
            "type":"string"
        },
        "photo":{
            "type":"string"
        },
        "salutation":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "unicodeName":{
            "type":"string"
        },
        "accountId":{
            "type":"string"
        },
        "actualDisembarkDate":{
            "type":"string"
        },
        "actualEmbarkDate":{
            "type":"string"
        },
        "boardCardNumber":{
            "type":"string"
        },
        "cabinNum":{
            "type":"string"
        },
        "consentStatus":{
            "type":"string"
        },
        "disembarkDate":{
            "type":"string"
        },
        "disembarkPort":{
            "type":"string"
        },
        "embarkCruiseId":{
            "type":"string"
        },
        "embarkDate":{
            "type":"string"
        },
        "embarkPort":{
            "type":"string"
        },
        "groupReferenceId":{
            "type":"string"
        },
        "onboardStatus":{
            "type":"string"
        },
        "reservationAccountReferenceId":{
            "type":"string"
        },
        "reservationAccountType":{
            "type":"string"
        },
        "reservationBookingNumber":{
            "type":"string"
        },
        "reservationCancelStatus":{
            "type":"string"
        },
        "reservationExternalId":{
            "type":"string"
        },
        "reservationId":{
            "type":"string"
        },
        "reservationStatus":{
            "type":"string"
        },
        "routedAccountNumber":{
            "type":"string"
        },
        "setSailPass":{
            "type":"string"
        },
        "visitorPassType":{
            "type":"string"
        },
        "classification":{
            "type":"string"
        },
        "operationalDepartment":{
            "type":"string"
        },
        "operationalPosition":{
            "type":"string"
        },
        "assemblyStationCode":{
            "type":"string"
        },
        "assemblyStationName":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileSearchErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"You are forbidden to use this API"
    }
}

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "accountCategory":{
            "type":"string"
        },
        "accountType":{
            "type":"string"
        },
        "age":{
            "type":"string"
        },
        "alternativeContactNum":{
            "type":"string"
        },
        "contactNum":{
            "type":"string"
        },
        "countryOfBirth":{
            "type":"string"
        },
        "countryOfResidence":{
            "type":"string"
        },
        "dateOfBirth":{
            "type":"string"
        },
        "documentExpiryDate":{
            "type":"string"
        },
        "documentIssuedCountry":{
            "type":"string"
        },
        "documentIssuedDate":{
            "type":"string"
        },
        "emailAddress":{
            "type":"string"
        },
        "emergencyContactName":{
            "type":"string"
        },
        "emergencyContactNum":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "gender":{
            "type":"string"
        },
        "guestId":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "middleName":{
            "type":"string"
        },
        "nationalIdNum":{
            "type":"string"
        },
        "nationality":{
            "type":"string"
        },
        "passportNum":{
            "type":"string"
        },
        "photo":{
            "type":"string"
        },
        "salutation":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "unicodeName":{
            "type":"string"
        },
        "accountId":{
            "type":"string"
        },
        "actualDisembarkDate":{
            "type":"string"
        },
        "actualEmbarkDate":{
            "type":"string"
        },
        "boardCardNumber":{
            "type":"string"
        },
        "cabinNum":{
            "type":"string"
        },
        "consentStatus":{
            "type":"string"
        },
        "disembarkDate":{
            "type":"string"
        },
        "disembarkPort":{
            "type":"string"
        },
        "embarkCruiseId":{
            "type":"string"
        },
        "embarkDate":{
            "type":"string"
        },
        "embarkPort":{
            "type":"string"
        },
        "groupReferenceId":{
            "type":"string"
        },
        "onboardStatus":{
            "type":"string"
        },
        "reservationAccountReferenceId":{
            "type":"string"
        },
        "reservationAccountType":{
            "type":"string"
        },
        "reservationBookingNumber":{
            "type":"string"
        },
        "reservationCancelStatus":{
            "type":"string"
        },
        "reservationExternalId":{
            "type":"string"
        },
        "reservationId":{
            "type":"string"
        },
        "reservationStatus":{
            "type":"string"
        },
        "routedAccountNumber":{
            "type":"string"
        },
        "setSailPass":{
            "type":"string"
        },
        "visitorPassType":{
            "type":"string"
        },
        "classification":{
            "type":"string"
        },
        "operationalDepartment":{
            "type":"string"
        },
        "operationalPosition":{
            "type":"string"
        },
        "assemblyStationCode":{
            "type":"string"
        },
        "assemblyStationName":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileSearchErrorResponse"
        }
    ],
    "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"
    }
}

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "accountCategory":{
            "type":"string"
        },
        "accountType":{
            "type":"string"
        },
        "age":{
            "type":"string"
        },
        "alternativeContactNum":{
            "type":"string"
        },
        "contactNum":{
            "type":"string"
        },
        "countryOfBirth":{
            "type":"string"
        },
        "countryOfResidence":{
            "type":"string"
        },
        "dateOfBirth":{
            "type":"string"
        },
        "documentExpiryDate":{
            "type":"string"
        },
        "documentIssuedCountry":{
            "type":"string"
        },
        "documentIssuedDate":{
            "type":"string"
        },
        "emailAddress":{
            "type":"string"
        },
        "emergencyContactName":{
            "type":"string"
        },
        "emergencyContactNum":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "gender":{
            "type":"string"
        },
        "guestId":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "middleName":{
            "type":"string"
        },
        "nationalIdNum":{
            "type":"string"
        },
        "nationality":{
            "type":"string"
        },
        "passportNum":{
            "type":"string"
        },
        "photo":{
            "type":"string"
        },
        "salutation":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "unicodeName":{
            "type":"string"
        },
        "accountId":{
            "type":"string"
        },
        "actualDisembarkDate":{
            "type":"string"
        },
        "actualEmbarkDate":{
            "type":"string"
        },
        "boardCardNumber":{
            "type":"string"
        },
        "cabinNum":{
            "type":"string"
        },
        "consentStatus":{
            "type":"string"
        },
        "disembarkDate":{
            "type":"string"
        },
        "disembarkPort":{
            "type":"string"
        },
        "embarkCruiseId":{
            "type":"string"
        },
        "embarkDate":{
            "type":"string"
        },
        "embarkPort":{
            "type":"string"
        },
        "groupReferenceId":{
            "type":"string"
        },
        "onboardStatus":{
            "type":"string"
        },
        "reservationAccountReferenceId":{
            "type":"string"
        },
        "reservationAccountType":{
            "type":"string"
        },
        "reservationBookingNumber":{
            "type":"string"
        },
        "reservationCancelStatus":{
            "type":"string"
        },
        "reservationExternalId":{
            "type":"string"
        },
        "reservationId":{
            "type":"string"
        },
        "reservationStatus":{
            "type":"string"
        },
        "routedAccountNumber":{
            "type":"string"
        },
        "setSailPass":{
            "type":"string"
        },
        "visitorPassType":{
            "type":"string"
        },
        "classification":{
            "type":"string"
        },
        "operationalDepartment":{
            "type":"string"
        },
        "operationalPosition":{
            "type":"string"
        },
        "assemblyStationCode":{
            "type":"string"
        },
        "assemblyStationName":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ProfileSearchErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service not available"
    }
}

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

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "accountCategory":{
            "type":"string"
        },
        "accountType":{
            "type":"string"
        },
        "age":{
            "type":"string"
        },
        "alternativeContactNum":{
            "type":"string"
        },
        "contactNum":{
            "type":"string"
        },
        "countryOfBirth":{
            "type":"string"
        },
        "countryOfResidence":{
            "type":"string"
        },
        "dateOfBirth":{
            "type":"string"
        },
        "documentExpiryDate":{
            "type":"string"
        },
        "documentIssuedCountry":{
            "type":"string"
        },
        "documentIssuedDate":{
            "type":"string"
        },
        "emailAddress":{
            "type":"string"
        },
        "emergencyContactName":{
            "type":"string"
        },
        "emergencyContactNum":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "gender":{
            "type":"string"
        },
        "guestId":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "middleName":{
            "type":"string"
        },
        "nationalIdNum":{
            "type":"string"
        },
        "nationality":{
            "type":"string"
        },
        "passportNum":{
            "type":"string"
        },
        "photo":{
            "type":"string"
        },
        "salutation":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "unicodeName":{
            "type":"string"
        },
        "accountId":{
            "type":"string"
        },
        "actualDisembarkDate":{
            "type":"string"
        },
        "actualEmbarkDate":{
            "type":"string"
        },
        "boardCardNumber":{
            "type":"string"
        },
        "cabinNum":{
            "type":"string"
        },
        "consentStatus":{
            "type":"string"
        },
        "disembarkDate":{
            "type":"string"
        },
        "disembarkPort":{
            "type":"string"
        },
        "embarkCruiseId":{
            "type":"string"
        },
        "embarkDate":{
            "type":"string"
        },
        "embarkPort":{
            "type":"string"
        },
        "groupReferenceId":{
            "type":"string"
        },
        "onboardStatus":{
            "type":"string"
        },
        "reservationAccountReferenceId":{
            "type":"string"
        },
        "reservationAccountType":{
            "type":"string"
        },
        "reservationBookingNumber":{
            "type":"string"
        },
        "reservationCancelStatus":{
            "type":"string"
        },
        "reservationExternalId":{
            "type":"string"
        },
        "reservationId":{
            "type":"string"
        },
        "reservationStatus":{
            "type":"string"
        },
        "routedAccountNumber":{
            "type":"string"
        },
        "setSailPass":{
            "type":"string"
        },
        "visitorPassType":{
            "type":"string"
        },
        "classification":{
            "type":"string"
        },
        "operationalDepartment":{
            "type":"string"
        },
        "operationalPosition":{
            "type":"string"
        },
        "assemblyStationCode":{
            "type":"string"
        },
        "assemblyStationName":{
            "type":"string"
        }
    }
}

Back to Top