1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Reservations
  4. Guest Reservation

Update a guest reservation by Id

put

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

This is to update a guest reservation detail by Reservation Id

Request

Supported Media Types
Path Parameters
Body ()
Guest Reservation PUT Object
Root Schema : guestReservationPUTObject
Type: object
Guest Reservation PUT Object
Show Source
Nested Schema : document
Type: object
Document
Show Source
Nested Schema : otherParameter
Type: object
Other Parameters
Show Source
Nested Schema : profileInformationPOST
Type: object
Profile Information for Post
Show Source
Nested Schema : guestCategoryPOST
Type: array
Show Source
  • Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Guest Category Codes
    Example: GC1
Nested Schema : maritalStatusCode
Type: object
maritalStatusCode
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[a-zA-Z0-9 ]{1,6}$
    Marital Status Code
    Example: D
  • 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.
  • Minimum Value: 1
    Maximum Value: 1000
    Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$
    Account Category Description
    Example: Profit and Loss Account
  • Minimum Length: 1
    Maximum Length: 10
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Currency Exchange Id
    Example: 12345
  • This is to indicate switch to enable / disable account category (default value: true) * `true` - Enable account category * `false` - Disable account category
    Example: true
Back to Top

Response

Supported Media Types

200 Response

Updated
Body ()
Root Schema : guestReservationGETObject
Type: object
Guest Reservation GET Object
Show Source
Nested Schema : discountTemplate
Type: object
Discount Template
Show Source
Nested Schema : disembarkationHarbor
Type: object
disembarkationHarbor
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$
    Disembarkation Harbor Code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: AGSJO
  • Disembarkation Harbor Code Description
    Example: To Land
Nested Schema : document
Type: object
Document
Show Source
Nested Schema : embarkationHarbor
Type: object
Embarkation Harbor
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[a-zA-Z0-9 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$
    Embarkation Harbor Code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types
    Example: AGSJO
  • Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-<>?/\|,.":;{}[]
    Embarkation Harbor Code Description
    Example: To Sea
Nested Schema : lifeBoat
Type: object
Life Boat
Show Source
Nested Schema : musterStation
Type: object
musterStation
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[a-zA-Z0-9- ]*$
    Muster Station Code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For `P`, `R`, `C` Profile Types * Ignored if given only other Profile Types
    Example: A
  • Musterstation Code Description
    Example: Guest Deck 1
Nested Schema : otherParameter
Type: object
Other Parameters
Show Source
Nested Schema : profileInformation
Type: object
Profile Information
Show Source
Nested Schema : gender
Type: object
Gender
Show Source
Nested Schema : guestCategory
Type: array
Show Source
Nested Schema : maritalStatus
Type: object
Marital Status
Show Source
Nested Schema : passportIssuedCountry
Type: object
Passport Issued Country
Show Source
Nested Schema : vip
Type: object
VIP
Show Source
Nested Schema : guestCategoryGroup
Type: object
Guest Category Group
Show Source
Nested Schema : maritalStatusCode
Type: object
maritalStatusCode
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[a-zA-Z0-9 ]{1,6}$
    Marital Status Code
    Example: D
  • 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.
  • Minimum Value: 1
    Maximum Value: 1000
    Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$
    Account Category Description
    Example: Profit and Loss Account
  • Minimum Length: 1
    Maximum Length: 10
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Currency Exchange Id
    Example: 12345
  • This is to indicate switch to enable / disable account category (default value: true) * `true` - Enable account category * `false` - Disable account category
    Example: true

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":"The parameter shipId has incorrect format"
}
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":"https://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":"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

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":"Update is not allowed for Guest that have checked out."
}
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":"Invalid content",
    "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

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable. Try again later"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source
Back to Top