Jump to

• Request
• Response

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

• application/json

Path Parameters

• reservationId: number
• shipId: number
  Ship Id

Query Parameters

• appointmentDateFrom(optional): string
  Appointment Date From
• appointmentDateTo(optional): string
  Appointment Date To
• bookingStatus(optional): string
  Booking Status

  Allowed Values: [ "in house", "finished", "expected" ]
• spaBookingId(optional): number
  SPA Booking Id
• treatmentName(optional): string
  Treatment Name

Back to Top

Response

Supported Media Types

• application/json

200 Response

Return SPA appointment details by reservation id

Body ()

Root Schema : SPA Reservation Details

Type: object

Title: SPA Reservation Details

Show Source

• reservationId(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Reservation Id

  Example: 1001
• spaAppointmentDetails(optional): array spaAppointmentDetails
  SPA Appointment Details

{
    "title":"SPA Reservation Details",
    "type":"object",
    "properties":{
        "reservationId":{
            "$ref":"#/definitions/reservationIdNumber"
        },
        "spaAppointmentDetails":{
            "$ref":"#/definitions/spaAppointmentDetails"
        }
    }
}

Nested Schema : spaAppointmentDetails

Type: array

SPA Appointment Details

Show Source

• Array of: object spaAppointments
  SPA Appointment Details

{
    "description":"SPA Appointment Details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/spaAppointments"
    },
    "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"
        }
    ]
}

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

• appointmentComments(optional): string
  Minimum Length: 1

  Maximum Length: 255

  Appointment Comments

  Example: SI 27
• appointmentDate(optional): string(ISO 8601)
  Appointment Date

  Example: 2009-10-31
• appointmentTime(optional): string(ISO 8601)
  Appointment Time

  Example: 06:59:00
• assignedTherapist(optional): object assignedTherapist
  Assigned Therapist
• bookingStatus(optional): string
  Allowed Values: [ "check in", "expected" ]

  Booking Status

  Example: check in
• postingStatus(optional): string
  Allowed Values: [ "posted", "unposted", "onhold" ]

  Posting Status

  Example: posted
• spaBookingId(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Spa Booking Id

  Example: 1001
• spaPackageName(optional): string
  Minimum Length: 1

  Maximum Length: 50

  SPA Package Name

  Example: SPA Package Name
• treatmentDuration(optional): number
  Minimum Value: 0

  Treatment Duration

  Example: 30
• treatmentName(optional): string
  Minimum Length: 1

  Maximum Length: 50

  Treatment Name

  Example: CL-SPA Therapy - 30mins
• treatmentPrice(optional): number
  treatment Price

  Example: 50
• treatmentRoom(optional): object treatmentRoom
  Treatment Room

{
    "description":"SPA Appointment Details",
    "type":"object",
    "properties":{
        "spaBookingId":{
            "$ref":"#/definitions/spaBookingId"
        },
        "treatmentName":{
            "$ref":"#/definitions/treatmentName"
        },
        "spaPackageName":{
            "$ref":"#/definitions/spaPackageName"
        },
        "appointmentDate":{
            "$ref":"#/definitions/appointmentDate"
        },
        "appointmentTime":{
            "$ref":"#/definitions/appointmentTime"
        },
        "treatmentDuration":{
            "$ref":"#/definitions/treatmentDuration"
        },
        "appointmentComments":{
            "$ref":"#/definitions/appointmentComments"
        },
        "treatmentPrice":{
            "$ref":"#/definitions/treatmentPrice"
        },
        "treatmentRoom":{
            "$ref":"#/definitions/treatmentRoom"
        },
        "assignedTherapist":{
            "$ref":"#/definitions/assignedTherapist"
        },
        "bookingStatus":{
            "$ref":"#/definitions/bookingStatus"
        },
        "postingStatus":{
            "$ref":"#/definitions/postingStatus"
        }
    }
}

Nested Schema : assignedTherapist

Type: object

Assigned Therapist

Show Source

• firstName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Therapist First Name

  Example: Purnami
• id(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Therapist Id

  Example: 1
• lastName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Therapist Last Name

  Example: Dewa Ayu

{
    "description":"Assigned Therapist",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/therapistId"
        },
        "firstName":{
            "$ref":"#/definitions/therapistFirstName"
        },
        "lastName":{
            "$ref":"#/definitions/therapistLastName"
        }
    }
}

Nested Schema : treatmentRoom

Type: object

Treatment Room

Show Source

• availability(optional): string
  Maximum Length: 1

  Treatment Room Availability

  Example: Y
• code(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Treatment Room Code

  Example: ZEN
• comments(optional): string
  Minimum Length: 1

  Maximum Length: 400

  Treatment Room Comments

  Example: ZEN LOUNGE is luxury SPA treatment room.
• description(optional): string
  Minimum Length: 1

  Maximum Length: 50

  Treatment Room Description

  Example: ZEN LOUNGE
• id(optional): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Treatment Room Id

  Example: 1

{
    "description":"Treatment Room",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/treatmentRoomId"
        },
        "code":{
            "$ref":"#/definitions/treatmentRoomCode"
        },
        "description":{
            "$ref":"#/definitions/treatmentRoomDescription"
        },
        "comments":{
            "$ref":"#/definitions/treatmentRoomComments"
        },
        "availability":{
            "$ref":"#/definitions/treatmentRoomAvailability"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/SPAReservationsErrorResponse"
        }
    ],
    "example":{
        "title":"Bad Request",
        "detail":"Invalid Booking Status.",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

You are not authorized to use this API

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/SPAReservationsErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

You are forbidden to use this API

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/SPAReservationsErrorResponse"
        }
    ],
    "example":{
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/SPAReservationsErrorResponse"
        }
    ],
    "example":{
        "title":"Not Found",
        "detail":"Spa Details Not Found.",
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

This method is not available

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/SPAReservationsErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/SPAReservationsErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Error occured while processing this request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/SPAReservationsErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top