Jump to

• Request
• Response

Retrieve a guest reservation by Reservation Id

get

/spms/v2/ships/{shipId}/reservations/guests

This is to retrieve a guest cruise reservation by Reservation Id

Request

Supported Media Types

• application/json

Path Parameters

• shipId: number
  ship Id

Query Parameters

• bookingNumber: string
  Booking Number
• disembarkationDateFrom: string(date)
  Disembarkation Date From
• disembarkationDateTo: string(date)
  Disembarkation Date To
• embarkationDateFrom: string(date)
  Embarkation Date From
• embarkationDateTo: string(date)
  Embarkation Date To
• limit: integer(int32)
  Minimum Length: 1

  Paging limit

  Default Value: 50
• offset: integer(int32)
  Minimum Length: 0

  Paging offset

  Default Value: 0
• orderBy: string
  order by embarkationDateFrom, disembarkationDateFrom, bookingNumber with format column1:asc/desc,column2:asc/desc
• profileId: number
  Profile Id
• reservationId: number
  Reservation Id
• reservationStatus: string
  Reservation Status
• setSailPassNumber: string
  Set Sail Pass Number
• stateroomNumber: string
  Stateroom Number

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object guestReservationGETObject
  Guest Reservation GET Object

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

Nested Schema : guestReservationGETObject

Type: object

Guest Reservation GET Object

Show Source

• boardCardNumber(optional): string
  Minimum Length: 1

  Maximum Length: 20

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

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

  Example: A9800000000001
• bookingNumber(optional): string
  Minimum Length: 1

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

  Booking Number

  Example: 123456789
• discountTemplate(optional): object discountTemplate
  Discount Template
• disembarkationDate(optional): string
  Reservation disembarkation date * `Optional` (Do not provide if not in use) * For all Profile Types

  Example: 2021-01-30
• disembarkationHarbor(optional): object disembarkationHarbor
  disembarkationHarbor
• disembarkationHarborComments(optional): string
  comments

  Example: Going to the land
• document(optional): object document
  Document
• embarkationDate(optional): string
  Reservation embarkation date * `Optional` (Do not provide if not in use) * For all Profile Types

  Example: 2021-01-26
• embarkationHarbor(optional): object embarkationHarbor
  Embarkation Harbor
• embarkationHarborComments(optional): string
  comments

  Example: Going to the sea
• isNoticeAndConsent(optional): boolean
  Acknowledge Notice and Consent

  Example: true
• lifeBoat(optional): object lifeBoat
  Life Boat
• manifestPrintout(optional): boolean
  Manifest Printout

  Example: false
• musterStation(optional): object musterStation
  musterStation
• numberOfCruiseDays(optional): number
  Pattern: ^[0-9]*$

  Total Number Of Cruise Days

  Example: 1
• numberOfCruises(optional): number
  Pattern: ^[0-9]*$

  Number Of Cruises

  Example: 1
• onboardEmail(optional): string
  Minimum Length: 1

  Maximum Length: 49

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

  Onboard Email Address * `null` if empty

  Example: [e-mail]
• onboardStatus(optional): boolean
  Onboard status * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: true
• otherParameter(optional): object otherParameter
  Other Parameters
• profileInformation(optional): object profileInformation
  Profile Information
• queueId(optional): number
  Pattern: ^[0-9]*$

  Queue Id

  Example: 11
