Oracle Hospitality Cruise Property Management REST API 23.2.2

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(required): integer

Profile Id
shipId(required): number

Ship Id

Guest Profile Object

Root Schema : Guest Profile Request

Type: object

Title: Guest Profile Request

Guest Profile Request Body

Show Source

accountCategory: string

Allowed Values: [ "PAX" ]

accountCategory

Example: PAX
age(required): integer(int32)

Minimum Value: 1

Maximum Value: 150

Age

Example: 25
awardLevel: string

Maximum Length: 6

Award Level * `null` if empty

Example: gold
birthNation: string

Minimum Length: 1

Maximum Length: 3

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

Birth Nation Code * `null` if empty

Example: US
birthPlace: string

Maximum Length: 50

Birth Place * `null` if empty

Example: KL
classification: string

Minimum Length: 1

Maximum Length: 20

Classification * `null` if empty

Example: CLASS I
contactDetails: object contactDetails

Contact Details
dateOfBirth(required): string(ISO 8601 (YYYY-MM-DD))

Date Of Birth

Example: 1999-02-15
finNumber: string

Maximum Length: 20

FIN Number * `null` if empty

Example: a1234
firstName(required): string

Minimum Length: 1

Maximum Length: 40

First Name

Example: Down
frequentNumber: string

Maximum Length: 60

Frequent Number * `null` if empty

Example: a1234
gender(required): string

Minimum Length: 1

Maximum Length: 6

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

Gender Code * `F` - Female * `M` - Male

Example: M
intoxication: boolean

Is the guest intoxicated: * `true` - Intoxicated * `false` - Non-intoxicated

Example: true
lastName(required): string

Minimum Length: 1

Maximum Length: 40

Last Name

Example: Niel
maritalStatus: string

Minimum Length: 1

Maximum Length: 6

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

Marital Status Code

Example: S
middleName: string

Minimum Length: 1

Maximum Length: 20

Middle Name * `null` if empty

Example: MB
nationalId: string

Minimum Length: 1

Maximum Length: 20

National Id * `null` if empty

Example: A123
nationality(required): string

Minimum Length: 1

Maximum Length: 6

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

Country Code

Example: MY
otherFirstName: string

Minimum Length: 1

Maximum Length: 80

Other First Name * `null` if empty

Example: Mäya
otherLastName: string

Minimum Length: 1

Maximum Length: 100

Other Last Name * `null` if empty

Example: Wälters
passportDetails: object passportDetailsRequest

Passport Details
permanentResidentNumber: string

Maximum Length: 30

Permanent Resident Number * `null` if empty

Example: a1234
photo: string

Photo

Example: /9j/4AAQSkZJRgABAQEASABIAAD==
preferredLanguage: string

Minimum Length: 1

Maximum Length: 6

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

Preferred Language Code

Example: EN
profession: string

Maximum Length: 50

Profession * `null` if empty

Example: Sales Executive
profileType: string

Minimum Length: 1

Maximum Length: 1

Pattern: [PR]$

Profile Type Code * `P` - Guest * `R` - Resident

Example: R
resident: boolean

Is the guest a resident: * `true` - resident * `false` - Not resident

Example: true
royaltyNumber: string

Maximum Length: 20

Royalty Number * `null` if empty

Example: a1234
salutation: string

Minimum Length: 1

Maximum Length: 20

Salutation

Example: Mr.
smoker: boolean

Is the guest a smoker: * `true` - Smoker * `false` - Non-smoker

Example: true
title: string

Minimum Length: 1

Maximum Length: 20

Title * `null` if empty

Example: MR
vip: string

