Jump to

• Request
• Response

Retrieve a guest profile by guest Id

get

/spms/v2/ships/{shipId}/profiles/guests/{profileId}

This is to retrieve a guest profile by guest Id

Request

Supported Media Types

• application/json

Path Parameters

• profileId: integer
  Profile ID
• shipId: number
  Ship Id

Back to Top

Response

Supported Media Types

• application/hal+json

200 Response

OK

Body ()

Root Schema : Guest Profile

Type: object

Title: Guest Profile

Guest Profile Response

Show Source

• _links(optional): object _links
  Links
• accountCategory(optional): object accountCategory
  Account Category
• age(optional): integer(int32)
  Minimum Value: 1

  Maximum Value: 150

  Age

  Example: 25
• awardLevel(optional): string
  Maximum Length: 6

  Pattern: ^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$

  Award Level * `null` if empty

  Example: platinium
• birthNation(optional): object birthNation
  Birth Nation
• birthPlace(optional): string
  Maximum Length: 50

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Birth Place * `null` if empty

  Example: KL
• classification(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: ^[a-zA-Z0-9,.!? ]*$

  Classification * `null` if empty

  Example: CLASS I
• contactDetails(optional): object contactDetails
  Contact Details
• dateOfBirth(optional): string(ISO 8601 (YYYY-MM-DD))
  Date of Birth

  Example: 1970-02-15
• finNumber(optional): string
  Maximum Length: 20

  Pattern: ^[a-zA-Z0-9 ]+?$

  FIN Number * `null` if empty

  Example: a1234
• firstName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$

  First name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: Doe
• frequentNumber(optional): string
  Maximum Length: 60

  Pattern: ^[a-zA-Z0-9 ]+?$

  Frequent Number * `null` if empty

  Example: a1234
• gender(optional): string
  Gender

  Example: Male
• guestId(optional): integer
  Minimum Value: 0

  Guest Id

  Example: 456789
• intoxication(optional): boolean
  Is the guest intoxicated: * `true` - Intoxicated * `false` - Non-intoxicated

  Example: false
• lastName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$

  Last name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: Jaden
• maritalStatus(optional): object maritalStatus
  Marital Status
• middleName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$

  Middle name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: Jay
• nationalId(optional): string
  Maximum Length: 20

  Pattern: ^[a-zA-Z0-9 ]+?$

  National Id * `null` if empty

  Example: 1234
• nationality(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9_@./#&+-]*$

  Nationality code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: US
• otherFirstName(optional): string
  Other First Name

  Example: Mäya
• otherLastName(optional): string
  Other Last Name

  Example: Wälters
• passportDetails(optional): object passportDetailsResponse
  Passport Details
• permanentResidentNumber(optional): string
  Maximum Length: 30

  Pattern: ^[a-zA-Z0-9 ]+?$

  Permanent Resident Number * `null` if empty

  Example: a1234
• photo(optional): string
  Photo

  Example: https://[HOSTNAME]/resources/img_01.jpg
• preferredLanguage(optional): object preferredLanguage
  Preferred Language
• profession(optional): string
  Maximum Length: 50

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Profession * `null` if empty

  Example: Sales Executive
• profileType(optional): string
  Allowed Values: [ "Guest", "Resident" ]

  Profile Type

  Example: Resident
• resident(optional): boolean
  Is the guest a resident: * `true` - resident * `false` - Not resident

  Example: true
• royaltyNumber(optional): string
  Maximum Length: 20

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Royalty Number * `null` if empty

  Example: a1234
• salutation(optional): string
  Salutation

  Example: Dr.
• smoker(optional): boolean
  Is the guest a smoker: * `true` - Smoker * `false` - Non-smoker

  Example: false
• title(optional): string
  Title

  Example: Countess
• vip(optional): object VIP
  VIP

{
    "title":"Guest Profile",
    "description":"Guest Profile Response",
    "type":"object",
    "properties":{
        "profileType":{
            "$ref":"#/definitions/profileTypeResponse"
        },
        "guestId":{
            "$ref":"#/definitions/guestId"
        },
        "accountCategory":{
            "$ref":"#/definitions/accountCategory"
        },
        "resident":{
            "$ref":"#/definitions/resident"
        },
        "lastName":{
            "$ref":"#/definitions/lastName"
        },
        "firstName":{
            "$ref":"#/definitions/firstName"
        },
        "middleName":{
            "$ref":"#/definitions/middleName"
        },
        "otherLastName":{
            "$ref":"#/definitions/otherLastName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/otherFirstName"
        },
        "title":{
            "$ref":"#/definitions/title"
        },
        "salutation":{
            "$ref":"#/definitions/salutation"
        },
        "gender":{
            "$ref":"#/definitions/genderResponse"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "age":{
            "$ref":"#/definitions/age"
        },
        "photo":{
            "$ref":"#/definitions/photo"
        },
        "nationality":{
            "$ref":"#/definitions/nationality"
        },
        "birthNation":{
            "$ref":"#/definitions/birthNation"
        },
        "birthPlace":{
            "$ref":"#/definitions/birthPlace"
        },
        "maritalStatus":{
            "$ref":"#/definitions/maritalStatus"
        },
        "profession":{
            "$ref":"#/definitions/profession"
        },
        "preferredLanguage":{
            "$ref":"#/definitions/preferredLanguage"
        },
        "awardLevel":{
            "$ref":"#/definitions/awardLevel"
        },
        "royaltyNumber":{
            "$ref":"#/definitions/royaltyNumber"
        },
        "frequentNumber":{
            "$ref":"#/definitions/frequentNumber"
        },
        "nationalId":{
            "$ref":"#/definitions/nationalId"
        },
        "permanentResidentNumber":{
            "$ref":"#/definitions/permanentResidentNumber"
        },
        "finNumber":{
            "$ref":"#/definitions/finNumber"
        },
        "smoker":{
            "$ref":"#/definitions/smoker"
        },
        "intoxication":{
            "$ref":"#/definitions/intoxication"
        },
        "vip":{
            "$ref":"#/definitions/VIP"
        },
        "classification":{
            "$ref":"#/definitions/classification"
        },
        "passportDetails":{
            "$ref":"#/definitions/passportDetailsResponse"
        },
        "contactDetails":{
            "$ref":"#/definitions/contactDetails"
        },
        "_links":{
            "description":"Links",
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/definitions/homeAddressLink"
                }
            }
        }
    }
}

Nested Schema : _links

Type: object

Links

Show Source

• self(optional): object homeAddressLink
  Home Address Link (relation)

{
    "description":"Links",
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/definitions/homeAddressLink"
        }
    }
}

