1. Oracle Hospitality Cruise Property Management REST API 23.2.2
  2. Tasks
  3. Reservations
  4. Amenities

Retrieve Amenities Record by reservation Id

get

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

This is to retrieve Amenities according to Reservation Id

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Oracle Responses list
Type: object
Title: Oracle Responses list
The wrapper object when returning successful values in Oracle standard
Show Source
Nested Schema : items
Type: array
Show Source
Example:
[
    {
        "reservationId":"123",
        "amenityId":"456",
        "amenityCode":"456",
        "amenityCodeDescription":"Wedding Anniversary Cake",
        "notes":"Please keep refrigerated.",
        "comments":"5th Wedding Anniversary Celebration",
        "codeExtension":"256",
        "quantity":"1",
        "price":"150",
        "cost":"75",
        "currency":{
            "departmentId":"USD",
            "comment":"US Dollar"
        },
        "applicable":"P",
        "flag":"N",
        "amenityStatus":"Active",
        "sender":{
            "sender1":"Mr. Niel Down",
            "sender2":"Ms. Anna Donimo"
        },
        "senderMessage":"Happy Wedding Anniversary",
        "deliveryStatus":"Pending",
        "deliveryDivision":{
            "code":"789",
            "description":"F&B Services"
        },
        "deliveryDateTime":"2015-09-09T16:00:00",
        "deliveryLocation":"Dinner",
        "occurrence":"1",
        "completedBy":"A",
        "completedDateTime":"2015-09-09T16:00:00",
        "createdBy":"A",
        "createdDateTime":"2015-09-09T16:00:00",
        "lastModifiedDateTime":"2015-09-09T16:00:00",
        "amenityCancelReason":null
    },
    {
        "reservationId":"123",
        "amenityId":"123",
        "amenityCode":"821",
        "amenityCodeDescription":"Anniversary Flower Bouquet",
        "notes":"Some notes.",
        "comments":"5th Wedding Anniversary Celebration",
        "codeExtension":"256",
        "quantity":"1",
        "price":"50",
        "cost":"10",
        "currency":{
            "departmentId":"USD",
            "comment":"US Dollar"
        },
        "applicable":"P",
        "flag":"N",
        "amenityStatus":"Active",
        "sender":{
            "sender1":"Mr. Niel Down",
            "sender2":"Ms. Anna Donimo"
        },
        "senderMessage":"Happy 5th Wedding Anniversary",
        "deliveryDivision":{
            "code":"789",
            "description":"Front Office Concierge"
        },
        "deliveryDateTime":"2015-09-09T16:00:00",
        "deliveryLocation":"Stateroom 19022",
        "occurrence":"1",
        "completedBy":"HKJackson A",
        "completedDateTime":"2015-09-09T16:00:00",
        "createdBy":"FOPolly Pipe",
        "createdDateTime":"2015-09-09T16:00:00",
        "lastModifiedDateTime":"2015-09-09T16:00:00",
        "amenityCancelReason":null
    },
    {
        "reservationId":"321",
        "amenityId":"567",
        "amenityCode":"456",
        "amenityCodeDescription":"Extra Big Towel",
        "notes":"To be delivered from 3-5pm.'",
        "comments":"Big Towel with logo",
        "codeExtension":"256",
        "quantity":"1",
        "price":"0",
        "cost":"0",
        "currency":{
            "departmentId":"",
            "comment":""
        },
        "applicable":"P",
        "flag":"N",
        "amenityStatus":"Active",
        "sender":{
            "sender1":"",
            "sender2":""
        },
        "senderMessage":"",
        "deliveryStatus":"Delivered",
        "deliveryDivision":{
            "code":"789",
            "description":"Houskeeping"
        },
        "deliveryDateTime":"2015-09-09T16:00:00",
        "deliveryLocation":"Stateroom 19022",
        "occurrence":"1",
        "completedBy":"HKJenny O",
        "completedDateTime":"2015-09-09T16:00:00",
        "createdBy":"FOPolly Pipe",
        "createdDateTime":"2015-09-09T16:00:00",
        "lastModifiedDateTime":"2015-09-09T16:00:00",
        "amenityCancelReason":null
    }
]
Nested Schema : AmenityGETObject
Type: object
Amenities GET Object
Show Source
Nested Schema : currency
Type: object
Currency Group
Show Source
  • Currency Description
    Example: US Dollar
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Currency Code * `null` if empty
    Example: USD
Nested Schema : deliveryDivision
Type: object
Delivery Division Group
Show Source
  • Minimum Length: 1
    Maximum Length: 10
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Delivery Division Code * `null` if empty
    Example: REST
  • Delivery Division Description
    Example: Restaurant
Nested Schema : sender
Type: object
Sender group
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Sender 1 * `null` if empty
    Example: Mr. Niel Down
  • Minimum Length: 1
    Maximum Length: 40
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Sender 2 * `null` if empty
    Example: Anna Domino

204 Response

No Content

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
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

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
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

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was forbidden"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

404 Response

Not Found
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship Id could not be found"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

405 Response

Method Not Allowed
Body ()
Root Schema : schema
Match All
Show Source
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

406 Response

Not Acceptable
Body ()
Root Schema : schema
Match All
Show Source
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

410 Response

Gone
Body ()
Root Schema : schema
Match All
Show Source
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

415 Response

Unsupported Media Type
Body ()
Root Schema : schema
Match All
Show Source
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

500 Response

Internal Server Error
Body ()
Root Schema : schema
Match All
Show Source
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

501 Response

Not Implemented
Body ()
Root Schema : schema
Match All
Show Source
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

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
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
Back to Top