Jump to

• Request
• Response

Retrieve list of travel document rules

get

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

This is to retrieve list of travel document rules

Request

Supported Media Types

• application/json

Path Parameters

• shipId: number
  ship Id

Query Parameters

• isActive: boolean
  Activation status of the travel document type: * `true` - Travel document rule is active * `false` - Travel document rule 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, travelDocumentRuleCode and travelDocumentRuleName with format column1:asc/desc,column2:asc/desc
• searchValue: string
  Search for travel document rule code or name
• travelDocumentRuleCode: string
  Travel document rule code
• travelDocumentRuleName: string
  Travel document rule 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 Rule Response List
  Title: Travel Document Rule Response List

  The Travel Document Rule is executed successfully

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

Nested Schema : Travel Document Rule Response List

Type: object

Title: Travel Document Rule Response List

The Travel Document Rule is executed 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 Rule Response List",
    "description":"The Travel Document Rule is executed 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/TravelDocRuleConfigurationList"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Travel Document Rule Configuration List
  Title: Travel Document Rule Configuration List

  The Travel Document Rule Configuration is executed successfully

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

Nested Schema : Travel Document Rule Configuration List

Type: object

Title: Travel Document Rule Configuration List

The Travel Document Rule Configuration is executed successfully

Show Source

• checkListInfo(optional): array checkListInfo
• disembarkCountryCode(optional): string
  Disembark country code

  Example: US
• disembarkCountryName(optional): string
  Disembark country name

  Example: United State
• embarkCountryCode(optional): string
  Embark country code

  Example: US
• embarkCountryName(optional): string
  Embark country name

  Example: United State
• id(optional): integer
  Travel document rule Id

  Example: 1234
• isActive(optional): boolean
  travel document type active status

  Example: true
• isNationalityGroup(optional): boolean
  Is using nationality group

  Example: true
• travelDocumentRuleCode(optional): string
  Travel document rule code

  Example: TD01
• travelDocumentRuleName(optional): string
  Travel document rule name

  Example: USA

{
    "title":"Travel Document Rule Configuration List",
    "description":"The Travel Document Rule Configuration is executed successfully",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Travel document rule Id",
            "example":1234
        },
        "travelDocumentRuleCode":{
            "type":"string",
            "description":"Travel document rule code",
            "example":"TD01"
        },
        "travelDocumentRuleName":{
            "type":"string",
            "description":"Travel document rule name",
            "example":"USA"
        },
        "embarkCountryCode":{
            "type":"string",
            "description":"Embark country code",
            "example":"US"
        },
        "embarkCountryName":{
            "type":"string",
            "description":"Embark country name",
            "example":"United State"
        },
        "disembarkCountryCode":{
            "type":"string",
            "description":"Disembark country code",
            "example":"US"
        },
        "disembarkCountryName":{
            "type":"string",
            "description":"Disembark country name",
            "example":"United State"
        },
        "isActive":{
            "type":"boolean",
            "description":"travel document type active status",
            "example":true
        },
        "isNationalityGroup":{
            "type":"boolean",
            "description":"Is using nationality group",
            "example":true
        },
        "checkListInfo":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/TravelDocumentTypeCheckListGroup"
                    }
                ]
            }
        }
    }
}

Nested Schema : checkListInfo

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/TravelDocumentTypeCheckListGroup"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object TravelDocumentTypeCheckListGroup
  Travel document type check list group

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

Nested Schema : TravelDocumentTypeCheckListGroup

Type: object

Travel document type check list group

Show Source

• groupId(optional): integer
  Reference for the created rule row

  Example: 1
• nationalityList(optional): array nationalityList
• travelDocumentTypeList(optional): array travelDocumentTypeList

{
    "description":"Travel document type check list group",
    "type":"object",
    "properties":{
        "groupId":{
            "description":"Reference for the created rule row",
            "type":"integer",
            "example":1
        },
        "nationalityList":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/NationalityList"
                    }
                ]
            }
        },
        "travelDocumentTypeList":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/TravelDocumentTypeList"
                    }
                ]
            }
        }
    }
}

Nested Schema : nationalityList

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/NationalityList"
            }
        ]
    }
}

Nested Schema : travelDocumentTypeList

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/TravelDocumentTypeList"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object NationalityList
  Nationality list

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

Nested Schema : NationalityList

Type: object

Nationality list

Show Source

• nationality(optional): string
  Example: United State
• nationalityCode(optional): string
  Example: US

{
    "description":"Nationality list",
    "type":"object",
    "properties":{
        "nationalityCode":{
            "type":"string",
            "example":"US"
        },
        "nationality":{
            "type":"string",
            "example":"United State"
        }
    }
}

