Jump to

• Request
• Response

Retrieve generated EES request file

get

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

This is to retrieve the generated EES request file without the reservation manifest details

Request

Supported Media Types

• application/json

Path Parameters

• shipId(required): number
  Ship Id

Query Parameters

• 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 cruiseItinerary and requestStatus with format column1:asc/desc,column2:asc/desc

  Default Value: cruiseItinerary:asc
• requestStatus: string
  EES request status

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : requestFileResponseObject

Type: object

Title: requestFileResponseObject

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":"requestFileResponseObject",
    "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/requestFileList"
            }
        },
        "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 requestFileList
  Title: requestFileList

  EES Request File Response

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

Nested Schema : requestFileList

Type: object

Title: requestFileList

EES Request File Response

Show Source

• arrivalDate: string(ISO 8601 (YYYY-MM-DD))
  Embarkation Date

  Example: 2025-04-19
• arrivalHarbor: object arrivalHarbor
  Arrival Harbor Object
• ciMethod: integer
  Title: Carrier Interface Method

  Allowed Values: [ 0, 1 ]

  Indicates the ciMethod. 0 stands for Web Portal (CSV), 1 for System To System (JSON)

  Example: 0
• 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-MM-DD HH:mm)
  Disembarkation Date & Time

  Example: 2025-04-20 16:15
• disembarkationHarbor: string
  Disembarkation Harbor Name

  Example: White Harbour
• errorMessage: string
  Error Message

  Example: Example error message
• id: number
  Minimum Length: 1

  Pattern: ^[0-9]*$

  EES Transaction Id

  Example: 100
• profileType: string
  Allowed Values: [ "Guest", "Crew" ]

  Reservation Profile Type

  Example: Guest
• requestFileStatus: string
  Request File Status * Pending * Completed * Deleted * Error

  Example: Pending
• responseDT: string(ISO 8601 (YYYY-MM-DDThh:mm:ss.sssTZD))
  Response File Date and Time

  Example: 2021-07-13T14:15:57:623Z

{
    "title":"requestFileList",
    "description":"EES Request File Response",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/transactionId"
        },
        "cruiseItineraryName":{
            "$ref":"#/definitions/cruiseItineraryName"
        },
        "arrivalDate":{
            "$ref":"#/definitions/eesArrivalDate"
        },
        "arrivalHarbor":{
            "$ref":"#/definitions/arrivalHarbor"
        },
        "departureDateTime":{
            "$ref":"#/definitions/departureDateTime"
        },
        "disembarkationHarbor":{
            "$ref":"#/definitions/disembarkationHarbor"
        },
        "requestFileStatus":{
            "$ref":"#/definitions/requestFileStatus"
        },
        "profileType":{
            "$ref":"#/definitions/profileType"
        },
        "ciMethod":{
            "$ref":"#/definitions/ciMethod"
        },
        "errorMessage":{
            "$ref":"#/definitions/errorMessage"
        },
        "createdDateTime":{
            "$ref":"#/definitions/createdDateTime"
        },
        "responseDT":{
            "$ref":"#/definitions/responseDT"
        }
    }
}

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

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/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

Body ()

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

Body ()

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

Body ()

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

Body ()

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

Body ()

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

Body ()

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

Body ()

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

Body ()

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

Body ()

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

Body ()

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

Back to Top