Nested Schema : accountCategory

Type: object

Account Category

Show Source

• code(optional): string
  Minimum Value: 1

  Maximum Value: 6

  Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$

  Account Category code

  Example: PROLOS
• description(optional): string
  Account Category Description

  Example: Regular Guest

{
    "description":"Account Category",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/accountCategoryCode"
        },
        "description":{
            "$ref":"#/definitions/accountCategoryDescription"
        }
    }
}

Nested Schema : birthNation

Type: object

Birth Nation

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 3

  Pattern: ^[ A-Za-z0-9_@./#&+-]*$

  Country Code

  Example: US
• description(optional): string
  Birth Nation Name * `null` if empty

  Example: United States

{
    "description":"Birth Nation",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/birthNationCode"
        },
        "description":{
            "$ref":"#/definitions/birthNationDesc"
        }
    }
}

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 empty

  Example: 4413563590
• emailAddress(optional): string
  Minimum Length: 1

  Maximum Length: 49

  Pattern: ^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$

  Email Address * `null` if empty

  Example: [e-mail]
• emergencyContactMobileNumber(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9+-]*$

  Emergency Contact Mobile Phone Number * `null` if empty

  Example: 0173443434
• emergencyContactName(optional): string
  Minimum Length: 1

  Maximum Length: 100

  Pattern: ^[a-zA-Z0-9 ]+?$

  Emergency Contact Name * `null` if empty

  Example: Emmeline
• emergencyContactPhoneNumber(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9+-]*$

  Emergency Contact Phone Number * `null` if empty

  Example: [phone]
• mobileNumber(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9]*$

  Mobile Number * `null` if empty

  Example: 4413563590

{
    "description":"Contact Details",
    "type":"object",
    "properties":{
        "mobileNumber":{
            "$ref":"#/definitions/mobileNumber"
        },
        "alternativeNumber":{
            "$ref":"#/definitions/alternativeNumber"
        },
        "emailAddress":{
            "$ref":"#/definitions/emailAddress"
        },
        "emergencyContactName":{
            "$ref":"#/definitions/emergencyContactName"
        },
        "emergencyContactMobileNumber":{
            "$ref":"#/definitions/emergencyContactMobileNumber"
        },
        "emergencyContactPhoneNumber":{
            "$ref":"#/definitions/emergencyContactPhoneNumber"
        }
    }
}

Nested Schema : maritalStatus

Type: object

Marital Status

Show Source

• code(optional): object maritalStatusCode
  maritalStatusCode
• description(optional): string
  Marital Status Description

  Example: Single

{
    "description":"Marital Status",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/maritalStatusCode"
        },
        "description":{
            "$ref":"#/definitions/maritalStatusDesc"
        }
    }
}

Nested Schema : passportDetailsResponse

Type: object

Passport Details

Show Source

• passportExpiryDate(optional): string(ISO 8601 (YYYY-MM-DD))
  Passport Expiry Date

  Example: 2025-02-25
• passportIssuedCountry(optional): object passportIssuedCountry
  Passport Issued Country
