Oracle Hospitality Cruise REST API

Create travel document rule

post

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

This is to create travel document rule

Request

Supported Media Types

application/json

Path Parameters

shipId: integer

ship Id

Root Schema : Travel Document Rule Create

Type: object

Title: Travel Document Rule Create

The Travel Document Rule is executed successfully

Show Source

checkListInfo(optional): array checkListInfo
disembarkCountryCode(optional): string

Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]

Disembark country code

Example: US
embarkCountryCode(optional): string

Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]

Embark country code

Example: US
isActive(optional): boolean

Travel document rule status

Example: true
isNationalityGroup(optional): boolean

Using nationality group

Example: true
travelDocumentRuleCode(optional): string

Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]

Travel document rule code

Example: TD01
travelDocumentRuleName(optional): string

Pattern: [a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]

Travel document rule name

Example: USA

{
    "title":"Travel Document Rule Create",
    "description":"The Travel Document Rule is executed successfully",
    "type":"object",
    "properties":{
        "travelDocumentRuleCode":{
            "type":"string",
            "description":"Travel document rule code",
            "example":"TD01",
            "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\\|,.\":;{}[]"
        },
        "travelDocumentRuleName":{
            "type":"string",
            "description":"Travel document rule name",
            "example":"USA",
            "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\\|,.\":;{}[]"
        },
        "embarkCountryCode":{
            "type":"string",
            "description":"Embark country code",
            "example":"US",
            "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\\|,.\":;{}[]"
        },
        "disembarkCountryCode":{
            "type":"string",
            "description":"Disembark country code",
            "example":"US",
            "pattern":"[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\\|,.\":;{}[]"
        },
        "isActive":{
            "type":"boolean",
            "description":"Travel document rule status",
            "example":true
        },
        "isNationalityGroup":{
            "type":"boolean",
            "description":"Using nationality group",
            "example":true
        },
        "checkListInfo":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/TravelDocumentTypeCheckListGroupCreate"
                    }
                ]
            }
        }
    }
}

Nested Schema : checkListInfo

Type: array

Show Source

Array of: items

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

Nested Schema : items

Match All

Show Source

object TravelDocumentTypeCheckListGroupCreate

Travel document type check list group

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

Nested Schema : TravelDocumentTypeCheckListGroupCreate

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/NationalityListCreate"
                    }
                ]
            }
        },
        "travelDocumentTypeList":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/TravelDocumentTypeListCreate"
                    }
                ]
            }
        }
    }
}

Nested Schema : nationalityList

Type: array

Show Source

Array of: items

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

Nested Schema : travelDocumentTypeList

Type: array

Show Source

Array of: items

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

Nested Schema : items

Match All

Show Source

object NationalityListCreate

Nationality list

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

Nested Schema : NationalityListCreate

Type: object

Nationality list

Show Source

nationalityCode(optional): string

Example: US

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

Nested Schema : items

Match All

Show Source

object TravelDocumentTypeListCreate

Travel documet type list

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

Nested Schema : TravelDocumentTypeListCreate

Type: object

Travel documet type list

Show Source

travelDocumentTypeCode(optional): string

Example: P

{
    "description":"Travel documet type list",
    "type":"object",
    "properties":{
        "travelDocumentTypeCode":{
            "type":"string",
            "example":"P"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Created

Root 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"
        }
    }
}

400 Response

Bad Request

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":"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 : 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

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

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

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":"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 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

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

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"
        }
    }
}

409 Response

Conflict

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.10",
        "title":"Conflict",
        "detail":"Travel document rule code duplicate"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
    "title":"Conflict",
    "detail":"Travel document rule code duplicate"
}

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"
        }
    }
}

415 Response

Unsupported Media Type

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.16",
        "title":"Invalid content",
        "detail":"Content type Not supported"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "detail":"Content type Not supported"
}

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

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

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"
        }
    }
}