Retrieve the check-in settings at the gangway
get
/spms/v2/ships/{shipId}/configurations/checkIns
This is to retrieve the check-in settings
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number(12345678)
Ship Id
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : getCheckInSettings
Type:
object
Check In Settings
Show Source
-
autoGuardianAssignment(optional):
array autoGuardianAssignment
-
houseKeepingNotification(optional):
array houseKeepingNotification
-
preCruisePostingAllowed(optional):
array preCruisePostingAllowed
Example:
{
"preCruisePostingAllowed":[
{
"name":"Post pre posting during check-in",
"value":"1"
}
],
"houseKeepingNotification":[
{
"name":"Enable Auto Alert Message upon Guest Check-In",
"value":"1"
}
],
"autoGuardianAssignment":[
{
"name":"Guardian Auto Assignment",
"value":"1"
}
]
}
Nested Schema : autoGuardianAssignment
Type:
Show Source
array
-
Array of:
object CheckInWithGuardianAutoAssignment
Title:
CheckInWithGuardianAutoAssignment
Nested Schema : houseKeepingNotification
Type:
Show Source
array
-
Array of:
object CheckInAutoAlert
Title:
CheckInAutoAlert
Nested Schema : preCruisePostingAllowed
Type:
Show Source
array
-
Array of:
object Check-in settings
Title:
Check-in settings
Nested Schema : CheckInWithGuardianAutoAssignment
Type:
object
Title:
Show Source
CheckInWithGuardianAutoAssignment
-
name(optional):
string
Parameter NameExample:
Guardian Auto Assignment
-
value(optional):
string
Parameter Value (default value: 0)Example:
1
Nested Schema : CheckInAutoAlert
Type:
object
Title:
Show Source
CheckInAutoAlert
-
name(optional):
string
Parameter NameExample:
Enable Auto Alert Message upon Guest Check-In
-
value(optional):
string
Parameter Value (default value: 0)Example:
1
Nested Schema : Check-in settings
Type:
object
Title:
Show Source
Check-in settings
-
name(optional):
string
Parameter NameExample:
Post pre posting during check-in
-
value(optional):
string
Parameter Value (default value: 1)Example:
1
204 Response
No Content
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":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"Access to this resource is 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.5",
"title":"Not Found",
"detail":"This resource path does not exist"
}
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
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