{
    "title":"Guest Profile Request",
    "description":"Guest Profile Request Body",
    "type":"object",
    "properties":{
        "profileType":{
            "$ref":"#/definitions/profileTypeRequest"
        },
        "accountCategory":{
            "$ref":"#/definitions/gpdAccountCategory"
        },
        "resident":{
            "$ref":"#/definitions/resident"
        },
        "lastName":{
            "$ref":"#/definitions/gpdLastName"
        },
        "firstName":{
            "$ref":"#/definitions/gpdFirstName"
        },
        "middleName":{
            "$ref":"#/definitions/gpdMiddleName"
        },
        "otherLastName":{
            "$ref":"#/definitions/gpdOtherLastName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/gpdOtherFirstName"
        },
        "title":{
            "$ref":"#/definitions/gpdTitle"
        },
        "salutation":{
            "$ref":"#/definitions/gpdSalutation"
        },
        "gender":{
            "$ref":"#/definitions/genderRequest"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "age":{
            "$ref":"#/definitions/gpdAge"
        },
        "photo":{
            "$ref":"#/definitions/gpdPhoto"
        },
        "nationality":{
            "$ref":"#/definitions/gpdCountryCode"
        },
        "birthNation":{
            "$ref":"#/definitions/gpdBirthNationCode"
        },
        "birthPlace":{
            "$ref":"#/definitions/birthPlace"
        },
        "maritalStatus":{
            "$ref":"#/definitions/maritalStatusCode"
        },
        "profession":{
            "$ref":"#/definitions/profession"
        },
        "preferredLanguage":{
            "$ref":"#/definitions/preferredLanguageCode"
        },
        "awardLevel":{
            "$ref":"#/definitions/awardLevel"
        },
        "royaltyNumber":{
            "$ref":"#/definitions/gpdRoyaltyNumber"
        },
        "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":{
            "type":"string"
        },
        "classification":{
            "$ref":"#/definitions/classification"
        },
        "passportDetails":{
            "$ref":"#/definitions/passportDetailsRequest"
        },
        "contactDetails":{
            "$ref":"#/definitions/contactDetails"
        }
    },
    "required":[
        "lastName",
        "firstName",
        "gender",
        "age",
        "dateOfBirth",
        "nationality"
    ]
}

Nested Schema : contactDetails

Type: object

Contact Details

Show Source

alternativeNumber: string

Minimum Length: 1

Maximum Length: 30

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

Temporary Phone Number * `null` if empty

Example: 4413563590
emailAddress: string

Minimum Length: 1

Maximum Length: 50

Pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Email Address * `null` if empty

Example: email@example.com
emergencyContactMobileNumber: string

Minimum Length: 1

Maximum Length: 30

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

Emergency Contact Mobile Phone Number * `null` if empty

Example: 0173443434
emergencyContactName: string

Minimum Length: 1

Maximum Length: 40

Emergency Contact Name * `null` if empty

Example: Emmeline
emergencyContactPhoneNumber: string

Minimum Length: 1

Maximum Length: 30

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

Emergency Contact Phone Number * `null` if empty

Example: +(62) 3962999
mobileNumber: string

Minimum Length: 1

Maximum Length: 30

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

Mobile Number * `null` if empty

Example: 62-39629630

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

Nested Schema : passportDetailsRequest

Type: object

Passport Details

Show Source

passportExpiryDate: string(ISO 8601)

Passport Expiry Date

Example: 2019-10-31
passportIssuedCountry: string

Minimum Length: 1

Maximum Length: 6

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

Country Code

Example: MY
passportIssuedDate: string(ISO 8601)

Passport Issued Date

Example: 2009-10-31
passportIssuedPlace: string

Maximum Length: 50

Passport Issued Place

Example: Shah Alam
passportNumber: string

Minimum Length: 1

Maximum Length: 20

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

Passport Number

Example: ABC12345678

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

Response

Supported Media Types

application/hal+json

200 Response

Root Schema : Guest Profile

Type: object

Title: Guest Profile

Guest Profile Response

Show Source

_links: object _links

Links
accountCategory: string

Allowed Values: [ "PAX" ]

accountCategory

Example: PAX
age: integer(int32)

Minimum Value: 1

Maximum Value: 150

Age

Example: 25
awardLevel: string

Maximum Length: 6

Award Level * `null` if empty

Example: gold
birthNation: object birthNation

Birth Nation
birthPlace: string

Maximum Length: 50

Birth Place * `null` if empty

Example: KL
classification: string

Minimum Length: 1

Maximum Length: 20

Classification * `null` if empty

Example: CLASS I
contactDetails: object contactDetails

Contact Details
dateOfBirth: string(ISO 8601 (YYYY-MM-DD))

Date Of Birth

Example: 1999-02-15
finNumber: string

Maximum Length: 20

FIN Number * `null` if empty

Example: a1234
firstName: string

Minimum Length: 1

Maximum Length: 40

First Name

Example: Down
frequentNumber: string

Maximum Length: 60

Frequent Number * `null` if empty

Example: a1234
gender: string

Gender

Example: Male
guestId: integer

Minimum Value: 0

Guest Id

Example: 456789
intoxication: boolean

Is the guest intoxicated: * `true` - Intoxicated * `false` - Non-intoxicated

Example: true
lastName: string

Minimum Length: 1

Maximum Length: 40

Last Name

Example: Niel
maritalStatus: object maritalStatus

Marital Status
middleName: string

Minimum Length: 1

Maximum Length: 20

Middle Name * `null` if empty

Example: MB
nationalId: string

Minimum Length: 1

Maximum Length: 20

National Id * `null` if empty

Example: A123
nationality: object gpdNationalityStruct

Nationality
otherFirstName: string

Minimum Length: 1

Maximum Length: 80

Other First Name * `null` if empty

Example: Mäya
otherLastName: string

Minimum Length: 1

Maximum Length: 100

Other Last Name * `null` if empty

Example: Wälters
passportDetails: object gpdPassportDetailsResponse

Passport Details
permanentResidentNumber: string

Maximum Length: 30

Permanent Resident Number * `null` if empty

Example: a1234
photo: string

Photo

Example: /9j/4AAQSkZJRgABAQEASABIAAD==
preferredLanguage: object preferredLanguage

Preferred Language
profession: string

Maximum Length: 50

Profession * `null` if empty

Example: Sales Executive
profileType: string

Allowed Values: [ "Guest", "Resident" ]

Profile Type

Example: Resident
resident: boolean

Is the guest a resident: * `true` - resident * `false` - Not resident

Example: true
royaltyNumber: string

Maximum Length: 20

Royalty Number * `null` if empty

Example: a1234
salutation: string

Minimum Length: 1

Maximum Length: 20

Salutation

Example: Mr.
smoker: boolean

Is the guest a smoker: * `true` - Smoker * `false` - Non-smoker

Example: true
title: string

Minimum Length: 1

Maximum Length: 20

Title * `null` if empty

Example: MR
vip: object gpdVip

VIP

{
    "title":"Guest Profile",
    "description":"Guest Profile Response",
    "type":"object",
    "properties":{
        "profileType":{
            "$ref":"#/definitions/profileTypeResponse"
        },
        "guestId":{
            "$ref":"#/definitions/guestId"
        },
        "accountCategory":{
            "$ref":"#/definitions/gpdAccountCategory"
        },
        "resident":{
            "$ref":"#/definitions/resident"
        },
        "lastName":{
            "$ref":"#/definitions/gpdLastName"
        },
        "firstName":{
            "$ref":"#/definitions/gpdFirstName"
        },
        "middleName":{
            "$ref":"#/definitions/gpdMiddleName"
        },
        "otherLastName":{
            "$ref":"#/definitions/gpdOtherLastName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/gpdOtherFirstName"
        },
        "title":{
            "$ref":"#/definitions/gpdTitle"
        },
        "salutation":{
            "$ref":"#/definitions/gpdSalutation"
        },
        "gender":{
            "$ref":"#/definitions/genderResponse"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "age":{
            "$ref":"#/definitions/gpdAge"
        },
        "photo":{
            "$ref":"#/definitions/gpdPhoto"
        },
        "nationality":{
            "$ref":"#/definitions/gpdNationalityStruct"
        },
        "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/gpdRoyaltyNumber"
        },
        "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/gpdVip"
        },
        "classification":{
            "$ref":"#/definitions/classification"
        },
        "passportDetails":{
            "$ref":"#/definitions/gpdPassportDetailsResponse"
        },
        "contactDetails":{
            "$ref":"#/definitions/contactDetails"
        },
        "_links":{
            "description":"Links",
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/definitions/homeAddressLink"
                }
            }
        }
    }
}

