Oracle Hospitality Cruise Property Management Border Control REST API 23.1.0

Create EES request file

post

/spms/v2/ships/{shipId}/borderControls/ees/manifests

This is to create EES request file that include guest manifest details.

Request

Supported Media Types

application/json

Path Parameters

shipId(required): number

Ship Id

Reservation Records Object

Root Schema : EES Manifests Request

Type: object

Title: EES Manifests Request

EES Manifests Request Body

Show Source

arrivalDate: string(ISO 8601 (YYYY-MM-DD))

Embarkation Date

Example: 2025-04-19
cruiseItineraryName: string

Minimum Length: 1

Maximum Length: 50

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

Cruise Itinerary Name

Example: Fjord Itinerary
departureDateTime: string(YYYY-MM-DD HH:mm)

Disembarkation Date & Time

Example: 2025-04-20 16:15
embarkationHarborId: number

Pattern: ^[0-9]*$

Example: 11
guestManifestList: array manifestRequestGuestListObject
scheduleNo: string

Minimum Length: 1

Maximum Length: 18

Schedule Number

Example: SN1001

{
    "title":"EES Manifests Request",
    "description":"EES Manifests Request Body",
    "type":"object",
    "properties":{
        "scheduleNo":{
            "$ref":"#/definitions/scheduleNo"
        },
        "cruiseItineraryName":{
            "$ref":"#/definitions/cruiseItineraryName"
        },
        "arrivalDate":{
            "$ref":"#/definitions/eesArrivalDate"
        },
        "embarkationHarborId":{
            "$ref":"#/definitions/embarkationHarborId"
        },
        "departureDateTime":{
            "$ref":"#/definitions/departureDateTime"
        },
        "guestManifestList":{
            "$ref":"#/definitions/manifestRequestGuestListObject"
        }
    }
}

Nested Schema : manifestRequestGuestListObject

Type: array

Show Source

Array of: object manifestRequestGuestList

Guest Manifest List

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

Nested Schema : manifestRequestGuestList

Type: object

Guest Manifest List

Show Source

dateOfBirth: string(ISO 8601 (YYYY-MM-DD))

Date of Birth

Example: 1999-02-15
eesEtiasOutOfScope: string

Traveller out of EES/ETIAS scope * YES * NO

Example: NO
expiryDate: string(ISO 8601 (YYYY-MM-DD))

Travel Document Expiry Date

Example: 2025-02-25
givenName: string

Minimum Length: 1

Maximum Length: 16

First Name

Example: Maya
inTransit: string

Traveller in transit * YES * NO

Example: NO
issuingState: string(Alpha-3 ISO3166)

Pattern: ^[A-Z]{3}$

Travel Document Issued Country Code

Example: USA
paxNationality: string(Alpha-3 ISO3166)

Pattern: ^[A-Z]{3}$

Nationality Country Code

Example: USA
pReqID: number

Minimum Length: 1

Pattern: ^[0-9]*$

Folio Number (Reservation Account Id)

Example: 1001
sex: string

Gender * Female * Male * Unspecified

Example: Female
stateroomNo: string

Minimum Length: 1

Maximum Length: 20

Stateroom Number

Example: 1020
surname: string

Minimum Length: 1

Maximum Length: 16

Last Name

Example: Walters
travelDocNbr: string

Pattern: ^[A-Z0-9]{16}$

Travel Document Number

Example: A1510202
travelDocType: string

Minimum Length: 1

Maximum Length: 8

Travel Document Type

Example: passport

