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

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
Path Parameters
Body ()
Amenity Object
Root Schema : AmenityPUTObject
Type: object
Amenities PUT Object
Show Source
  • Minimum Length: 1
    Maximum Length: 100
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Amenity Cancel Reason * `null` if empty
    Example: Cancel by Guest
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Amenity Code
    Example: 821
  • Minimum Length: 1
    Pattern: ^[0-9]*$
    Amenity Id
    Example: 1001
  • Allowed Values: [ "Active", "Cancelled" ]
    Amenities Status
    Example: Active
  • Allowed Values: [ "Pax", "Cabin" ]
    Applicable
    Example: Pax
  • Minimum Length: 1
    Maximum Length: 15
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Code Extension * `null` if empty
    Example: 821
  • Minimum Length: 1
    Maximum Length: 2500
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Amenity Comments * `null` if empty
    Example: Guest comments
  • Pattern: ^[0-9]*$
    Cost * `null` if empty
    Example: 10
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Currency Code * `null` if empty
    Example: USD
  • Delivery Date Time * `null` if empty
    Example: 2015-09-09T16:00:00
  • Minimum Length: 1
    Maximum Length: 10
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Delivery Division Code * `null` if empty
    Example: REST
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Delivery Location * `null` if empty
    Example: Restaurant Blue Ocean
  • Allowed Values: [ "Pending", "Delivered" ]
    Amenity Delivery Status
    Example: Pending
  • Minimum Length: 0
    Maximum Length: 1
    Displayed as Flag in the Amenities section in guest billing screen
  • Minimum Length: 1
    Maximum Length: 2500
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Amenity Notes * `null` if empty
    Example: Some notes.
  • Minimum Length: 1
    Maximum Length: 10
    Delivery Occurrence * `null` if empty
    Example: Once
  • Pattern: ^[0-9]*$
    Price * `null` if empty
    Example: 10
  • Pattern: ^[0-9]*$
    Quantity * `null` if empty
    Example: 1
  • Minimum Length: 1
    Pattern: ^[0-9]*$
    Reservation Id
    Example: 1001
  • 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
  • Minimum Length: 1
    Maximum Length: 255
    Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Sender Message * `null` if empty
    Example: Happy Wedding Anniversary
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root 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

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":"You are forbidden to use this API"
}
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":"Amenity 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 Allowed",
    "detail":"The method is not available"
}
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

409 Response

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

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":"Error occurred while processing this request"
}
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