Update check-in reservation status and add additional validations.
post
/spms/v2/ships/{shipId}/reservations/checkIns
This is to update check-in reservation status then add a few more additional validations as per below: 1) Auto guardian assignment for minor 2) Send a message to inform the housekeeper that the person had checked in
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number(12345678)
Ship ID
Reservation Id
Root Schema : reservationId
Type:
number
Minimum Value:
1
Pattern:
^[0-9]*$
Reservation Id
Example:
1001
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : ReservationCheckInResult
Type:
object
Title:
Show Source
ReservationCheckInResult
-
item(optional):
object item
Empty body with 200 HTTP response status code
Nested Schema : item
Type:
object
Empty body with 200 HTTP response status code
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
BadRequest in ReservationCheckIn
Title:
BadRequest in ReservationCheckIn
Nested Schema : BadRequest in ReservationCheckIn
Type:
object
Title:
Show Source
BadRequest in ReservationCheckIn
-
detail(optional):
string
-
errorDetails(optional):
array errorDetails
A list of object that contains error message and field group by category.
-
type(optional):
string
Nested Schema : errorDetails
Type:
array
A list of object that contains error message and field group by category.
Show Source
Example Response (application/json)
{
"title":"Bad Request",
"detail":"Check-in Successful",
"errorDetails":[
{
"errorPath":"auto guardian assignment",
"detail":"System fails to assign a guardian for minor ",
"severity":"warning"
},
{
"errorPath":"housekeeping notification",
"detail":"System fails to send message to inform housekeeper that is checked in",
"severity":"warning"
}
]
}
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":"Unauthorized",
"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
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.5",
"title":"Not Found",
"detail":"Ship 123 was not found"
}
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":"http://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
406 Response
Not Acceptable
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.7",
"title":"Not Acceptable",
"detail":"Request a Mime type that is supported for this Resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
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.16",
"title":"Invalid content",
"detail":"Content type Not supported"
}
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":"http://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