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
Validation request
Root Schema : ReservationDetail
Type:
object
Reservation details
Show Source
-
dateOfBirth(optional):
string
Date of birthExample:
1961-04-01T16:00:00.0Z
-
documentExpiryDate(optional):
string
Document expiry dateExample:
1961-04-01T16:00:00.0Z
-
documentIssuedCountry(optional):
string
Document issued countryExample:
US
-
documentIssuedDate(optional):
string
Document issued dateExample:
1961-04-01T16:00:00.0Z
-
nationality(optional):
string
NationalityExample:
US
-
passportNum(optional):
string
Passport numberExample:
A123456
-
travelDocumentList(optional):
array travelDocumentList
Other travel document list
Nested Schema : travelDocumentList
Type:
array
Other travel document list
Show Source
-
Array of:
object TravelDocTypeDetail
Other travel document list
Nested Schema : TravelDocTypeDetail
Type:
object
Other travel document list
Show Source
-
birthCertificateState(optional):
string
Birth Certificate StateExample:
US
-
documentExpiryDate(optional):
string
Document expiry dateExample:
1961-04-01T16:00:00.0Z
-
documentIssuedDate(optional):
string
Document issued dateExample:
1961-04-01T16:00:00.0Z
-
documentIssuedPlace(optional):
string
Document issued placeExample:
US
-
documentNumber(optional):
string
Document numberExample:
B123456
-
photoIdState(optional):
string
Photo ID State - if this field is mandatory will check for guest age below 16 yeard oldExample:
US
-
photoIdType(optional):
integer
Photo ID type - if this field is mandatory will check for guest age below 16 yeard oldExample:
1
-
travelDocumentTypeCode(optional):
string
Travel document type codeExample:
B
Response
Supported Media Types
- application/json
200 Response
OK
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Travel Document Validation error response
Title:
Travel Document Validation error response
Travel Document Validation error response
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
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Travel Document Validation error response
Title:
Travel Document Validation error response
Travel Document Validation error response
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
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Travel Document Validation error response
Title:
Travel Document Validation error response
Travel Document Validation error response
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
404 Response
Not Found
Root Schema : schema
Match All
Show Source
-
object
Travel Document Validation error response
Title:
Travel Document Validation error response
Travel Document Validation error response
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
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Travel Document Validation error response
Title:
Travel Document Validation error response
Travel Document Validation error response
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
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Travel Document Validation error response
Title:
Travel Document Validation error response
Travel Document Validation error response
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
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Travel Document Validation error response
Title:
Travel Document Validation error response
Travel Document Validation error response
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
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Travel Document Validation error response
Title:
Travel Document Validation error response
Travel Document Validation error response
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