Nested Schema : _links

Type: object

Links

Show Source

self: object homeAddressLink

Home Address Link (relation)

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

Nested Schema : birthNation

Type: object

Birth Nation

Show Source

code: string

Minimum Length: 1

Maximum Length: 3

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

Birth Nation Code * `null` if empty

Example: US
description: string

Birth Nation Name * `null` if empty

Example: United States

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

Nested Schema : contactDetails

Type: object

Contact Details

Show Source

alternativeNumber: string

Minimum Length: 1

Maximum Length: 30

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

Temporary Phone Number * `null` if empty

Example: 4413563590
emailAddress: string

Minimum Length: 1

Maximum Length: 50

Pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Email Address * `null` if empty

Example: email@example.com
emergencyContactMobileNumber: string

Minimum Length: 1

Maximum Length: 30

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

Emergency Contact Mobile Phone Number * `null` if empty

Example: 0173443434
emergencyContactName: string

Minimum Length: 1

Maximum Length: 40

Emergency Contact Name * `null` if empty

Example: Emmeline
emergencyContactPhoneNumber: string

Minimum Length: 1

Maximum Length: 30

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

Emergency Contact Phone Number * `null` if empty

Example: +(62) 3962999
mobileNumber: string

Minimum Length: 1

Maximum Length: 30

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