• reservationId(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Reservation Id

  Example: 1001
• reservationStatus(optional): string
  Reservation Status, RR=Reservation, RX=Cancelled, RE=Embark today, RN=No Show, CC=Checked In, CL=Leaving today, DD=Disembarked

  Example: CC
• setSailPassNumber(optional): string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Set Sail Pass Number

  Example: 3388
• shoreGId(optional): string
  Minimum Length: 1

  Maximum Length: 50

  Pattern: ^[a-zA-Z0-9 ]*$

  Shore G Id

  Example: G1
• shoreResId(optional): string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Shore Reservation Id

  Example: S1
• stateroomNumber(optional): string
  Minimum Length: 1

  Maximum Length: 20

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

  Stateroom number / Cabin number * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `P`, `R`, `C` Profile Types * Ignored if given only other Profile Types

  Example: B1001

{
    "description":"Guest Reservation GET Object",
    "type":"object",
    "properties":{
        "reservationId":{
            "$ref":"#/definitions/reservationId"
        },
        "reservationStatus":{
            "$ref":"#/definitions/reservationStatus"
        },
        "embarkationDate":{
            "$ref":"#/definitions/embarkationDate"
        },
        "embarkationHarbor":{
            "$ref":"#/definitions/embarkationHarbor"
        },
        "embarkationHarborComments":{
            "$ref":"#/definitions/embarkationHarborComments"
        },
        "disembarkationDate":{
            "$ref":"#/definitions/disembarkationDate"
        },
        "disembarkationHarbor":{
            "$ref":"#/definitions/disembarkationHarbor"
        },
        "disembarkationHarborComments":{
            "$ref":"#/definitions/disembarkationHarborComments"
        },
        "bookingNumber":{
            "$ref":"#/definitions/bookingNumber"
        },
        "stateroomNumber":{
            "$ref":"#/definitions/stateroomNumber"
        },
        "boardCardNumber":{
            "$ref":"#/definitions/boardCardNumber"
        },
        "setSailPassNumber":{
            "$ref":"#/definitions/setSailPassNumber"
        },
        "musterStation":{
            "$ref":"#/definitions/musterStation"
        },
        "onboardStatus":{
            "$ref":"#/definitions/onboardStatus"
        },
        "manifestPrintout":{
            "$ref":"#/definitions/manifestPrintout"
        },
        "document":{
            "$ref":"#/definitions/document"
        },
        "lifeBoat":{
            "$ref":"#/definitions/lifeBoat"
        },
        "shoreGId":{
            "$ref":"#/definitions/shoreGId"
        },
        "queueId":{
            "$ref":"#/definitions/queueId"
        },
        "onboardEmail":{
            "$ref":"#/definitions/onboardEmail"
        },
        "numberOfCruiseDays":{
            "$ref":"#/definitions/numberOfCruiseDays"
        },
        "numberOfCruises":{
            "$ref":"#/definitions/numberOfCruises"
        },
        "discountTemplate":{
            "$ref":"#/definitions/discountTemplate"
        },
        "shoreResId":{
            "$ref":"#/definitions/shoreResId"
        },
        "otherParameter":{
            "$ref":"#/definitions/otherParameter"
        },
        "isNoticeAndConsent":{
            "$ref":"#/definitions/isNoticeAndConsent"
        },
        "profileInformation":{
            "$ref":"#/definitions/profileInformation"
        }
    }
}

Nested Schema : discountTemplate

Type: object

Discount Template

Show Source

• code(optional): string
  Discount Template Code

  Example: LV2
• description(optional): string
  Discount Template Description

  Example: Disc Template 2

{
    "description":"Discount Template",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/discountTemplateCode"
        },
        "description":{
            "$ref":"#/definitions/discountTemplateDescription"
        }
    }
}

Nested Schema : disembarkationHarbor

Type: object

disembarkationHarbor

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

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

  Disembarkation Harbor Code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: AGSJO
• description(optional): string
  Disembarkation Harbor Code Description

  Example: To Land

{
    "description":"disembarkationHarbor",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/disembarkationHarborCode"
        },
        "description":{
            "$ref":"#/definitions/disembarkationHarborCodeDescription"
        }
    }
}

Nested Schema : document

Type: object

Document

Show Source

• isDocumentChecked(optional): boolean
  Document Is Checked

  Example: false
• isDocumentCollected(optional): boolean
  Document Is Collect

  Example: false

