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 StatusAllowed Values:
[ "in house", "finished", "expected" ]
-
spaBookingId(optional): number
SPA Booking Id
-
treatmentName(optional): string
Treatment Name
Response
Supported Media Types
- application/json
200 Response
Return SPA appointment details by reservation id
Root Schema : SPA Reservation Details
Type:
object
Title:
Show Source
SPA Reservation Details
-
reservationId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Reservation IdExample:1001
-
spaAppointmentDetails(optional):
array spaAppointmentDetails
SPA Appointment Details
Nested Schema : spaAppointmentDetails
Type:
array
SPA Appointment Details
Show Source
-
Array of:
object spaAppointments
SPA Appointment Details
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 CommentsExample:SI 27
-
appointmentDate(optional):
string(ISO 8601)
Appointment DateExample:
2009-10-31
-
appointmentTime(optional):
string(ISO 8601)
Appointment TimeExample:
06:59:00
-
assignedTherapist(optional):
object assignedTherapist
Assigned Therapist
-
bookingStatus(optional):
string
Allowed Values:
[ "in house", "finished", "expected" ]
Booking StatusExample:in house
-
postingStatus(optional):
string
Allowed Values:
[ "posted", "unposted" ]
Posting StatusExample:posted
-
spaBookingId(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Spa Booking IdExample:1001
-
spaPackageName(optional):
string
Minimum Length:
1
Maximum Length:50
SPA Package NameExample:SPA Package Name
-
treatmentDuration(optional):
number
Minimum Value:
0
Treatment DurationExample:30
-
treatmentName(optional):
string
Minimum Length:
1
Maximum Length:50
Treatment NameExample:CL-SPA Therapy - 30mins
-
treatmentPrice(optional):
number
treatment PriceExample:
50
-
treatmentRoom(optional):
object treatmentRoom
Treatment Room
Nested Schema : assignedTherapist
Type:
object
Assigned Therapist
Show Source
-
firstName(optional):
string
Minimum Length:
1
Maximum Length:40
Therapist First NameExample:Purnami
-
id(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Therapist IdExample:1
-
lastName(optional):
string
Minimum Length:
1
Maximum Length:40
Therapist Last NameExample:Dewa Ayu
Nested Schema : treatmentRoom
Type:
object
Treatment Room
Show Source
-
availability(optional):
string
Maximum Length:
1
Treatment Room AvailabilityExample:Y
-
code(optional):
string
Minimum Length:
1
Maximum Length:20
Treatment Room CodeExample:ZEN
-
comments(optional):
string
Minimum Length:
1
Maximum Length:400
Treatment Room CommentsExample:ZEN LOUNGE is luxury SPA treatment room.
-
description(optional):
string
Minimum Length:
1
Maximum Length:50
Treatment Room DescriptionExample:ZEN LOUNGE
-
id(optional):
number
Minimum Value:
1
Pattern:^[0-9]*$
Treatment Room IdExample:1
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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