Update configured EES configuration
put
/spms/v2/ships/{shipId}/configurations/eesConfigurations
This is to update the configured EES configuration details
Request
Supported Media Types
- application/json
Path Parameters
-
shipId(required): integer
ship Id
Root Schema : EES Configuration Request
Type:
object
Title:
EES Configuration Request
EES Configuration Request
Show Source
Nested Schema : excludedTravelDocumentTypeCode
Type:
Show Source
array
-
Array of:
string
Example:
1001
Response
Supported Media Types
- application/json
200 Response
Updated
Root Schema : EES Configuration Details
Type:
object
Title:
EES Configuration Details
EES Configuration Details
Show Source
-
eesConfigurationsId:
integer
Title:
EES Configuration ID
Minimum Value:1
Pattern:^[0-9]*$
EES Configuration IDExample:1001
-
excludedTravelDocumentType:
array Excluded Travel Document Types
Title:
Excluded Travel Document Types
Excluded Travel Document Types -
nationalityGroup:
object Nationality Group
Title:
Nationality Group
Nationality Group
Nested Schema : Excluded Travel Document Types
Type:
array
Title:
Excluded Travel Document Types
Excluded Travel Document Types
Show Source
-
Array of:
object Excluded Travel Document Type
Title:
Excluded Travel Document Type
Excluded Travel Document Type
Example:
[
{
"code":"1001",
"description":"Multiple Visa"
},
{
"code":"1002",
"description":"National Card"
}
]
Nested Schema : Nationality Group
Type:
object
Title:
Nationality Group
Nationality Group
Show Source
-
code:
string
Pattern:
^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=|^'":;@`]*$
Example:1001
-
description:
string
Pattern:
^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=|^'":;@`]*$
Example:Non European Nationality Group
Nested Schema : Excluded Travel Document Type
Type:
object
Title:
Excluded Travel Document Type
Excluded Travel Document Type
Show Source
-
code:
string
Pattern:
^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=|^'":;@`]*$
Example:1001
-
description:
string
Pattern:
^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=|^'":;@`]*$
Example:Mutiple Visa
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":"https://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":"Profile ID - 123 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
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
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":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
"title":"Service Unavailable",
"detail":"Service Unavailable. Try again later"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source