Retrieve the onboard status for a profile
get
/spms/v1/reservations/{id}/onboardStatus
This is to retrieve the onboard status for a profile
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : schema
Match All
Show Source
-
object
Reservation onboard status
Title:
Reservation onboard status
Reservation onboard status
Nested Schema : Reservation onboard status
Type:
object
Title:
Reservation onboard status
Reservation onboard status
Show Source
-
onBoardStatus(optional):
string
Onboard StatusExample:
onboard
-
reservationId(optional):
integer
Reservation IdExample:
100
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
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":"Not Found",
"detail":"Reservation Id is missing!"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Supported
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
409 Response
Conflict
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.10",
"title":"Method Not Allowed",
"detail":"Duplicate resource not allowed"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source