Oracle Hospitality Cruise Property Management Border Control REST API 23.2.0

Retrieve listing of reservation with EES status

get

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

This is to retrieve the listing of reservation with EES status from the generated EES request file

Request

Supported Media Types

application/json

Path Parameters

shipId(required): number

Ship Id

Query Parameters

eesStatus: string

EES Response Status * OK * NOK EES * NOKETIAS * NA
embarkationHarborId: number

Embarkation Harbor ID
id: number

Transaction ID (EES request file ID)
itineraryId: integer

Cruise itinerary ID
limit: integer(int32)

Minimum Value: 1

Paging limit

Default Value: 50
offset: integer(int32)

Minimum Value: 0

Paging offset
orderBy: string

Order by EES Status, Folio Number, Surname, Given Name and Nationality with format column1:asc/desc,column2:asc/desc

Default Value: pReqID:asc
searchValue: string

Search for the input text which matches the values either in (surname, givenName, stateroomNo, pReqID). Can be used together with itineraryId and/ or

Response

Supported Media Types

application/json

200 Response

Root Schema : guestEesStatusListResponseObject

Type: object

Title: guestEesStatusListResponseObject

Show Source

count: number

The total number of items in the list.

Example: 20
hasMore: boolean

Flag which indicates whether or not there are more items.

Example: true
items: array items
limit: number

Paging limit

Example: 1
offset: number

Paging offset

Example: 10

{
    "title":"guestEesStatusListResponseObject",
    "type":"object",
    "properties":{
        "count":{
            "description":"The total number of items in the list.",
            "type":"number",
            "example":20
        },
        "hasMore":{
            "description":"Flag which indicates whether or not there are more items.",
            "type":"boolean",
            "example":true
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/guestEesStatusList"
            }
        },
        "limit":{
            "description":"Paging limit",
            "type":"number",
            "example":1
        },
        "offset":{
            "description":"Paging offset",
            "type":"number",
            "example":10
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object guestEesStatusList

Title: guestEesStatusList

Guest EES Response Status List

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

Nested Schema : guestEesStatusList

Type: object

Title: guestEesStatusList

Guest EES Response Status List

Show Source

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

Embarkation Date

Example: 2025-04-19
arrivalHarbor: object arrivalHarbor

Arrival Harbor Object
code: string

EES Response Status * OK * NOK EES * NOKETIAS * NA * `null` if empty

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

Disembarkation Date & Time

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

Disembarkation Harbor Name

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

Travel Document Expiry Date

Example: 2025-02-25
givenName: string

Minimum Length: 1

Maximum Length: 39

First Name

Example: Maya
guestStatus: string

Guest EES Response Status * Pending * Completed * Deleted

Example: Pending
id: number

Minimum Length: 1

Pattern: ^[0-9]*$

EES Transaction Id

Example: 100
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
scheduleNo: string

Minimum Length: 1

Maximum Length: 18

Schedule Number

Example: SN1001
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: 39

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

{
    "title":"guestEesStatusList",
    "description":"Guest EES Response Status List",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/transactionId"
        },
        "code":{
            "$ref":"#/definitions/eesStatus"
        },
        "surname":{
            "$ref":"#/definitions/surnameResponse"
        },
        "givenName":{
            "$ref":"#/definitions/givenNameResponse"
        },
        "sex":{
            "$ref":"#/definitions/sex"
        },
        "stateroomNo":{
            "$ref":"#/definitions/stateroomNo"
        },
        "pReqID":{
            "$ref":"#/definitions/pReqID"
        },
        "scheduleNo":{
            "$ref":"#/definitions/scheduleNo"
        },
        "arrivalDate":{
            "$ref":"#/definitions/eesArrivalDate"
        },
        "arrivalHarbor":{
            "$ref":"#/definitions/arrivalHarbor"
        },
        "departureDateTime":{
            "$ref":"#/definitions/departureDateTime"
        },
        "disembarkationHarbor":{
            "$ref":"#/definitions/disembarkationHarbor"
        },
        "travelDocType":{
            "$ref":"#/definitions/travelDocType"
        },
        "travelDocNbr":{
            "$ref":"#/definitions/travelDocNbr"
        },
        "issuingState":{
            "$ref":"#/definitions/issuingState"
        },
        "expiryDate":{
            "$ref":"#/definitions/expiryDate"
        },
        "paxNationality":{
            "$ref":"#/definitions/paxNationality"
        },
        "guestStatus":{
            "$ref":"#/definitions/guestStatus"
        }
    }
}

Nested Schema : arrivalHarbor

Type: object

Arrival Harbor Object

Show Source

code: number

Pattern: ^[0-9]*$

Example: 11
countryCode: string

Minimum Length: 1

Maximum Length: 40

Country Code

Example: ESP
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 : issuingState

Type: object

Travel Document Issued Country

Show Source

code: string

Minimum Length: 1

Maximum Length: 40

Country Code

Example: ESP
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

Minimum Length: 1

Maximum Length: 40

Country Code

Example: ESP
description: string

Country Name

Example: United States

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

204 Response

No Content

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":"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: 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":"Ship 18600000404 was not found"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship 18600000404 was 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"
        }
    }
}