Retrieve list of all Excursion bookings for a reservation
get
/spms/v1/onboardActivities/{reservationId}/bookings/excursions
This is to retrieve a list of all Excursion bookings for a reservation
Request
Supported Media Types
- application/json
Path Parameters
Query Parameters
-
status: string
Allowed Values:
[ "posted", "unposted" ]
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Onboard activity list
Type:
object
Title:
Onboard activity list
The object returned in Oracle Standard when function is executed successfully
Show Source
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Excursion Activity Listing
Title:
Excursion Activity Listing
Retrieve Excursion activity
Nested Schema : Excursion Activity Listing
Type:
object
Title:
Excursion Activity Listing
Retrieve Excursion activity
Show Source
-
activity(optional):
string
Example:
Excursion
-
bookingStatus(optional):
array bookingStatus
Nested Schema : bookingStatus
Type:
Show Source
array
-
Array of:
object Excursion Booking status
Title:
Excursion Booking status
Retrieve Excursion reservation booking status
Nested Schema : Excursion Booking status
Type:
object
Title:
Excursion Booking status
Retrieve Excursion reservation booking status
Show Source
-
bookings(optional):
array bookings
-
count(optional):
integer
Example:
1
-
status(optional):
string
Allowed Values:
[ "posted", "unposted" ]
Nested Schema : bookings
Type:
Show Source
array
-
Array of:
object Excursion Booking number
Title:
Excursion Booking number
Retrieve Excursion reservation booking number
Nested Schema : Excursion Booking number
Type:
object
Title:
Excursion Booking number
Retrieve Excursion reservation booking number
Show Source
-
booking number(optional):
integer
Example:
132154
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Bad Request",
"detail":"The parameter 'reservationId' has incorrect format"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
"title":"Unauthorised",
"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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"Access to this resource was forbidden"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
404 Response
Not Found
Root Schema : schema
Allowed Values:
[
"Invalid booking status",
"Invalid reservation ID"
]
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
"title":"Not Found",
"detail":"Invalid reservation ID"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://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
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://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
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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