1. Oracle Hospitality Cruise Property Management REST API 23.3.0
  2. Tasks
  3. Reservations
  4. Guest Messages

Retrieve guest message by reservation Id

get

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

This is to retrieve the guest message that is linked to a specific reservation Id

Request

Supported Media Types
Path Parameters
Query Parameters
  • This date shows all active messages related to the reservation.
  • Indicates the delivery status. 0 stands for Not Delivered, 1 for Delivered
    Allowed Values: [ 0, 1 ]
  • Gateway Security flag. If provided, it will filter only expected Gateway Security messages for the day. The only filters that will be applied when isGatewaySecurity flag is true are messageDeliveryType and activeMessageDate. If activeMessageDate is not provided, it will be filter based on the current Date.
  • Light Status
    Allowed Values: [ true, false ]
  • Indicates the message delivery type. 0 stands for No delivery, 1 stands Delivery during check-In, 2 stands for Delivery at gangway, 3 stands for Delivery at internal gate, 4 stands for Delivery at immigration gate
    Allowed Values: [ 0, 1, 2, 3, 4 ]
  • order by isLightStatus and createdDateTime with format column1:asc/desc,column2:asc/desc
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:
[
    {
        "shipId":"186000000117",
        "reservationId":2966243,
        "messageId":21,
        "senderName":"Front Office",
        "messageText":"Overdue balance",
        "isLightStatus":"ON",
        "messageDeliveryType":"No delivery",
        "messageAcknowledgementType":"Manager Acknowledge with log",
        "messageType":"Standard",
        "effectiveDate":"2024-07-07",
        "expiryDate":"2024-07-07",
        "isShowUntilExpired":true,
        "printedDateTime":"2021-03-31T16:00:00.000+0000",
        "createdByName":"John Smith",
        "createdDateTime":"2021-03-31T16:00:00.000+0000",
        "messageDeliveredByName":"John Smith",
        "messageDeliveredDateTime":"2021-03-31T16:00:00.000+0000"
    }
]
Nested Schema : guestMessageGETObject
Type: object
Guest Message GET Object
Show Source
Nested Schema : reservationId
Type: object
Reservation Id
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 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