Nested Schema : items

Match All

Show Source

• object TravelDocumentTypeList
  Travel document type list

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

Nested Schema : TravelDocumentTypeList

Type: object

Travel document type list

Show Source

• travelDocumentTypeCode(optional): string
  Example: P
• travelDocumentTypeName(optional): string
  Example: Passport

{
    "description":"Travel document type list",
    "type":"object",
    "properties":{
        "travelDocumentTypeCode":{
            "type":"string",
            "example":"P"
        },
        "travelDocumentTypeName":{
            "type":"string",
            "example":"Passport"
        }
    }
}

204 Response

No Content

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Travel Document Rule Configurations Error Response
  Title: Travel Document Rule Configurations Error Response

  Travel Document Rule Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocRuleConfigurationsErrorResponse"
        }
    ],
    "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 : Travel Document Rule Configurations Error Response

Type: object

Title: Travel Document Rule Configurations Error Response

Travel Document Rule Configurations Error Response returned when encountered error

Show Source

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

{
    "title":"Travel Document Rule Configurations Error Response",
    "description":"Travel Document Rule Configurations 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 Travel Document Rule Configurations Error Response
  Title: Travel Document Rule Configurations Error Response

  Travel Document Rule Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocRuleConfigurationsErrorResponse"
        }
    ],
    "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 Rule Configurations Error Response

Type: object

Title: Travel Document Rule Configurations Error Response

Travel Document Rule Configurations Error Response returned when encountered error

Show Source

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

{
    "title":"Travel Document Rule Configurations Error Response",
    "description":"Travel Document Rule Configurations 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 Travel Document Rule Configurations Error Response
  Title: Travel Document Rule Configurations Error Response

  Travel Document Rule Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocRuleConfigurationsErrorResponse"
        }
    ],
    "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 Rule Configurations Error Response

Type: object

Title: Travel Document Rule Configurations Error Response

Travel Document Rule Configurations Error Response returned when encountered error

Show Source

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

{
    "title":"Travel Document Rule Configurations Error Response",
    "description":"Travel Document Rule Configurations 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 Travel Document Rule Configurations Error Response
  Title: Travel Document Rule Configurations Error Response

  Travel Document Rule Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocRuleConfigurationsErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"No Immigration Rule is available"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"No Immigration Rule is available"
}

Nested Schema : Travel Document Rule Configurations Error Response

Type: object

Title: Travel Document Rule Configurations Error Response

Travel Document Rule Configurations Error Response returned when encountered error

Show Source

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

{
    "title":"Travel Document Rule Configurations Error Response",
    "description":"Travel Document Rule Configurations 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 Travel Document Rule Configurations Error Response
  Title: Travel Document Rule Configurations Error Response

  Travel Document Rule Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocRuleConfigurationsErrorResponse"
        }
    ],
    "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 Rule Configurations Error Response

Type: object

Title: Travel Document Rule Configurations Error Response

Travel Document Rule Configurations Error Response returned when encountered error

Show Source

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

{
    "title":"Travel Document Rule Configurations Error Response",
    "description":"Travel Document Rule Configurations 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 Travel Document Rule Configurations Error Response
  Title: Travel Document Rule Configurations Error Response

  Travel Document Rule Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocRuleConfigurationsErrorResponse"
        }
    ],
    "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 Rule Configurations Error Response

Type: object

Title: Travel Document Rule Configurations Error Response

Travel Document Rule Configurations Error Response returned when encountered error

Show Source

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

{
    "title":"Travel Document Rule Configurations Error Response",
    "description":"Travel Document Rule Configurations 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 Travel Document Rule Configurations Error Response
  Title: Travel Document Rule Configurations Error Response

  Travel Document Rule Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocRuleConfigurationsErrorResponse"
        }
    ],
    "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 Rule Configurations Error Response

Type: object

Title: Travel Document Rule Configurations Error Response

Travel Document Rule Configurations Error Response returned when encountered error

Show Source

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

{
    "title":"Travel Document Rule Configurations Error Response",
    "description":"Travel Document Rule Configurations 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 Travel Document Rule Configurations Error Response
  Title: Travel Document Rule Configurations Error Response

  Travel Document Rule Configurations Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/TravelDocRuleConfigurationsErrorResponse"
        }
    ],
    "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 Rule Configurations Error Response

Type: object

Title: Travel Document Rule Configurations Error Response

Travel Document Rule Configurations Error Response returned when encountered error

Show Source

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

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

Back to Top