Retrieve list of travel document rules
get
/spms/v2/ships/{shipId}/configurations/travelDocumentRules
This is to retrieve list of travel document rules
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: number
ship Id
Query Parameters
-
isActive: boolean
Activation status of the travel document type: * `true` - Travel document rule is active * `false` - Travel document rule is inactive
-
limit: integer(int32)
Minimum Value:
0
Paging limit -
offset: integer(int32)
Minimum Value:
0
Paging offset -
orderBy: string
Minimum Value:
0
order by id, travelDocumentRuleCode and travelDocumentRuleName with format column1:asc/desc,column2:asc/desc -
searchValue: string
Search for travel document rule code or name
-
travelDocumentRuleCode: string
Travel document rule code
-
travelDocumentRuleName: string
Travel document rule name
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : schema
Type:
Show Source
array
-
Array of:
object Travel Document Rule Response List
Title:
Travel Document Rule Response List
The Travel Document Rule is executed successfully
Nested Schema : Travel Document Rule Response List
Type:
object
Title:
Travel Document Rule Response List
The Travel Document Rule is executed successfully
Show Source
-
count(optional):
integer
Example:
12345678
-
hasMore(optional):
boolean
Example:
true
-
items(optional):
array items
-
limit(optional):
integer
Example:
10
-
offset(optional):
integer
Example:
1
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Travel Document Rule Configuration List
Title:
Travel Document Rule Configuration List
The Travel Document Rule Configuration is executed successfully
Nested Schema : Travel Document Rule Configuration List
Type:
object
Title:
Travel Document Rule Configuration List
The Travel Document Rule Configuration is executed successfully
Show Source
-
checkListInfo(optional):
array checkListInfo
-
disembarkCountryCode(optional):
string
Disembark country codeExample:
US
-
disembarkCountryName(optional):
string
Disembark country nameExample:
United State
-
embarkCountryCode(optional):
string
Embark country codeExample:
US
-
embarkCountryName(optional):
string
Embark country nameExample:
United State
-
id(optional):
integer
Travel document rule IdExample:
1234
-
isActive(optional):
boolean
travel document type active statusExample:
true
-
isNationalityGroup(optional):
boolean
Is using nationality groupExample:
true
-
travelDocumentRuleCode(optional):
string
Travel document rule codeExample:
TD01
-
travelDocumentRuleName(optional):
string
Travel document rule nameExample:
USA
Nested Schema : items
Match All
Show Source
-
object
TravelDocumentTypeCheckListGroup
Travel document type check list group
Nested Schema : TravelDocumentTypeCheckListGroup
Type:
object
Travel document type check list group
Show Source
-
groupId(optional):
integer
Reference for the created rule rowExample:
1
-
nationalityList(optional):
array nationalityList
-
travelDocumentTypeList(optional):
array travelDocumentTypeList
Nested Schema : NationalityList
Type:
object
Nationality list
Show Source
-
nationality(optional):
string
Example:
United State
-
nationalityCode(optional):
string
Example:
US
Nested Schema : TravelDocumentTypeList
Type:
object
Travel document type list
Show Source
-
travelDocumentTypeCode(optional):
string
Example:
P
-
travelDocumentTypeName(optional):
string
Example:
Passport
204 Response
No Content
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Travel Document Rule Configurations Error Response
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Bad Request",
"detail":"limit must not be less than one!"
}
Nested Schema : Travel Document Rule Configurations Error Response
Type:
object
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations Error Response returned when encountered error
Show Source
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Travel Document Rule Configurations Error Response
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations 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 : Travel Document Rule Configurations Error Response
Type:
object
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations Error Response returned when encountered error
Show Source
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Travel Document Rule Configurations Error Response
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations 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 : Travel Document Rule Configurations Error Response
Type:
object
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations Error Response returned when encountered error
Show Source
404 Response
Not Found
Root Schema : schema
Match All
Show Source
-
object
Travel Document Rule Configurations Error Response
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
"title":"Not Found",
"detail":"No Immigration Rule is available"
}
Nested Schema : Travel Document Rule Configurations Error Response
Type:
object
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Travel Document Rule Configurations Error Response
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations 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 : Travel Document Rule Configurations Error Response
Type:
object
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations Error Response returned when encountered error
Show Source
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Travel Document Rule Configurations Error Response
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations 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 : Travel Document Rule Configurations Error Response
Type:
object
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Travel Document Rule Configurations Error Response
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations 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 : Travel Document Rule Configurations Error Response
Type:
object
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations Error Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Travel Document Rule Configurations Error Response
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations 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 : Travel Document Rule Configurations Error Response
Type:
object
Title:
Travel Document Rule Configurations Error Response
Travel Document Rule Configurations Error Response returned when encountered error
Show Source