• passportIssuedDate(optional): string(ISO 8601)
  Passport Issued Date

  Example: 2009-10-31
• passportIssuedPlace(optional): string
  Passport Issued Place

  Example: Paramount
• passportNumber(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: ^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$

  Passport number * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: A123409982

{
    "description":"Passport Details",
    "type":"object",
    "properties":{
        "passportNumber":{
            "$ref":"#/definitions/passportNumber"
        },
        "passportIssuedDate":{
            "$ref":"#/definitions/passportIssuedDate"
        },
        "passportExpiryDate":{
            "$ref":"#/definitions/passportExpiryDate"
        },
        "passportIssuedCountry":{
            "$ref":"#/definitions/passportIssuedCountry"
        },
        "passportIssuedPlace":{
            "$ref":"#/definitions/passportIssuedPlace"
        }
    }
}

Nested Schema : preferredLanguage

Type: object

Preferred Language

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[a-zA-Z_0-9-! ]+$

  Preferred Language Code

  Example: EN
• description(optional): string
  Preferred Language Description

  Example: English

{
    "description":"Preferred Language",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/preferredLanguageCode"
        },
        "description":{
            "$ref":"#/definitions/preferredLanguageDesc"
        }
    }
}

Nested Schema : VIP

Type: object

VIP

Show Source

• code(optional): string
  Maximum Length: 6

  Pattern: ^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$

  VIP Code

  Example: S/VIP
• description(optional): string
  VIP Description

  Example: SUPERVIP

{
    "description":"VIP",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/VIPcode"
        },
        "description":{
            "$ref":"#/definitions/VIPdesc"
        }
    }
}

Nested Schema : homeAddressLink

Type: object

Home Address Link (relation)

Show Source

• href(optional): string
  Example: http://[HOSTNAME]/spms/v2/ships/186000000117/profile/1001/addresses/home
• method(optional): string
  Example: get
• operationId(optional): string
  Example: getHomeAddress

{
    "description":"Home Address Link (relation)",
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "example":"http://[HOSTNAME]/spms/v2/ships/186000000117/profile/1001/addresses/home"
        },
        "method":{
            "type":"string",
            "example":"get"
        },
        "operationId":{
            "type":"string",
            "example":"getHomeAddress"
        }
    }
}

Nested Schema : maritalStatusCode

Type: object

maritalStatusCode

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[a-zA-Z0-9 ]{1,6}$

  Marital Status Code

  Example: D
• comments(optional): string
  Maximum Value: 4000

  Account Category Comments

  Example: The term profit and loss (P&L) statement refers to a financial statement that summarizes the revenues, costs, and expenses incurred during a specified period, usually a quarter or fiscal year. These records provide information about a companys ability or inability to generate profit by increasing revenue, reducing costs, or both. These statements are often presented on a cash or accrual basis.
• description(optional): string
  Minimum Value: 1

  Maximum Value: 1000

  Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$

  Account Category Description

  Example: Profit and Loss Account
• id(optional): string
  Minimum Length: 1

  Maximum Length: 10

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Currency Exchange Id

  Example: 12345
• isEnabled(optional): boolean
  This is to indicate switch to enable / disable account category (default value: true) * `true` - Enable account category * `false` - Disable account category

  Example: true

{
    "description":"maritalStatusCode",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/id"
        },
        "code":{
            "$ref":"#/definitions/code"
        },
        "description":{
            "$ref":"#/definitions/description"
        },
        "comments":{
            "$ref":"#/definitions/comments"
        },
        "isEnabled":{
            "$ref":"#/definitions/isEnabled"
        }
    }
}

Nested Schema : passportIssuedCountry

Type: object

Passport Issued Country

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Country Code * `null` if empty

  Example: US
• description(optional): string
  Country Name

  Example: Malaysia

{
    "description":"Passport Issued Country",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/countryCode"
        },
        "description":{
            "$ref":"#/definitions/countryDesc"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestProfileErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter 'profileId' has incorrect format"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter 'profileId' has incorrect format"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "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/guestProfileErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestProfileErrorResponse"
        }
    ],
    "example":{
        "title":"Not Found",
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "detail":"Ship 186000000404 was not found"
    }
}

Example:

{
    "title":"Not Found",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "detail":"Ship 186000000404 was not found"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

410 Response

Gone

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestProfileErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
        "title":"Gone",
        "detail":"Requested Resource no longer exists"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

415 Response

Unsupported Media Type

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestProfileErrorResponse"
        }
    ],
    "example":{
        "title":"Invalid content",
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "detail":"Content type not supported"
    }
}

Example:

{
    "title":"Invalid content",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "detail":"Content type not supported"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "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/guestProfileErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

501 Response

Not Implemented

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "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/guestProfileErrorResponse"
        }
    ],
    "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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top