{
    "description":"Document",
    "type":"object",
    "properties":{
        "isDocumentChecked":{
            "$ref":"#/definitions/isDocumentChecked"
        },
        "isDocumentCollected":{
            "$ref":"#/definitions/isDocumentCollected"
        }
    }
}

Nested Schema : embarkationHarbor

Type: object

Embarkation Harbor

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

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

  Embarkation Harbor Code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: AGSJO
• description(optional): string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Embarkation Harbor Code Description

  Example: To Sea

{
    "description":"Embarkation Harbor",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/embarkationHarborCode"
        },
        "description":{
            "$ref":"#/definitions/embarkationHarborDescription"
        }
    }
}

Nested Schema : lifeBoat

Type: object

Life Boat

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

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

  Lifeboat Code

  Example: L1
• description(optional): string
  Lifeboat Code Description

  Example: Guest Boat A

{
    "description":"Life Boat",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/lifeBoatCode"
        },
        "description":{
            "$ref":"#/definitions/lifeBoatCodeDescription"
        }
    }
}

Nested Schema : musterStation

Type: object

musterStation

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[a-zA-Z0-9- ]*$

  Muster Station Code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `P`, `R`, `C` Profile Types * Ignored if given only other Profile Types

  Example: A
• description(optional): string
  Musterstation Code Description

  Example: Guest Deck 1

{
    "description":"musterStation",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/musterStationCode"
        },
        "description":{
            "$ref":"#/definitions/musterStationCodeDescription"
        }
    }
}

Nested Schema : otherParameter

Type: object

Other Parameters

Show Source

• isAirSeaOperator(optional): boolean
  Is Air Sea Operator

  Example: false
• isChargeCheckedOutCalls(optional): boolean
  Is Charge For Checked Out Calls

  Example: false
• isCompleteOnlineForm(optional): boolean
  Is Complete Online Form

  Example: false
• isExpressCheckOut(optional): boolean
  Is Express Checkout

  Example: false
• isGroupLeader(optional): boolean
  Is Group Leader

  Example: false
• isKioskCheckInAllowed(optional): boolean
  Is Kiosk Check In Allowed

  Example: false
• isNonInclusiveGuestType(optional): boolean
  Is Non Inclusive Guest Type

  Example: false
• isResident(optional): boolean
  Is Resident

  Example: false
• isStayOvernightTour(optional): boolean
  Is Stay Overnight Tour

  Example: false
• isSwitchToCrewManifest(optional): boolean
  Is Switch To Crew Manifest

  Example: false

{
    "description":"Other Parameters",
    "type":"object",
    "properties":{
        "isResident":{
            "$ref":"#/definitions/isResident"
        },
        "isAirSeaOperator":{
            "$ref":"#/definitions/isAirSeaOperator"
        },
        "isExpressCheckOut":{
            "$ref":"#/definitions/isExpressCheckOut"
        },
        "isGroupLeader":{
            "$ref":"#/definitions/isGroupLeader"
        },
        "isCompleteOnlineForm":{
            "$ref":"#/definitions/isCompleteOnlineForm"
        },
        "isNonInclusiveGuestType":{
            "$ref":"#/definitions/isNonInclusiveGuestType"
        },
        "isChargeCheckedOutCalls":{
            "$ref":"#/definitions/isChargeCheckedOutCalls"
        },
        "isSwitchToCrewManifest":{
            "$ref":"#/definitions/isSwitchToCrewManifest"
        },
        "isStayOvernightTour":{
            "$ref":"#/definitions/isStayOvernightTour"
        },
        "isKioskCheckInAllowed":{
            "$ref":"#/definitions/isKioskCheckInAllowed"
        }
    }
}

Nested Schema : profileInformation

Type: object

Profile Information

Show Source

• birthPlace(optional): string
  Maximum Length: 50

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

  Birth Place * `null` if empty

  Example: KL
