Retrieve check-in settings for the gangway only
get
/spms/v2/ships/{shipId}/configurations/checkIns/gangway
This is to retrieve the check-in settings for the gangway only
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number(12345678)
Ship Id
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Check In Settings for gangway only
Type:
object
Title:
Check In Settings for gangway only
Check In Settings for gangway only
Show Source
-
checkInCrewAllowed(optional):
array checkInCrewAllowed
-
checkInGuestAndResidentAllowed(optional):
array checkInGuestAndResidentAllowed
-
checkInVisitorAllowed(optional):
array checkInVisitorAllowed
-
multipleCheckInAllowed(optional):
array multipleCheckInAllowed
Example:
{
"checkInGuestAndResidentAllowed":[
{
"name":"Check-in via FC Security",
"value":"1"
}
],
"checkInCrewAllowed":[
{
"name":"Check-in via FC Security - Crew",
"value":"1"
}
],
"checkInVisitorAllowed":[
{
"name":"Check-in via FC Security - Visitor",
"value":"1"
}
],
"multipleCheckInAllowed":[
{
"name":"Extended Search Criteria Check in",
"value":"1"
}
]
}
Nested Schema : checkInCrewAllowed
Type:
Show Source
array
-
Array of:
object CheckInCrew
Title:
CheckInCrew
Nested Schema : checkInGuestAndResidentAllowed
Type:
Show Source
array
-
Array of:
object CheckInResident
Title:
CheckInResident
Nested Schema : checkInVisitorAllowed
Type:
Show Source
array
-
Array of:
object CheckInVisitor
Title:
CheckInVisitor
Nested Schema : multipleCheckInAllowed
Type:
Show Source
array
-
Array of:
object CheckInMultiple
Title:
CheckInMultiple
Nested Schema : CheckInCrew
Type:
object
Title:
Show Source
CheckInCrew
-
name(optional):
string
Parameter NameExample:
Check-in via FC Security - Crew
-
value(optional):
string
Parameter Value (default value: 0)Example:
1
Nested Schema : CheckInResident
Type:
object
Title:
Show Source
CheckInResident
-
name(optional):
string
Parameter NameExample:
Check-in via FC Security
-
value(optional):
string
Parameter Value (default value: 0)Example:
1
Nested Schema : CheckInVisitor
Type:
object
Title:
Show Source
CheckInVisitor
-
name(optional):
string
Parameter NameExample:
Check-in via FC Security - Visitor
-
value(optional):
string
Parameter Value (default value: 0)Example:
1
Nested Schema : CheckInMultiple
Type:
object
Title:
Show Source
CheckInMultiple
-
name(optional):
string
Parameter NameExample:
Extended search criteria check in
-
value(optional):
string
Parameter Value (default value: 0)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