{
    "description":"Guest Manifest List",
    "type":"object",
    "properties":{
        "pReqID":{
            "$ref":"#/definitions/pReqID"
        },
        "surname":{
            "$ref":"#/definitions/surname"
        },
        "givenName":{
            "$ref":"#/definitions/givenName"
        },
        "stateroomNo":{
            "$ref":"#/definitions/stateroomNo"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "sex":{
            "$ref":"#/definitions/sex"
        },
        "paxNationality":{
            "$ref":"#/definitions/paxNationalityCode"
        },
        "travelDocType":{
            "$ref":"#/definitions/travelDocType"
        },
        "travelDocNbr":{
            "$ref":"#/definitions/travelDocNbr"
        },
        "expiryDate":{
            "$ref":"#/definitions/expiryDate"
        },
        "issuingState":{
            "$ref":"#/definitions/issuingStateCode"
        },
        "inTransit":{
            "$ref":"#/definitions/inTransit"
        },
        "eesEtiasOutOfScope":{
            "$ref":"#/definitions/eesEtiasOutOfScope"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Created

Root Schema : manifestsPOSTResponse

Type: object

Title: manifestsPOSTResponse

EES Request File Manifest Response

Show Source

arrivalDate: string(ISO 8601 (YYYY-DD-MM))

Embarkation Date

Example: 2025-19-04
arrivalHarbor: object arrivalHarbor

Arrival Harbor Object
createdDateTime: string(YYYY-MM-DD HH:mm:ss)

Created Date and Time

Example: 2025-03-28 16:30:56
cruiseItineraryName: string

Minimum Length: 1

Maximum Length: 50

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

Cruise Itinerary Name

Example: Fjord Itinerary
departureDateTime: string(YYYY-DD-MM HH:mm)

Disembarkation Date & Time

Example: 2025-20-04 16:15
disembarkationHarbor: string

Disembarkation Harbor Name

Example: White Harbour
doubleEntryRequired: string

Double entry required * YES * NO

Example: YES
guestManifestList: array guestManifestListPOSTResponseObject
requestFileStatus: string

Request File Status * Pending * Completed * Deleted

Example: Pending
scheduleNo: string

Minimum Length: 1

Maximum Length: 18

Schedule Number

Example: SN1001

{
    "title":"manifestsPOSTResponse",
    "description":"EES Request File Manifest Response",
    "type":"object",
    "properties":{
        "scheduleNo":{
            "$ref":"#/definitions/scheduleNo"
        },
        "cruiseItineraryName":{
            "$ref":"#/definitions/cruiseItineraryName"
        },
        "arrivalDate":{
            "$ref":"#/definitions/arrivalDatePOSTResponse"
        },
        "arrivalHarbor":{
            "$ref":"#/definitions/arrivalHarbor"
        },
        "departureDateTime":{
            "$ref":"#/definitions/departureDateTimePOSTResponse"
        },
        "disembarkationHarbor":{
            "$ref":"#/definitions/disembarkationHarbor"
        },
        "doubleEntryRequired":{
            "$ref":"#/definitions/doubleEntryRequired"
        },
        "guestManifestList":{
            "$ref":"#/definitions/guestManifestListPOSTResponseObject"
        },
        "createdDateTime":{
            "$ref":"#/definitions/createdDateTime"
        },
        "requestFileStatus":{
            "$ref":"#/definitions/requestFileStatus"
        }
    }
}

Nested Schema : arrivalHarbor

Type: object

Arrival Harbor Object

Show Source

code: number

Pattern: ^[0-9]*$

Example: 11
countryCode: string(Alpha-3 ISO3166)

Pattern: ^[A-Z]{3}$

Country Code

Example: USA
countryDescription: string

Country Name

Example: United States
description: string

Embarkation Harbor Name

Example: White Harbour

{
    "description":"Arrival Harbor Object",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/embarkationHarborId"
        },
        "description":{
            "$ref":"#/definitions/embarkationHarborName"
        },
        "countryCode":{
            "$ref":"#/definitions/countryCode"
        },
        "countryDescription":{
            "$ref":"#/definitions/countryDescription"
        }
    }
}

Nested Schema : guestManifestListPOSTResponseObject

Type: array

Show Source

Array of: object guestManifestListItemsPOST

Guest Manifest Response List

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

Nested Schema : guestManifestListItemsPOST

Type: object

Guest Manifest Response List

Show Source

dateOfBirth: string(ISO 8601 (YYYY-DD-MM))

Date of Birth

Example: 1999-15-02
eesEtiasOutOfScope: string

Traveller out of EES/ETIAS scope * YES * NO

Example: NO
expiryDate: string(ISO 8601 (YYYY-DD-MM))

Travel Document Expiry Date

Example: 2025-25-02
givenName: string

Minimum Length: 1

Maximum Length: 16

First Name

Example: Maya
guestStatus: string

Guest EES Response Status * Pending * Completed * Deleted

Example: Pending
inTransit: string

Traveller in transit * YES * NO

Example: NO
issuingState: object issuingState

Travel Document Issued Country
paxNationality: object paxNationality

Nationality
pReqID: number

Minimum Length: 1

Pattern: ^[0-9]*$

Folio Number (Reservation Account Id)

Example: 1001
sex: string

Gender * Female * Male * Unspecified

Example: Female
stateroomNo: string

Minimum Length: 1

Maximum Length: 20

Stateroom Number

Example: 1020
surname: string

Minimum Length: 1

Maximum Length: 16

Last Name

Example: Walters
travelDocNbr: string

Pattern: ^[A-Z0-9]{16}$

Travel Document Number

Example: A1510202
travelDocType: string

Minimum Length: 1

Maximum Length: 8

Travel Document Type

Example: passport

{
    "description":"Guest Manifest Response List",
    "type":"object",
    "properties":{
        "pReqID":{
            "$ref":"#/definitions/pReqID"
        },
        "surname":{
            "$ref":"#/definitions/surname"
        },
        "givenName":{
            "$ref":"#/definitions/givenName"
        },
        "stateroomNo":{
            "$ref":"#/definitions/stateroomNo"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirthPOSTResponse"
        },
        "sex":{
            "$ref":"#/definitions/sex"
        },
        "paxNationality":{
            "$ref":"#/definitions/paxNationality"
        },
        "travelDocType":{
            "$ref":"#/definitions/travelDocType"
        },
        "travelDocNbr":{
            "$ref":"#/definitions/travelDocNbr"
        },
        "expiryDate":{
            "$ref":"#/definitions/expiryDatePOSTResponse"
        },
        "issuingState":{
            "$ref":"#/definitions/issuingState"
        },
        "inTransit":{
            "$ref":"#/definitions/inTransit"
        },
        "eesEtiasOutOfScope":{
            "$ref":"#/definitions/eesEtiasOutOfScope"
        },
        "guestStatus":{
            "$ref":"#/definitions/guestStatus"
        }
    }
}

Nested Schema : issuingState

Type: object

Travel Document Issued Country

Show Source

code: string(Alpha-3 ISO3166)

Pattern: ^[A-Z]{3}$

Country Code

Example: USA
description: string

Country Name

Example: United States

{
    "description":"Travel Document Issued Country",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/countryCode"
        },
        "description":{
            "$ref":"#/definitions/countryDescription"
        }
    }
}