• dateOfBirth(optional): string(ISO 8601 (YYYY-MM-DD))
  Date of Birth

  Example: 1970-02-15
• 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
• gender(optional): object gender
  Gender
• guestCategories(optional): array guestCategory
• 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
• passportIssuedCountry(optional): object passportIssuedCountry
  Passport Issued Country
• passportIssuedDate(optional): string(ISO 8601)
  Passport Issued Date

  Example: 2009-10-31
• passportIssuedExpiryDate(optional): string(date)
  Passport Issued Expiry Date

  Example: 2018-11-11
• 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
• permanentResidentId(optional): string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Permanent Resident

  Example: P123
• profileId(optional): integer
  Profile ID

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

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

  Royalty Number * `null` if empty

  Example: a1234
• salutation(optional): string
  Salutation

  Example: Dr.
• title(optional): string
  Title

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

{
    "description":"Profile Information",
    "type":"object",
    "properties":{
        "profileId":{
            "$ref":"#/definitions/profileId"
        },
        "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/gender"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "nationality":{
            "$ref":"#/definitions/nationality"
        },
        "nationalId":{
            "$ref":"#/definitions/nationalId"
        },
        "birthPlace":{
            "$ref":"#/definitions/birthPlace"
        },
        "passportNumber":{
            "$ref":"#/definitions/passportNumber"
        },
        "passportIssuedDate":{
            "$ref":"#/definitions/passportIssuedDate"
        },
        "passportIssuedExpiryDate":{
            "$ref":"#/definitions/passportIssuedExpiryDate"
        },
        "passportIssuedCountry":{
            "$ref":"#/definitions/passportIssuedCountry"
        },
        "passportIssuedPlace":{
            "$ref":"#/definitions/passportIssuedPlace"
        },
        "vip":{
            "$ref":"#/definitions/vip"
        },
        "guestCategories":{
            "$ref":"#/definitions/guestCategory"
        },
        "permanentResidentId":{
            "$ref":"#/definitions/permanentResidentId"
        },
        "royaltyNumber":{
            "$ref":"#/definitions/royaltyNumber"
        },
        "maritalStatus":{
            "$ref":"#/definitions/maritalStatus"
        }
    }
}

Nested Schema : gender

Type: object

Gender

Show Source

• code(optional): string
  Pattern: ^[FMX]$

  Gender Code

  Example: F
• description(optional): string
  Gender Name

  Example: Female

{
    "description":"Gender",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/genderCode"
        },
        "description":{
            "$ref":"#/definitions/genderDescription"
        }
    }
}

Nested Schema : guestCategory

Type: array

Show Source

• Array of: object guestCategoryGroup
  Guest Category Group

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

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 : 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"
        }
    }
}

Nested Schema : vip

Type: object

VIP

Show Source

• code(optional): string
  Maximum Length: 6

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

  VIP Code

  Example: L1
• description(optional): string
  VIP Code Description

  Example: Minister

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

Nested Schema : guestCategoryGroup

Type: object

Guest Category Group

Show Source

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

  Guest Category Codes

  Example: GC1
• description(optional): string
  Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]

  Guest Category Codes Description

  Example: Couple

{
    "description":"Guest Category Group",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/guestCategoryCodes"
        },
        "description":{
            "$ref":"#/definitions/guestCategoryCodesDescription"
        }
    }
}

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"
        }
    }
}

204 Response

No Content

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/guestReservationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Invalid parameter(s) passed in"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Invalid parameter(s) passed in"
}

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/guestReservationErrorResponse"
        }
    ],
    "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/guestReservationErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

Example:

{
    "type":"https://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"
        }
    }
}

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/guestReservationErrorResponse"
        }
    ],
    "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(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/guestReservationErrorResponse"
        }
    ],
    "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"
        }
    }
}

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/guestReservationErrorResponse"
        }
    ],
    "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(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/guestReservationErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable. Try again later"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable. Try again later"
}

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