Jump to

• Request
• Response

Update check-in settings for the gangway only

put

/spms/v2/ships/{shipId}/configurations/checkIns/gangway

This is to update the check-in settings for the gangway only

Request

Supported Media Types

• application/json

Path Parameters

• shipId: integer
  ship Id

Body ()

Required to update check in settings for the gangway

Root Schema : Update check-in settings for the gangway only

Type: object

Title: Update check-in settings for the gangway only

Show Source

• checkInCrewAllowed(optional): string
  This is to retrieve the settings to allow system check-in crew at the gangway

  Example: 1
• checkInGuestAndResidentAllowed(optional): string
  This is to retrieve the settings to allow system check-in guest and resident at the gangway

  Example: 1
• checkInVisitorAllowed(optional): string
  This is to retrieve the settings to allow system check-in visitor at the gangway

  Example: 1
• multipleCheckInAllowed(optional): string
  This is to retrieve the settings to allow system check-in everyone travel together concurrently

  Example: 0

{
    "title":"Update check-in settings for the gangway only",
    "type":"object",
    "properties":{
        "checkInGuestAndResidentAllowed":{
            "type":"string",
            "example":"1",
            "description":"This is to retrieve the settings to allow system check-in guest and resident at the gangway"
        },
        "checkInCrewAllowed":{
            "type":"string",
            "example":"1",
            "description":"This is to retrieve the settings to allow system check-in crew at the gangway"
        },
        "checkInVisitorAllowed":{
            "type":"string",
            "example":"1",
            "description":"This is to retrieve the settings to allow system check-in visitor at the gangway"
        },
        "multipleCheckInAllowed":{
            "type":"string",
            "example":"0",
            "description":"This is to retrieve the settings to allow system check-in everyone travel together concurrently"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

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

{
    "title":"Check In Settings for gangway only",
    "description":"Check In Settings for gangway only",
    "type":"object",
    "properties":{
        "checkInGuestAndResidentAllowed":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/checkInResidentDTO"
            }
        },
        "checkInCrewAllowed":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/checkInCrewDTO"
            }
        },
        "checkInVisitorAllowed":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/checkInVisitorDTO"
            }
        },
        "multipleCheckInAllowed":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/checkInMultipleDTO"
            }
        }
    },
    "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"
            }
        ]
    }
}

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: array

Show Source

• Array of: object CheckInCrew
  Title: CheckInCrew

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/checkInCrewDTO"
    }
}

Nested Schema : checkInGuestAndResidentAllowed

Type: array

Show Source

• Array of: object CheckInResident
  Title: CheckInResident

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/checkInResidentDTO"
    }
}

Nested Schema : checkInVisitorAllowed

Type: array

Show Source

• Array of: object CheckInVisitor
  Title: CheckInVisitor

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/checkInVisitorDTO"
    }
}

Nested Schema : multipleCheckInAllowed

Type: array

Show Source

• Array of: object CheckInMultiple
  Title: CheckInMultiple

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/checkInMultipleDTO"
    }
}

Nested Schema : CheckInCrew

Type: object

Title: CheckInCrew

Show Source

• name(optional): string
  Parameter Name

  Example: Check-in via FC Security - Crew
• value(optional): string
  Parameter Value (default value: 0)

  Example: 1

{
    "title":"CheckInCrew",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"Check-in via FC Security - Crew",
            "description":"Parameter Name"
        },
        "value":{
            "type":"string",
            "example":"1",
            "description":"Parameter Value (default value: 0)"
        }
    }
}

Nested Schema : CheckInResident

Type: object

Title: CheckInResident

Show Source

• name(optional): string
  Parameter Name

  Example: Check-in via FC Security
• value(optional): string
  Parameter Value (default value: 0)

  Example: 1

{
    "title":"CheckInResident",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"Check-in via FC Security",
            "description":"Parameter Name"
        },
        "value":{
            "type":"string",
            "example":"1",
            "description":"Parameter Value (default value: 0)"
        }
    }
}

Nested Schema : CheckInVisitor

Type: object

Title: CheckInVisitor

Show Source

• name(optional): string
  Parameter Name

  Example: Check-in via FC Security - Visitor
• value(optional): string
  Parameter Value (default value: 0)

  Example: 1

{
    "title":"CheckInVisitor",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"Check-in via FC Security - Visitor",
            "description":"Parameter Name"
        },
        "value":{
            "type":"string",
            "example":"1",
            "description":"Parameter Value (default value: 0)"
        }
    }
}

Nested Schema : CheckInMultiple

Type: object

Title: CheckInMultiple

Show Source

• name(optional): string
  Parameter Name

  Example: Extended search criteria check in
• value(optional): string
  Parameter Value (default value: 0)

  Example: 1

{
    "title":"CheckInMultiple",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"Extended search criteria check in",
            "description":"Parameter Name"
        },
        "value":{
            "type":"string",
            "example":"1",
            "description":"Parameter Value (default value: 0)"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/EmbarkationCheckInParamErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter typeId has incorrect format"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter typeId has incorrect format"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/EmbarkationCheckInParamErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/EmbarkationCheckInParamErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/EmbarkationCheckInParamErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"This resource path does not exist"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/EmbarkationCheckInParamErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

415 Response

Unsupported Media Type

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/EmbarkationCheckInParamErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type Not supported"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/EmbarkationCheckInParamErrorResponse"
        }
    ],
    "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"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/EmbarkationCheckInParamErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable.  Try again later"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top