Nested Schema : paxNationality

Type: object

Nationality

Show Source

code: string(Alpha-3 ISO3166)

Pattern: ^[A-Z]{3}$

Country Code

Example: USA
description: string

Country Name

Example: United States

{
    "description":"Nationality",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/countryCode"
        },
        "description":{
            "$ref":"#/definitions/countryDescription"
        }
    }
}

400 Response

Bad Request

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/eesRequestFileErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Malformed JSON request"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Malformed JSON request"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/eesRequestFileErrorResponse"
        }
    ],
    "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: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/eesRequestFileErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

Example:

{
    "type":"http://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: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/eesRequestFileErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"HTTP 404 Not Found"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"HTTP 404 Not Found"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/eesRequestFileErrorResponse"
        }
    ],
    "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: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/eesRequestFileErrorResponse"
        }
    ],
    "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: string
title: string
type: string

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

410 Response

Gone

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/eesRequestFileErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
        "title":"Gone",
        "detail":"Requested Resource no longer exists"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
    "title":"Gone",
    "detail":"Requested Resource no longer exists"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"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 Error Response

Title: Error Response

Error Response returned when encountered error

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

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/eesRequestFileErrorResponse"
        }
    ],
    "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: string
title: string
type: string

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

501 Response

Not Implemented

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/eesRequestFileErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
        "title":"Not implemented",
        "detail":"Resource is not implemented in this version of the API"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
    "title":"Not implemented",
    "detail":"Resource is not implemented in this version of the API"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/eesRequestFileErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service not available"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service not available"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

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