Create travel document types
post
/spms/v2/ships/{shipId}/configurations/travelDocumentTypes
This is to create travel document types
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: integer
ship Id
Root Schema : Create Travel Document type
Type:
object
Title:
Create Travel Document type
Create Travel Document type is executed successfully
Show Source
-
isActive(optional):
boolean
Activation status of the travel document type: * `true` - Travel document type is active * `false` - Travel document type is inactiveExample:
true
-
travelDocumentCheckList(optional):
array travelDocumentCheckList
-
travelDocumentCode(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]
Travel document type codeExample:P
-
travelDocumentMapping(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]
Travel document APIS mappingExample:OD
-
travelDocumentName(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]
Travel document type nameExample:Passport
-
travelDocumentRemarks(optional):
string
Pattern:
[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]
Travel document remarksExample:remark
Nested Schema : items
Match All
Show Source
-
object
TravelDocumentCheckListCreate
Travel document check list
Nested Schema : TravelDocumentCheckListCreate
Type:
object
Travel document check list
Show Source
-
isMandatory(optional):
boolean
Example:
true
-
travelDocumentCheckListId(optional):
integer
Example:
1
Response
Supported Media Types
- application/json
201 Response
Created
Root Schema : Travel Document type details
Type:
object
Title:
Travel Document type details
Travel Document type details is retrieved succesfully
Show Source
-
id(optional):
integer
Travel document type IdExample:
1234
-
isActive(optional):
boolean
Activation status of the travel document type: * `true` - Travel document type is active * `false` - Travel document type is inactiveExample:
true
-
travelDocumentCheckList(optional):
array travelDocumentCheckList
-
travelDocumentCode(optional):
string
Travel document type codeExample:
P
-
travelDocumentMapping(optional):
string
Travel document APIS mappingExample:
OD
-
travelDocumentName(optional):
string
Travel document type nameExample:
Passport
-
travelDocumentRemarks(optional):
string
Travel document remarksExample:
remark
Nested Schema : items
Match All
Show Source
-
object
TravelDocFieldCheckList
travel document field check list
Nested Schema : TravelDocFieldCheckList
Type:
object
travel document field check list
Show Source
-
description(optional):
string
Example:
Document Number
-
isMandatory(optional):
boolean
Example:
true
-
travelDocumentCheckListId(optional):
integer
Example:
1
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 ship Id 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":"No predefined field is available"
}
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
409 Response
Conflict
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.10",
"title":"Conflict",
"detail":"Travel Document Type Code duplicate"
}
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