Create EES Request File

You can create EES Request file using the REST API.

Note:
  • The cURL command examples use the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain. See Send Requests.

To create EES Request file:

  1. Prepare list of guest manifests to be included in EES Request file
    curl -i -X GET -H "Authorization:Bearer {access-token}" https://rest_server_url/spms/v2/ships/{shipId}/borderControls/ees/guestManifestLists?itineraryId=1234

    Specify the following options on the cURL command line:

    • -i option to include the HTTP header in the output. This option is optional.

    • -X option to indicate the type of request (GET).

    • -H to include access token

    The following shows an example of the response body.

    {
      "scheduleNo": "SN1001",
      "cruiseItineraryName": "Fjord Itinerary",
      "arrivalDate": "2025-04-19",
      "arrivalHarbor": {
        "code": 11,
        "description": "White Harbour",
        "countryCode": "USA",
        "countryDescription": "United States"
      },
      "departureDateTime": "2025-04-20 16:15",
      "disembarkationHarbor": "White Harbour",
      "profileType": "Guest",
      "guestManifestList": [
        {
          "pReqID": 1001,
          "surname": "Walters",
          "givenName": "Maya",
          "stateroomNo": "1020",
          "dateOfBirth": "1999-xx-xx",
          "sex": "Female",
          "paxNationality": {
            "code": "USA",
            "description": "United States"
          },
          "travelDocType": "passport",
          "travelDocNbr": "A15xxxxx",
          "expiryDate": "2025-xx-xx",
          "issuingState": {
            "code": "USA",
            "description": "United States"
          },
          "inTransit": "NO",
          "doubleEntryRequired": "YES",
          "eesEtiasOutOfScope": "NO",
          "arrivalDestination": {
            "harborCode": "White",
            "harborDescription": "White Harbour",
            "countryCode": "USA",
            "countryDescription": "United States"
          },
          "arrivalDate": "2025-04-19",
          "departureDateTime": "2025-04-20 16:15"
        }
      ]
    }
  2. Create EES Request file with payload generated above
    curl -i -X POST -H "Authorization:Bearer {access-token}" -H "Content-Type: application/json" -d "{manifest payload}" https://rest_server_url/spms/v2/ships/{shipId}/borderControls/ees/manifests

    Supply previous generated payload