Jump to

• Request
• Response

Retrieve list of travel document types

get

/spms/v2/ships/{shipId}/configurations/travelDocumentTypes

This is to retrieve list of travel document types

Request

Supported Media Types

• application/json

Path Parameters

• shipId: integer
  ship Id

Query Parameters

• isActive: boolean
  Minimum Value: 0

  Activation status of the travel document type: * `true` - Travel document type is active * `false` - Travel document type is inactive
• limit: integer(int32)
  Minimum Value: 0

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

  Paging offset
• orderBy: string
  Minimum Value: 0

  order by id, travelDocumentCode and travelDocumentName with format column1:asc/desc,column2:asc/desc
• searchValue: string
  Minimum Value: 0

  Search value
• travelDocumentCode: string
  Minimum Value: 0

  Travel Document Code
• travelDocumentName: string
  Minimum Value: 0

  Travel Document Name

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Travel Document Types list
  Title: Travel Document Types list

  Travel Document Types listing is retrieved successfully

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

Nested Schema : Travel Document Types list

Type: object

Title: Travel Document Types list

Travel Document Types listing is retrieved successfully

Show Source

• count(optional): integer
  Example: 12345678
• hasMore(optional): boolean
  Example: true
• items(optional): array items
• limit(optional): integer
  Example: 10
• offset(optional): integer
  Example: 1

{
    "title":"Travel Document Types list",
    "description":"Travel Document Types listing is retrieved successfully",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "example":12345678
        },
        "hasMore":{
            "type":"boolean",
            "example":true
        },
        "offset":{
            "type":"integer",
            "example":1
        },
        "limit":{
            "type":"integer",
            "example":10
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TravelDocTypeConfigurationList"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Travel Document type details
  Title: Travel Document type details

  Travel Document type details is retrieved succesfully

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

Nested Schema : Travel Document type details

Type: object

Title: Travel Document type details

Travel Document type details is retrieved succesfully

Show Source

• id(optional): integer
  Travel document type Id

  Example: 1234
• isActive(optional): boolean
  Activation status of the travel document type: * `true` - Travel document type is active * `false` - Travel document type is inactive

  Example: true
• travelDocumentCheckList(optional): array travelDocumentCheckList
• travelDocumentCode(optional): string
  Travel document type code

  Example: P
• travelDocumentMapping(optional): string
  Travel document APIS mapping

  Example: OD
• travelDocumentName(optional): string
  Travel document type name

  Example: Passport
• travelDocumentRemarks(optional): string
  Travel document remarks

  Example: remark

{
    "title":"Travel Document type details",
    "description":"Travel Document type details is retrieved succesfully",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Travel document type Id",
            "example":1234
        },
        "travelDocumentCode":{
            "type":"string",
            "description":"Travel document type code",
            "example":"P"
        },
        "travelDocumentName":{
            "type":"string",
            "description":"Travel document type name",
            "example":"Passport"
        },
        "travelDocumentMapping":{
            "type":"string",
            "description":"Travel document APIS mapping",
            "example":"OD"
        },
        "travelDocumentRemarks":{
            "type":"string",
            "description":"Travel document remarks",
            "example":"remark"
        },
        "isActive":{
            "type":"boolean",
            "description":"Activation status of the travel document type:\n * `true` - Travel document type is active\n * `false` - Travel document type is inactive\n",
            "example":true
        },
        "travelDocumentCheckList":{
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/TravelDocFieldCheckList"
                    }
                ]
            }
        }
    }
}

Nested Schema : travelDocumentCheckList

Type: array

Show Source

• Array of: items

{
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/TravelDocFieldCheckList"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object TravelDocFieldCheckList
  travel document field check list

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocFieldCheckList"
        }
    ]
}

Nested Schema : TravelDocFieldCheckList

Type: object

travel document field check list

Show Source

• description(optional): string
  Example: Document Number
• isMandatory(optional): boolean
  Example: true
• travelDocumentCheckListId(optional): integer
  Example: 1

{
    "description":"travel document field check list",
    "type":"object",
    "properties":{
        "travelDocumentCheckListId":{
            "type":"integer",
            "example":1
        },
        "description":{
            "type":"string",
            "example":"Document Number"
        },
        "isMandatory":{
            "type":"boolean",
            "example":true
        }
    }
}

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/TravelDocConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Limit must not be less than one!"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Limit must not be less than one!"
}

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/TravelDocConfigurationsErrorResponse"
        }
    ],
    "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/TravelDocConfigurationsErrorResponse"
        }
    ],
    "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/TravelDocConfigurationsErrorResponse"
        }
    ],
    "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/TravelDocConfigurationsErrorResponse"
        }
    ],
    "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"
        }
    }
}

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/TravelDocConfigurationsErrorResponse"
        }
    ],
    "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/TravelDocConfigurationsErrorResponse"
        }
    ],
    "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/TravelDocConfigurationsErrorResponse"
        }
    ],
    "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