Jump to

• Request
• Response

Create System to System EES Request File

post

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

This is to create EES request file that include reservation manifest details for EES CI Method is System to System.

Request

Supported Media Types

• application/json

Path Parameters

• shipId(required): number
  Ship Id

Body ()

Reservation Records Object

Root Schema : EES S2S Manifests Request

Type: object

Title: EES S2S Manifests Request

EES S2S Manifests Request Body

Show Source

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

  Example: 2025-04-19
• cruiseItineraryName(required): string
  Minimum Length: 1

  Maximum Length: 50

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

  Cruise Itinerary Name

  Example: Fjord Itinerary
• departureDateTime(required): string(YYYY-MM-DD HH:mm)
  Disembarkation Date & Time

  Example: 2025-04-20 16:15
• embarkationHarborId(required): number
  Pattern: ^[0-9]*$

  Example: 11
• guestManifestList(required): array s2sManifestRequestGuestListObject
• profileType(required): string
  Allowed Values: [ "Guest", "Crew" ]

  Reservation Profile Type

  Example: Guest
• scheduleNo(required): string
  Minimum Length: 1

  Maximum Length: 17

  Pattern: ^[A-Za-z0-9-]*$

  Schedule Number

  Example: 1324F

{
    "title":"EES S2S Manifests Request",
    "description":"EES S2S Manifests Request Body",
    "type":"object",
    "properties":{
        "scheduleNo":{
            "$ref":"#/definitions/s2sscheduleNo"
        },
        "cruiseItineraryName":{
            "$ref":"#/definitions/cruiseItineraryName"
        },
        "arrivalDate":{
            "$ref":"#/definitions/eesArrivalDate"
        },
        "embarkationHarborId":{
            "$ref":"#/definitions/embarkationHarborId"
        },
        "departureDateTime":{
            "$ref":"#/definitions/departureDateTime"
        },
        "profileType":{
            "$ref":"#/definitions/profileType"
        },
        "guestManifestList":{
            "$ref":"#/definitions/s2sManifestRequestGuestListObject"
        }
    },
    "required":[
        "scheduleNo",
        "cruiseItineraryName",
        "arrivalDate",
        "embarkationHarborId",
        "departureDateTime",
        "profileType",
        "guestManifestList"
    ]
}

Nested Schema : s2sManifestRequestGuestListObject

Type: array

Show Source

• Array of: object s2sManifestRequestGuestList
  System To System Guest Manifest List

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

Nested Schema : s2sManifestRequestGuestList

Type: object

System To System Guest Manifest List

Show Source

• arrivalDate(required): string(ISO 8601 (YYYY-MM-DD))
  Guest Arrival Date

  Example: 2025-04-19
• dateOfBirth(required): string(ISO 8601 (YYYY-MM-DD))
  Date of Birth

  Example: 1999-02-15
• departureDateTime(required): string(YYYY-MM-DD HH:mm)
  Guest Departure Date & Time

  Example: 2025-04-20 16:15
• disembarkPort(required): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[a-zA-Z0-9- ]*$

  Disembarkation Harbor Code

  Example: White
• disembarkPortName(required): string
  Minimum Length: 1

  Maximum Length: 1000

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

  Disembarkation Harbor Name

  Example: White Harbour
• doubleEntryRequired(required): string
  Double entry required * YES * NO

  Example: YES
• eesEtiasOutOfScope(required): string
  Traveller out of EES/ETIAS scope * YES * NO

  Example: NO
• expiryDate(required): string(ISO 8601 (YYYY-MM-DD))
  Travel Document Expiry Date

  Example: 2025-02-25
