Retrieve listing of guests with EES status
get
/spms/v2/ships/{shipId}/borderControls/ees/guestsEesStatusList
This is to retrieve the listing of guests 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 limitDefault 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/descDefault 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
OK
Root Schema : guestEesStatusListResponseObject
Type:
object
Title:
Show Source
guestEesStatusListResponseObject
-
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 limitExample:
1
-
offset:
number
Paging offsetExample:
10
Nested Schema : items
Type:
Show Source
array
-
Array of:
object guestEesStatusList
Title:
guestEesStatusList
Guest EES Response Status List
Nested Schema : guestEesStatusList
Type:
object
Title:
guestEesStatusList
Guest EES Response Status List
Show Source
-
arrivalDate:
string(ISO 8601 (YYYY-MM-DD))
Embarkation DateExample:
2025-04-19
-
arrivalHarbor:
object arrivalHarbor
Arrival Harbor Object
-
code:
string
EES Response Status * OK * NOK EES * NOKETIAS * NA * `null` if emptyExample:
OK
-
departureDateTime:
string(YYYY-MM-DD HH:mm)
Disembarkation Date & TimeExample:
2025-04-20 16:15
-
disembarkationHarbor:
string
Disembarkation Harbor NameExample:
White Harbour
-
expiryDate:
string(ISO 8601 (YYYY-MM-DD))
Travel Document Expiry DateExample:
2025-02-25
-
givenName:
string
Minimum Length:
1
Maximum Length:16
First NameExample:Maya
-
guestStatus:
string
Guest EES Response Status * Pending * Completed * DeletedExample:
Pending
-
id:
number
Minimum Length:
1
Pattern:^[0-9]*$
EES Transaction IdExample: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 NumberExample:SN1001
-
sex:
string
Gender * Female * Male * UnspecifiedExample:
Female
-
stateroomNo:
string
Minimum Length:
1
Maximum Length:20
Stateroom NumberExample:1020
-
surname:
string
Minimum Length:
1
Maximum Length:16
Last NameExample:Walters
-
travelDocNbr:
string
Pattern:
^[A-Z0-9]{16}$
Travel Document NumberExample:A1510202
-
travelDocType:
string
Minimum Length:
1
Maximum Length:8
Travel Document TypeExample:passport
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 CodeExample:USA
-
countryDescription:
string
Country NameExample:
United States
-
description:
string
Embarkation Harbor NameExample:
White Harbour
Nested Schema : issuingState
Type:
object
Travel Document Issued Country
Show Source
-
code:
string(Alpha-3 ISO3166)
Pattern:
^[A-Z]{3}$
Country CodeExample:USA
-
description:
string
Country NameExample:
United States
Nested Schema : paxNationality
Type:
object
Nationality
Show Source
-
code:
string(Alpha-3 ISO3166)
Pattern:
^[A-Z]{3}$
Country CodeExample:USA
-
description:
string
Country NameExample:
United States
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
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
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
404 Response
Not Found
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
410 Response
Gone
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
415 Response
Unsupported Media Type
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
501 Response
Not Implemented
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
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