1. Oracle Hospitality Cruise Property Management REST API 23.1.4
  2. Tasks
  3. Reservations
  4. Spa Appointment Details

Retrieve spa appointment

get

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

This is to retrieve the spa appointment that linked to a cruise reservation

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Return SPA appointment details by reservation id
Body ()
Root Schema : SPA Reservation Details
Type: object
Title: SPA Reservation Details
Show Source
Nested Schema : spaAppointmentDetails
Type: array
SPA Appointment Details
Show Source
Example:
[
    {
        "spaBookingId":"1",
        "treatmentName":"CL-SPA Therapy - 30mins",
        "spaPackageName":"package name",
        "appointmentDate":"2009-10-31",
        "appointmentTime":"06:59:00",
        "treatmentDuration":"comment",
        "appointmentComments":"Testing",
        "treatmentPrice":"50",
        "treatmentRoom":{
            "id":"1",
            "code":"ZEN",
            "description":"ZEN LOUNGE",
            "comments":"ZEN Comments",
            "availability":"Y"
        },
        "assignedTherapist":{
            "id":"1",
            "firstName":"Purnami",
            "lastName":"Dewa Ayu"
        },
        "bookingStatus":"finished",
        "postingStatus":"posted"
    }
]
Nested Schema : spaAppointments
Type: object
SPA Appointment Details
Show Source
Nested Schema : assignedTherapist
Type: object
Assigned Therapist
Show Source
  • Minimum Length: 1
    Maximum Length: 40
    Therapist First Name
    Example: Purnami
  • Minimum Value: 1
    Pattern: ^[0-9]*$
    Therapist Id
    Example: 1
  • Minimum Length: 1
    Maximum Length: 40
    Therapist Last Name
    Example: Dewa Ayu
Nested Schema : treatmentRoom
Type: object
Treatment Room
Show Source
  • Maximum Length: 1
    Treatment Room Availability
    Example: Y
  • Minimum Length: 1
    Maximum Length: 20
    Treatment Room Code
    Example: ZEN
  • Minimum Length: 1
    Maximum Length: 400
    Treatment Room Comments
    Example: ZEN LOUNGE is luxury SPA treatment room.
  • Minimum Length: 1
    Maximum Length: 50
    Treatment Room Description
    Example: ZEN LOUNGE
  • Minimum Value: 1
    Pattern: ^[0-9]*$
    Treatment Room Id
    Example: 1

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "title":"Bad Request",
    "detail":"Invalid Booking Status.",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

401 Response

You are not authorized to use this API
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

403 Response

You are forbidden to use this API
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "title":"Forbidden",
    "detail":"Access to this resource is forbidden",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4"
}
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:
{
    "title":"Not Found",
    "detail":"Spa Details Not Found.",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

405 Response

This method is not available
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6"
}
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:
{
    "title":"Not Acceptable",
    "detail":"Request a Mime type that is supported for this Resource",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

500 Response

Error occured while processing this request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "title":"Internal Server Error",
    "details":"Issue fulfilling request. Please retry or contact support",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source
Back to Top