Mobile Number * `null` if empty

Example: 62-39629630

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

Nested Schema : maritalStatus

Type: object

Marital Status

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

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

Marital Status Code

Example: S
description: string

Marital Status Description

Example: Single

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

Nested Schema : gpdNationalityStruct

Type: object

Nationality

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

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

Country Code

Example: MY
description: string

Country Name

Example: Malaysia

{
    "description":"Nationality",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/gpdCountryCode"
        },
        "description":{
            "$ref":"#/definitions/countryDesc"
        }
    }
}

Nested Schema : gpdPassportDetailsResponse

Type: object

Passport Details

Show Source

passportExpiryDate: string(ISO 8601)

Passport Expiry Date

Example: 2019-10-31
passportIssuedCountry: object gpdPassportIssuedCountry

Passport Issued Country
passportIssuedDate: string(ISO 8601)

Passport Issued Date

Example: 2009-10-31
passportIssuedPlace: string

Maximum Length: 50

Passport Issued Place

Example: Shah Alam
passportNumber: string

Minimum Length: 1

Maximum Length: 20

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

Passport Number

Example: ABC12345678

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

Nested Schema : preferredLanguage

Type: object

Preferred Language

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

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

Preferred Language Code

Example: EN
description: string

Preferred Language Description

Example: English

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

Nested Schema : gpdVip

Type: object

VIP

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

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

VIP Code

Example: S/VIP
description: string

VIP Description

Example: SUPERVIP

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

Nested Schema : homeAddressLink

Type: object

Home Address Link (relation)

Show Source

href: string

Example: http://[HOSTNAME]/spms/v2/ships/186000000117/profile/1001/addresses/home
method: string

Example: get
operationId: 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 : gpdPassportIssuedCountry

Type: object

Passport Issued Country

Show Source

code: string

Minimum Length: 1

Maximum Length: 6

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

Country Code

Example: MY
description: string

Country Name

Example: Malaysia

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

400 Response

Bad Request

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":"Malformed JSON request"
    }
}

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

detail: string
title: string
type: 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

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: string
title: string
type: 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

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: string
title: string
type: 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

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.5",
        "title":"Not Found",
        "detail":"Profile ID - 1002 is invalid"
    }
}

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

detail: string
title: string
type: 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

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 Supported",
        "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 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

detail: string
title: string
type: 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

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: string
title: string
type: 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

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: string
title: string
type: 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

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.16",
        "title":"Invalid content",
        "detail":"Content type not supported"
    }
}

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

detail: string
title: string
type: 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

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.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

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

detail: string
title: string
type: 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

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: string
title: string
type: 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

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.4",
        "title":"Service Unavailable",
        "detail":"Service not available"
    }
}

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

detail: string
title: string
type: string

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