1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Reservations
  4. Special Requests

Retrieve special requests by reservation ID

get

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

This is to retrieve the special requests that linked to a specific reservation ID

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Special Request Responses list
Type: object
Title: Special Request Responses list
The wrapper object when returning successful values in Oracle standard
Show Source
Nested Schema : items
Type: array
Show Source
Example:
[
    {
        "reservationId":123,
        "specialRequestId":123,
        "specialRequestActionCode":"BIRTHC",
        "specialRequestActionDescription":"Birthday Cake Celebration",
        "externalCode":123,
        "quantity":1,
        "requestedDateTime":"2015-09-09T16:00:00",
        "deliveryLocation":"Stateroom 1001",
        "deliveryStatus":"Delivered",
        "deliveredDateTime":"2018-08-08T20:00:00",
        "deliveredBy":"Michael Philip",
        "createdDateTime":"2021-11-01T10:28:19",
        "createdBy":"Laura G",
        "lastModifiedDateTime":"2021-11-01T10:28:19",
        "specialRequestActionDepartmentCode":111,
        "specialRequestActionDepartmentDescription":"Bartender",
        "completedDateTime":"2021-11-11T21:38:29"
    },
    {
        "reservationId":234,
        "specialRequestId":234,
        "specialRequestActionCode":"WDCKAN",
        "specialRequestActionDescription":"Wedding Cake Anniversary",
        "externalCode":null,
        "quantity":2,
        "requestedDateTime":"2020-05-26T12:15:00",
        "deliveryLocation":"Stateroom 1002",
        "deliveryStatus":"Delivered",
        "deliveredDateTime":"2021-09-30T22:00:00",
        "deliveredBy":"Mary Jane",
        "createdDateTime":"2021-11-01T10:28:20",
        "createdBy":"Albert Guisseco",
        "lastModifiedDateTime":"2021-11-01T10:28:20",
        "specialRequestActionDepartmentCode":222,
        "specialRequestActionDepartmentDescription":"Waiter",
        "completedDateTime":"2021-11-11T22:48:39"
    },
    {
        "reservationId":345,
        "specialRequestId":345,
        "specialRequestActionCode":"WHELC",
        "specialRequestActionDescription":"Wheelchair",
        "externalCode":null,
        "quantity":3,
        "requestedDateTime":"2020-10-09T03:30:00",
        "deliveryLocation":"Stateroom 1003",
        "deliveryStatus":"Pending",
        "deliveredDateTime":"2021-07-26T21:00:00",
        "deliveredBy":"Jade Bond",
        "createdDateTime":"2021-11-01T10:28:21",
        "createdBy":"Laura Mason",
        "lastModifiedDateTime":"2021-11-01T10:28:21",
        "specialRequestActionDepartmentCode":333,
        "specialRequestActionDepartmentDescription":"Chef",
        "completedDateTime":null
    }
]
Nested Schema : SpecialRequestGETObject
Type: object
SpecialRequest GET Object
Show Source

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 is 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":"Reservation 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