Jump to

• Request
• Response

Update an existing amenity record

put

/spms/v2/ships/{shipId}/reservations/{reservationId}/amenities/{amenityId}

This is to update an existing amenity record

Request

Supported Media Types

• application/json

Path Parameters

• amenityId: string
  Amenity Id
• reservationId: number
  Reservation Id
• shipId: number
  Ship Id

Body ()

Amenity Object

Root Schema : AmenityPUTObject

Type: object

Amenities PUT Object

Show Source

• amenityCancelReason(optional): string
  Minimum Length: 0

  Maximum Length: 100

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

  Example: Cancel by Guest
• amenityCode(optional): string
  Minimum Length: 1

  Maximum Length: 6

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

  Amenity Code

  Example: 821
• amenityId(optional): number
  Minimum Length: 1

  Pattern: ^[0-9]*$

  Amenity Id

  Example: 1001
• amenityStatus(optional): string
  Allowed Values: [ "Active", "Cancelled" ]

  Amenities Status

  Example: Active
• applicable(optional): string
  Allowed Values: [ "Pax", "Cabin" ]

  Applicable

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

  Code Extension

  Example: 821
• 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.
• cost(optional): number
  Pattern: ^[0-9]*$

  Cost

  Example: 10
• currencyCode(optional): string
  Minimum Length: 1

  Maximum Length: 6

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

  Currency Code

  Example: USD
• deliveryDateTime(optional): string(date-time)
  Example: 2015-09-09T16:00:00
• deliveryDivisionCode(optional): string
  Minimum Length: 0

  Maximum Length: 10

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

  Example: REST
• deliveryLocation(optional): string
  Minimum Length: 0

  Maximum Length: 30

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

  Delivery Location

  Example: Stateroom 1001
• deliveryStatus(optional): string
  Allowed Values: [ "Pending", "Delivered" ]

  Special Request Delivery Status

  Example: Delivered