• givenName(required): string
  Minimum Length: 1

  Maximum Length: 39

  Pattern: ^[A-Za-zÀ-ÖØ-öø-ÿĀ-ſ'\- ]*$

  First Name

  Example: EKATERINA
• inTransit(required): string
  Traveller in transit * YES * NO

  Example: NO
• issuingState(required): string(Alpha-3 ISO3166)
  Pattern: ^([A-Z]{3}|D)$

  Travel Document Issued Country Code

  Example: KAZ
• paxNationality(required): string(Alpha-3 ISO3166)
  Pattern: ^([A-Z]{3}|D)$

  Nationality Country Code

  Example: KAZ
• pReqID(required): number
  Minimum Length: 1

  Pattern: ^[0-9]*$

  Folio Number (Reservation Account Id)

  Example: 1001
• sex(required): string
  Gender * Female * Male * Unspecified

  Example: Female
• stateroomNo(required): string
  Minimum Length: 1

  Maximum Length: 20

  Stateroom Number

  Example: 1020
• surname(required): string
  Minimum Length: 1

  Maximum Length: 39

  Pattern: ^[A-Za-zÀ-ÖØ-öø-ÿĀ-ſ'\- ]*$

  Last Name

  Example: KLIMOVA
• targetCountry(required): string
  Minimum Length: 1

  Maximum Length: 1000

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

  Guest Target Country

  Example: United States
• travelDocNbr(required): string
  Minimum Length: 1

  Maximum Length: 35

  Pattern: ^[A-Z0-9]*$

  Travel Document Number

  Example: HX9092231
• travelDocType(required): string
  Minimum Length: 1

  Maximum Length: 8

  Travel Document Type

  Example: passport

{
    "description":"System To System Guest Manifest List",
    "type":"object",
    "properties":{
        "pReqID":{
            "$ref":"#/definitions/pReqID"
        },
        "surname":{
            "$ref":"#/definitions/s2sSurname"
        },
        "givenName":{
            "$ref":"#/definitions/s2sGivenName"
        },
        "stateroomNo":{
            "$ref":"#/definitions/stateroomNo"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "sex":{
            "$ref":"#/definitions/sex"
        },
        "paxNationality":{
            "$ref":"#/definitions/s2sPaxNationalityCode"
        },
        "travelDocType":{
            "$ref":"#/definitions/s2sTravelDocType"
        },
        "travelDocNbr":{
            "$ref":"#/definitions/s2sTravelDocNbr"
        },
        "expiryDate":{
            "$ref":"#/definitions/expiryDate"
        },
        "issuingState":{
            "$ref":"#/definitions/s2sIssuingStateCode"
        },
        "inTransit":{
            "$ref":"#/definitions/inTransit"
        },
        "arrivalDate":{
            "$ref":"#/definitions/guestArrivalDate"
        },
        "departureDateTime":{
            "$ref":"#/definitions/guestDepartureDateTime"
        },
        "doubleEntryRequired":{
            "$ref":"#/definitions/doubleEntryRequired"
        },
        "disembarkPort":{
            "$ref":"#/definitions/disembarkationHarborCode"
        },
        "disembarkPortName":{
            "$ref":"#/definitions/disembarkationHarborName"
        },
        "targetCountry":{
            "$ref":"#/definitions/targetCountry"
        },
        "eesEtiasOutOfScope":{
            "$ref":"#/definitions/eesEtiasOutOfScope"
        }
    },
    "required":[
        "pReqID",
        "surname",
        "givenName",
        "stateroomNo",
        "dateOfBirth",
        "sex",
        "paxNationality",
        "travelDocType",
        "travelDocNbr",
        "expiryDate",
        "issuingState",
        "inTransit",
        "arrivalDate",
        "departureDateTime",
        "doubleEntryRequired",
        "disembarkPort",
        "disembarkPortName",
        "targetCountry",
        "eesEtiasOutOfScope"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

Body ()

Root Schema : s2sManifestsPOSTResponse

Type: object

Title: s2sManifestsPOSTResponse

EES S2S Request File Manifest Response

Show Source

• carrierID: string
  Carrier ID

  Example: C0001
• nReqID: string
  Notification request identifier

  Example: IK99911100
• pngs: object pngsPOSTResponseObject
• submissionDT: string(ISO 8601 (YYYY-MM-DDThh:mm:ss.sssTZD))
  Query submission date and time

  Example: 2025-04-12T16:15:00+03:00
• user: string
  User Name or ID

  Example: SWSDA004

{
    "title":"s2sManifestsPOSTResponse",
    "description":"EES S2S Request File Manifest Response",
    "type":"object",
    "properties":{
        "carrierID":{
            "$ref":"#/definitions/carrierID"
        },
        "nReqID":{
            "$ref":"#/definitions/nReqID"
        },
        "submissionDT":{
            "$ref":"#/definitions/submissionDT"
        },
        "user":{
            "$ref":"#/definitions/user"
        },
        "pngs":{
            "$ref":"#/definitions/pngsPOSTResponseObject"
        }
    }
}

Nested Schema : pngsPOSTResponseObject

Type: object

Show Source

• png: array pngPOSTResponseObject

{
    "type":"object",
    "properties":{
        "png":{
            "$ref":"#/definitions/pngPOSTResponseObject"
        }
    }
}

Nested Schema : pngPOSTResponseObject

Type: array

Show Source

• Array of: object pngListItemsPOST
  EES S2S png Response List

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

Nested Schema : pngListItemsPOST

Type: object

EES S2S png Response List

Show Source

• arrivalLocation: object s2sArrivalLocationObject
  EES S2S Arrival Location Response Object
• docs: object s2sDocs
  EES S2S Docs Response Object
• eesetiasOutOfScope: boolean
  Traveller out of EES/ETIAS scope

  Example: true
• inTransit: boolean
  Traveller in transit

  Example: true
• multipleEntry: boolean
  Multiple entry required

  Example: true
• pReqID: string
  Passenger request identifier

  Example: 1001

{
    "description":"EES S2S png Response List",
    "type":"object",
    "properties":{
        "eesetiasOutOfScope":{
            "$ref":"#/definitions/s2sEesEtiasOutOfScope"
        },
        "inTransit":{
            "$ref":"#/definitions/s2sInTransit"
        },
        "multipleEntry":{
            "$ref":"#/definitions/s2sMultipleEntry"
        },
        "pReqID":{
            "$ref":"#/definitions/s2sPReqID"
        },
        "arrivalLocation":{
            "$ref":"#/definitions/s2sArrivalLocationObject"
        },
        "docs":{
            "$ref":"#/definitions/s2sDocs"
        }
    }
}

Nested Schema : s2sArrivalLocationObject

Type: object

EES S2S Arrival Location Response Object

Show Source

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

  Example: 2025-04-19
• arrivalLocationCode: string(UN/LOCODE convention)
  Pattern: ^[A-Z]{5}$

  Arrival Location Code

  Example: GRSKG
• departureDatetime: string(ISO 8601 (YYYY-MM-DDThh:mm:ss.sssTZD))
  Guest Departure Date & Time

  Example: 2025-04-12T16:15:00+03:00
• scheduleNo: string
  Minimum Length: 1

  Maximum Length: 17

  Pattern: ^[A-Za-z0-9-]*$

  Schedule Number

  Example: 1324F

{
    "description":"EES S2S Arrival Location Response Object",
    "type":"object",
    "properties":{
        "arrivalDate":{
            "$ref":"#/definitions/guestArrivalDate"
        },
        "arrivalLocationCode":{
            "$ref":"#/definitions/s2sArrivalLocationCode"
        },
        "departureDatetime":{
            "$ref":"#/definitions/s2sGuestDepartureDateTime"
        },
        "scheduleNo":{
            "$ref":"#/definitions/s2sscheduleNo"
        }
    }
}

Nested Schema : s2sDocs

Type: object

EES S2S Docs Response Object

Show Source

• dateOfBirth: string(ISO 8601 (YYYY-MM-DD))
  Date of Birth

  Example: 1999-02-15
• expiryDate: string(ISO 8601 (YYYY-MM-DD))
  Travel Document Expiry Date

  Example: 2025-02-25
• givenName: string
  Minimum Length: 1

  Maximum Length: 39

  Pattern: ^[A-Za-zÀ-ÖØ-öø-ÿĀ-ſ'\- ]*$

  First Name

  Example: EKATERINA
• issuingState: string(Alpha-3 ISO3166)
  Pattern: ^([A-Z]{3}|D)$

  Travel Document Issued Country Code

  Example: KAZ
• paxNationality: string(Alpha-3 ISO3166)
  Pattern: ^([A-Z]{3}|D)$

  Nationality Country Code

  Example: KAZ
• sex: string
  Gender * female * male * unspecified

  Example: female
• surname: string
  Minimum Length: 1

  Maximum Length: 39

  Pattern: ^[A-Za-zÀ-ÖØ-öø-ÿĀ-ſ'\- ]*$

  Last Name

  Example: KLIMOVA
• travelDocNbr: string
  Minimum Length: 1

  Maximum Length: 35

  Pattern: ^[A-Z0-9]*$

  Travel Document Number

  Example: HX9092231
• travelDocType: string
  Travel Document Type

  Example: P

{
    "description":"EES S2S Docs Response Object",
    "type":"object",
    "properties":{
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "expiryDate":{
            "$ref":"#/definitions/expiryDate"
        },
        "givenName":{
            "$ref":"#/definitions/s2sGivenName"
        },
        "issuingState":{
            "$ref":"#/definitions/s2sIssuingStateCode"
        },
        "paxNationality":{
            "$ref":"#/definitions/s2sPaxNationalityCode"
        },
        "surname":{
            "$ref":"#/definitions/s2sSurname"
        },
        "sex":{
            "$ref":"#/definitions/s2sSexPOSTResponse"
        },
        "travelDocNbr":{
            "$ref":"#/definitions/s2sTravelDocNbr"
        },
        "travelDocType":{
            "$ref":"#/definitions/s2sTravelDocTypeResponse"
        }
    }
}

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

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

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