Jump to

• Request
• Response

Validate supplied travel documents against selected travel document rule for a profile

post

/spms/v2/ships/{shipId}/reservations/validation/checkIns/travelDocuments

This is to validate supplied travel documents against selected travel document rule for a profile

Request

Supported Media Types

• application/json

Path Parameters

• shipId: number
  Ship Id

Body ()

Validation request

Root Schema : ReservationDetail

Type: object

Reservation details

Show Source

• dateOfBirth(optional): string
  Date of birth

  Example: 1961-04-01T16:00:00.0Z
• documentExpiryDate(optional): string
  Document expiry date

  Example: 1961-04-01T16:00:00.0Z
• documentIssuedCountry(optional): string
  Document issued country

  Example: US
• documentIssuedDate(optional): string
  Document issued date

  Example: 1961-04-01T16:00:00.0Z
• nationality(optional): string
  Nationality

  Example: US
• passportNum(optional): string
  Passport number

  Example: A123456
• travelDocumentList(optional): array travelDocumentList
  Other travel document list

{
    "description":"Reservation details",
    "type":"object",
    "properties":{
        "passportNum":{
            "description":"Passport number",
            "type":"string",
            "example":"A123456"
        },
        "nationality":{
            "description":"Nationality",
            "type":"string",
            "example":"US"
        },
        "documentIssuedDate":{
            "description":"Document issued date",
            "type":"string",
            "example":"1961-04-01T16:00:00.0Z"
        },
        "documentExpiryDate":{
            "description":"Document expiry date",
            "type":"string",
            "example":"1961-04-01T16:00:00.0Z"
        },
        "documentIssuedCountry":{
            "description":"Document issued country",
            "type":"string",
            "example":"US"
        },
        "dateOfBirth":{
            "description":"Date of birth",
            "type":"string",
            "example":"1961-04-01T16:00:00.0Z"
        },
        "travelDocumentList":{
            "description":"Other travel document list",
            "type":"array",
            "items":{
                "$ref":"#/definitions/TravelDocTypeDetail"
            }
        }
    }
}

Nested Schema : travelDocumentList

Type: array

Other travel document list

Show Source

• Array of: object TravelDocTypeDetail
  Other travel document list

{
    "description":"Other travel document list",
    "type":"array",
    "items":{
        "$ref":"#/definitions/TravelDocTypeDetail"
    }
}

Nested Schema : TravelDocTypeDetail

Type: object

Other travel document list

Show Source

• birthCertificateState(optional): string
  Birth Certificate State

  Example: US
• documentExpiryDate(optional): string
  Document expiry date

  Example: 1961-04-01T16:00:00.0Z
• documentIssuedDate(optional): string
  Document issued date

  Example: 1961-04-01T16:00:00.0Z
• documentIssuedPlace(optional): string
  Document issued place

  Example: US
• documentNumber(optional): string
  Document number

  Example: B123456
• photoIdState(optional): string
  Photo ID State - if this field is mandatory will check for guest age below 16 yeard old

  Example: US
• photoIdType(optional): integer
  Photo ID type - if this field is mandatory will check for guest age below 16 yeard old

  Example: 1
• travelDocumentTypeCode(optional): string
  Travel document type code

  Example: B

{
    "description":"Other travel document list",
    "type":"object",
    "properties":{
        "travelDocumentTypeCode":{
            "description":"Travel document type code",
            "type":"string",
            "example":"B"
        },
        "documentNumber":{
            "description":"Document number",
            "type":"string",
            "example":"B123456"
        },
        "documentExpiryDate":{
            "description":"Document expiry date",
            "type":"string",
            "example":"1961-04-01T16:00:00.0Z"
        },
        "documentIssuedDate":{
            "description":"Document issued date",
            "type":"string",
            "example":"1961-04-01T16:00:00.0Z"
        },
        "documentIssuedPlace":{
            "description":"Document issued place",
            "type":"string",
            "example":"US"
        },
        "birthCertificateState":{
            "description":"Birth Certificate State",
            "type":"string",
            "example":"US"
        },
        "photoIdType":{
            "description":"Photo ID type - if this field is mandatory will check for guest age below 16 yeard old",
            "type":"integer",
            "example":1
        },
        "photoIdState":{
            "description":"Photo ID State - if this field is mandatory will check for guest age below 16 yeard old",
            "type":"string",
            "example":"US"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Travel Document Validation error response
  Title: Travel Document Validation error response

  Travel Document Validation error response

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

Example:

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

Nested Schema : Travel Document Validation error response

Type: object

Title: Travel Document Validation error response

Travel Document Validation error response

Show Source

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

{
    "title":"Travel Document Validation error response",
    "description":"Travel Document Validation error response",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Travel Document Validation error response
  Title: Travel Document Validation error response

  Travel Document Validation error response

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocCheckInValidationErrorResponse"
        }
    ],
    "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 : Travel Document Validation error response

Type: object

Title: Travel Document Validation error response

Travel Document Validation error response

Show Source

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

{
    "title":"Travel Document Validation error response",
    "description":"Travel Document Validation error response",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Travel Document Validation error response
  Title: Travel Document Validation error response

  Travel Document Validation error response

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocCheckInValidationErrorResponse"
        }
    ],
    "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 : Travel Document Validation error response

Type: object

Title: Travel Document Validation error response

Travel Document Validation error response

Show Source

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

{
    "title":"Travel Document Validation error response",
    "description":"Travel Document Validation error response",
    "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 Travel Document Validation error response
  Title: Travel Document Validation error response

  Travel Document Validation error response

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocCheckInValidationErrorResponse"
        }
    ],
    "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 : Travel Document Validation error response

Type: object

Title: Travel Document Validation error response

Travel Document Validation error response

Show Source

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

{
    "title":"Travel Document Validation error response",
    "description":"Travel Document Validation error response",
    "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 Travel Document Validation error response
  Title: Travel Document Validation error response

  Travel Document Validation error response

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocCheckInValidationErrorResponse"
        }
    ],
    "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 : Travel Document Validation error response

Type: object

Title: Travel Document Validation error response

Travel Document Validation error response

Show Source

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

{
    "title":"Travel Document Validation error response",
    "description":"Travel Document Validation error response",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Travel Document Validation error response
  Title: Travel Document Validation error response

  Travel Document Validation error response

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

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 : Travel Document Validation error response

Type: object

Title: Travel Document Validation error response

Travel Document Validation error response

Show Source

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

{
    "title":"Travel Document Validation error response",
    "description":"Travel Document Validation error response",
    "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 Travel Document Validation error response
  Title: Travel Document Validation error response

  Travel Document Validation error response

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocCheckInValidationErrorResponse"
        }
    ],
    "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 : Travel Document Validation error response

Type: object

Title: Travel Document Validation error response

Travel Document Validation error response

Show Source

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

{
    "title":"Travel Document Validation error response",
    "description":"Travel Document Validation error response",
    "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 Travel Document Validation error response
  Title: Travel Document Validation error response

  Travel Document Validation error response

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocCheckInValidationErrorResponse"
        }
    ],
    "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 : Travel Document Validation error response

Type: object

Title: Travel Document Validation error response

Travel Document Validation error response

Show Source

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

{
    "title":"Travel Document Validation error response",
    "description":"Travel Document Validation error response",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top