• flag(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Displayed as Flag in the Amenities section in guest billing screen
• occurrence(optional): string
  Minimum Length: 0

  Maximum Length: 10

  Delivery Occurrence

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

  Price

  Example: 10
• quantity(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Quantity

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

  Pattern: ^[0-9]*$

  Reservation Id

  Example: 1001
• sender1(optional): string
  Minimum Length: 0

  Maximum Length: 255

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

  Sender 1

  Example: Mr. Niel Down
• sender2(optional): string
  Minimum Length: 0

  Maximum Length: 40

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

  Sender 2

  Example: Anna Domino
• senderMessage(optional): string
  Minimum Length: 0

  Maximum Length: 255

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

  Sender Message

  Example: Happy Wedding Anniversary

{
    "description":"Amenities PUT Object",
    "type":"object",
    "properties":{
        "reservationId":{
            "$ref":"#/definitions/reservationId"
        },
        "amenityId":{
            "$ref":"#/definitions/amenityId"
        },
        "amenityCode":{
            "$ref":"#/definitions/amenityCode"
        },
        "comments":{
            "$ref":"#/definitions/comments"
        },
        "codeExtension":{
            "$ref":"#/definitions/codeExtension"
        },
        "quantity":{
            "$ref":"#/definitions/quantity"
        },
        "price":{
            "$ref":"#/definitions/price"
        },
        "cost":{
            "$ref":"#/definitions/cost"
        },
        "currencyCode":{
            "$ref":"#/definitions/currencyCode"
        },
        "applicable":{
            "$ref":"#/definitions/applicable"
        },
        "flag":{
            "$ref":"#/definitions/flag"
        },
        "amenityStatus":{
            "$ref":"#/definitions/amenityStatus"
        },
        "sender1":{
            "$ref":"#/definitions/sender1"
        },
        "sender2":{
            "$ref":"#/definitions/sender2"
        },
        "senderMessage":{
            "$ref":"#/definitions/senderMessage"
        },
        "deliveryStatus":{
            "$ref":"#/definitions/deliveryStatus"
        },
        "deliveryDivisionCode":{
            "$ref":"#/definitions/deliveryDivisionCode"
        },
        "deliveryDateTime":{
            "$ref":"#/definitions/deliveryDateTime"
        },
        "deliveryLocation":{
            "$ref":"#/definitions/deliveryLocation"
        },
        "occurrence":{
            "$ref":"#/definitions/occurrence"
        },
        "amenityCancelReason":{
            "$ref":"#/definitions/amenityCancelReason"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : AmenityGETObject

Type: object

Amenities GET Object

Show Source

• amenityCancelReason(optional): string
  Minimum Length: 0

  Maximum Length: 100

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

  Example: Cancel by Guest
• amenityCode(optional): string
  Minimum Length: 1

  Maximum Length: 6

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

  Amenity Code

  Example: 821
• amenityId(optional): number
  Minimum Length: 1

  Pattern: ^[0-9]*$

  Amenity Id

  Example: 1001
• amenityStatus(optional): string
  Allowed Values: [ "Active", "Cancelled" ]

  Amenities Status

  Example: Active
• applicable(optional): string
  Allowed Values: [ "Pax", "Cabin" ]

  Applicable

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

  Code Extension

  Example: 821
• 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.
• completedBy(optional): string
  Completed By

  Example: FBJohn Quil
• completedDateTime(optional): string(date)
  Example: 2018-11-11T23:00:00
• cost(optional): number
  Pattern: ^[0-9]*$

  Cost

  Example: 10
• createdBy(optional): string
  Created By

  Example: Jessica Sue
• createdDateTime(optional): string(date)
  Example: 2018-08-08T18:00:00
• currency(optional): object currency
  Currency Group
• deliveryDateTime(optional): string(date-time)
  Example: 2015-09-09T16:00:00
• deliveryDivision(optional): object deliveryDivision
  Delivery Division Group
• deliveryLocation(optional): string
  Minimum Length: 0

  Maximum Length: 30

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

  Delivery Location

  Example: Stateroom 1001
• deliveryStatus(optional): string
  Allowed Values: [ "Pending", "Delivered" ]

  Special Request Delivery Status

  Example: Delivered
• description(optional): string
  Minimum Value: 1

  Maximum Value: 1000

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

  Account Category Description

  Example: Profit and Loss Account
• flag(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Displayed as Flag in the Amenities section in guest billing screen
• lastModifiedDateTime(optional): string(date-time)
  Example: 2018-08-08T18:00:00
• occurrence(optional): string
  Minimum Length: 0

  Maximum Length: 10

  Delivery Occurrence

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

  Price

  Example: 10
• quantity(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Quantity

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

  Pattern: ^[0-9]*$

  Reservation Id

  Example: 1001
• sender(optional): object sender
  Sender group
• senderMessage(optional): string
  Minimum Length: 0

  Maximum Length: 255

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

  Sender Message

  Example: Happy Wedding Anniversary

{
    "description":"Amenities GET Object",
    "type":"object",
    "properties":{
        "reservationId":{
            "$ref":"#/definitions/reservationId"
        },
        "amenityId":{
            "$ref":"#/definitions/amenityId"
        },
        "amenityCode":{
            "$ref":"#/definitions/amenityCode"
        },
        "description":{
            "$ref":"#/definitions/description"
        },
        "comments":{
            "$ref":"#/definitions/comments"
        },
        "codeExtension":{
            "$ref":"#/definitions/codeExtension"
        },
        "quantity":{
            "$ref":"#/definitions/quantity"
        },
        "price":{
            "$ref":"#/definitions/price"
        },
        "cost":{
            "$ref":"#/definitions/cost"
        },
        "currency":{
            "$ref":"#/definitions/currency"
        },
        "applicable":{
            "$ref":"#/definitions/applicable"
        },
        "flag":{
            "$ref":"#/definitions/flag"
        },
        "amenityStatus":{
            "$ref":"#/definitions/amenityStatus"
        },
        "sender":{
            "$ref":"#/definitions/sender"
        },
        "senderMessage":{
            "$ref":"#/definitions/senderMessage"
        },
        "deliveryStatus":{
            "$ref":"#/definitions/deliveryStatus"
        },
        "deliveryDivision":{
            "$ref":"#/definitions/deliveryDivision"
        },
        "deliveryDateTime":{
            "$ref":"#/definitions/deliveryDateTime"
        },
        "deliveryLocation":{
            "$ref":"#/definitions/deliveryLocation"
        },
        "occurrence":{
            "$ref":"#/definitions/occurrence"
        },
        "completedBy":{
            "$ref":"#/definitions/completedBy"
        },
        "completedDateTime":{
            "$ref":"#/definitions/completedDateTime"
        },
        "createdBy":{
            "$ref":"#/definitions/createdBy"
        },
        "createdDateTime":{
            "$ref":"#/definitions/createdDateTime"
        },
        "lastModifiedDateTime":{
            "$ref":"#/definitions/lastModifiedDateTime"
        },
        "amenityCancelReason":{
            "$ref":"#/definitions/amenityCancelReason"
        }
    }
}

Nested Schema : currency

Type: object

Currency Group

Show Source

• comment(optional): string
  Minimum Length: 0

  Maximum Length: 1000

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

  Currency Description

  Example: US Dollar
• departmentId(optional): string
  Minimum Length: 1

  Maximum Length: 6

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

  Currency Code

  Example: USD

{
    "description":"Currency Group",
    "type":"object",
    "properties":{
        "departmentId":{
            "$ref":"#/definitions/currencyCode"
        },
        "comment":{
            "$ref":"#/definitions/currencyDescription"
        }
    }
}

Nested Schema : deliveryDivision

Type: object

Delivery Division Group

Show Source

• code(optional): string
  Minimum Length: 0

  Maximum Length: 10

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

  Example: REST
• description(optional): string
  Minimum Length: 0

  Maximum Length: 1000

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

  Example: Restaurant

{
    "description":"Delivery Division Group",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/deliveryDivisionCode"
        },
        "description":{
            "$ref":"#/definitions/deliveryDivisionDescription"
        }
    }
}

Nested Schema : sender

Type: object

Sender group

Show Source

• sender1(optional): string
  Minimum Length: 0

  Maximum Length: 255

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

  Sender 1

  Example: Mr. Niel Down
• sender2(optional): string
  Minimum Length: 0

  Maximum Length: 40

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

  Sender 2

  Example: Anna Domino

{
    "description":"Sender group",
    "type":"object",
    "properties":{
        "sender1":{
            "$ref":"#/definitions/sender1"
        },
        "sender2":{
            "$ref":"#/definitions/sender2"
        }
    }
}

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/amenitiesErrorResponse"
        }
    ],
    "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/amenitiesErrorResponse"
        }
    ],
    "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/amenitiesErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"You are forbidden to use this API"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"You are forbidden to use this API"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• 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/amenitiesErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Amenity Id could not be found"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Amenity Id could not be 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/amenitiesErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Allowed",
        "detail":"The method is not available"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Allowed",
    "detail":"The method is 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"
        }
    }
}

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

409 Response

Conflict

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/amenitiesErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
        "title":"Conflict",
        "detail":"Amenity delivery status is delivered. Updating amenity will not be allowed."
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
    "title":"Conflict",
    "detail":"Amenity delivery status is delivered. Updating amenity will not be allowed."
}

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/amenitiesErrorResponse"
        }
    ],
    "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/amenitiesErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Unsupported Media Type",
        "detail":"Content type not supported"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Unsupported Media Type",
    "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/amenitiesErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Error occurred while processing this request"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Error occurred while processing this request"
}

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