Jump to

• Request
• Response

Retrieve profile other travel document details.

get

/spms/v2/ships/{shipId}/profiles/{profileTypes}/{profileId}/otherTravelDocuments

This is to retrieve profile other travel document details.

Request

Supported Media Types

• application/json

Path Parameters

• profileId: integer
  Profile Id
• profileTypes: string
  Profile types

  Allowed Values: [ "guest", "crew", "resident", "visitor", "staff" ]
• shipId: number
  Ship Id

Query Parameters

• limit: integer(int32)
  Minimum Value: 0

  Paging limit
• offset: integer(int32)
  Minimum Value: 0

  Paging offset
• orderBy: string
  Minimum Value: 0

  Order by travelDocumentTypeCode, documentNumber and documentExpiryDate with format column1:asc/desc,column2:asc/desc

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object List of Other Travel Documents
  Title: List of Other Travel Documents

  List of Other Travel Document

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

Nested Schema : List of Other Travel Documents

Type: object

Title: List of Other Travel Documents

List of Other Travel Document

Show Source

• items(optional): array items

{
    "title":"List of Other Travel Documents",
    "description":"List of Other Travel Document",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OtherTravelDocsList"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Other Travel Documents
  Title: Other Travel Documents

  Other Travel Documents

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

Nested Schema : Other Travel Documents

Type: object

Title: Other Travel Documents

Other Travel Documents

Show Source

• birthCertificateState(optional): string
  Maximum Length: 6

  Birth Certificate State

  Example: KL
• documentAdditionalNote1(optional): string
  Maximum Length: 50

  Additional notes 1

  Example: remark
• documentAdditionalNote2(optional): string
  Maximum Length: 50

  Additional notes 2

  Example: remark
• documentBirthDate(optional): string
  Document Birthdate

  Example: 1961-04-01T16:00:00.0Z
• documentComments(optional): string
  Maximum Length: 3000

  Comments, use by DGS only

  Example: comment
• documentExpiryDate(optional): string
  Document Expiry Date

  Example: 1961-04-01T16:00:00.0Z
• documentFirstName(optional): string
  Maximum Length: 40

  Document First Name

  Example: John
• documentGUID(optional): string
  Maximum Length: 50

  Document GUID

  Example: 6AF13A4B-0A02-4435-B6E9-FC4BEFB465E2
• documentId(optional): integer
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Document ID

  Example: 1001
• documentImportUniqueId(optional): string
  Unique ID

  Example: 10450919
• documentIssuedCountryCode(optional): string
  Maximum Length: 6

  Document Issued Country Code

  Example: CN
• documentIssuedCountryDesc(optional): string
  Document Issued Country Description

  Example: China
• documentIssuedDate(optional): string
  Document Issued Date

  Example: 1961-04-01T16:00:00.0Z
• documentIssuedPlace(optional): string
  Maximum Length: 40

  Document Issued Place

  Example: CHN
• documentLastName(optional): string
  Maximum Length: 40

  Document Last Name

  Example: John
• documentMiddleName(optional): string
  Maximum Length: 20

  Document Middle Name

  Example: John
• documentMRZ1(optional): string
  Maximum Length: 100

  Machine Readable Track 1 information

  Example: IDD<<LGM5W4KKR9<<<<<<<<<<<<<<<
• documentMRZ2(optional): string
  Maximum Length: 100

  Machine Readable Track 2 information

  Example: IDD<<LGM5W4KKR9<<<<<<<<<<<<<<<
• documentMRZ3(optional): string
  Maximum Length: 100

  Machine Readable Track 3 information

  Example: IDD<<LGM5W4KKR9<<<<<<<<<<<<<<<
• documentMultipleEntries(optional): string
  Multiple entries of visa

  Example: 1
• documentNumber(optional): string
  Maximum Length: 20

  Document Number

  Example: AO292152
• documentNumberOfEntries(optional): integer
  Number of Entry

  Example: 1
• documentRegisteredAtWizard(optional): boolean
  Travel document that is registered at AQCI Wizard

  Example: false
• documentRemoteId(optional): string
  Maximum Length: 30

  Remote Id

  Example: 999000544
• documentRemoteManifestUpdatedDate(optional): string
  Document Remote Manifest Updated Date

  Example: 1961-04-01T16:00:00.0Z
• documentValidFromDate(optional): string
  Valid From Date

  Example: 1961-04-01T16:00:00.0Z
• durationOfStay(optional): integer
  Duration of Stay

  Example: 1
• lastModifiedDate(optional): string
  Last Modified Date

  Example: 1961-04-01T16:00:00.0Z
• photoIdState(optional): string
  Maximum Length: 6

  Photo Id State

  Example: KL
• photoIdType(optional): string
  Maximum Length: 10

  Photo Id Type

  Example: 1
• profileId(optional): integer
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Profile ID

  Example: 1001
• travelDocumentTypeCode(optional): string
  Maximum Length: 6

  Travel Document Type Code

  Example: V
• travelDocumentTypeDesc(optional): string
  Travel Document Type Description

  Example: Visa
• travelDocumentTypeName(optional): string
  Maximum Length: 100

  Travel Document Type Name

  Example: Passport
• visaType(optional): string
  Maximum Length: 6

  Visa Type

  Example: P

{
    "title":"Other Travel Documents",
    "description":"Other Travel Documents",
    "type":"object",
    "properties":{
        "documentId":{
            "$ref":"#/definitions/documentId"
        },
        "profileId":{
            "$ref":"#/definitions/profileId"
        },
        "documentIssuedCountryCode":{
            "$ref":"#/definitions/documentIssuedCountryCode"
        },
        "documentIssuedCountryDesc":{
            "$ref":"#/definitions/documentIssuedCountryDesc"
        },
        "documentNumber":{
            "$ref":"#/definitions/documentNumber"
        },
        "visaType":{
            "$ref":"#/definitions/visaType"
        },
        "documentIssuedDate":{
            "$ref":"#/definitions/documentIssuedDate"
        },
        "documentIssuedPlace":{
            "$ref":"#/definitions/documentIssuedPlace"
        },
        "documentExpiryDate":{
            "$ref":"#/definitions/documentExpiryDate"
        },
        "documentImportUniqueId":{
            "$ref":"#/definitions/documentImportUniqueId"
        },
        "documentRemoteManifestUpdatedDate":{
            "$ref":"#/definitions/documentRemoteManifestUpdatedDate"
        },
        "travelDocumentTypeCode":{
            "$ref":"#/definitions/travelDocumentTypeCode"
        },
        "travelDocumentTypeDesc":{
            "$ref":"#/definitions/travelDocumentTypeDesc"
        },
        "documentFirstName":{
            "$ref":"#/definitions/documentFirstName"
        },
        "documentMiddleName":{
            "$ref":"#/definitions/documentMiddleName"
        },
        "documentLastName":{
            "$ref":"#/definitions/documentLastName"
        },
        "documentBirthDate":{
            "$ref":"#/definitions/documentBirthDate"
        },
        "documentRemoteId":{
            "$ref":"#/definitions/documentRemoteId"
        },
        "documentMRZ1":{
            "$ref":"#/definitions/documentMRZ1"
        },
        "documentMRZ2":{
            "$ref":"#/definitions/documentMRZ2"
        },
        "documentMRZ3":{
            "$ref":"#/definitions/documentMRZ3"
        },
        "travelDocumentTypeName":{
            "$ref":"#/definitions/travelDocumentTypeName"
        },
        "documentGUID":{
            "$ref":"#/definitions/documentGUID"
        },
        "documentNumberOfEntries":{
            "$ref":"#/definitions/documentNumberOfEntries"
        },
        "documentValidFromDate":{
            "$ref":"#/definitions/documentValidFromDate"
        },
        "lastModifiedDate":{
            "$ref":"#/definitions/lastModifiedDate"
        },
        "durationOfStay":{
            "$ref":"#/definitions/durationOfStay"
        },
        "documentAdditionalNote1":{
            "$ref":"#/definitions/documentAdditionalNote1"
        },
        "documentAdditionalNote2":{
            "$ref":"#/definitions/documentAdditionalNote2"
        },
        "birthCertificateState":{
            "$ref":"#/definitions/birthCertificateState"
        },
        "photoIdState":{
            "$ref":"#/definitions/photoIdState"
        },
        "photoIdType":{
            "$ref":"#/definitions/photoIdType"
        },
        "documentRegisteredAtWizard":{
            "$ref":"#/definitions/documentRegisteredAtWizard"
        },
        "documentComments":{
            "$ref":"#/definitions/documentComments"
        },
        "documentMultipleEntries":{
            "$ref":"#/definitions/documentMultipleEntries"
        }
    }
}

204 Response

No Content

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/OtherTravelDocErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter shipId has incorrect format"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter shipId 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/OtherTravelDocErrorResponse"
        }
    ],
    "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/OtherTravelDocErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was 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/OtherTravelDocErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Profile Id not found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Profile Id not found"
}

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/OtherTravelDocErrorResponse"
        }
    ],
    "example":{
        "type":"https://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":"https://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"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

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