NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Create/ Add a new travel document type
post
/spms/v1/configurations/travelDocumentTypes
This is to create/ add a new travel document type
Request
Supported Media Types
- application/json
Required to create Travel Document Type
Root Schema : Travel Document Type
Type:
object
Title:
Travel Document Type
Travel Document Type
Show Source
-
code:
string
Maximum Value:
6
Pattern:^[a-zA-Z_0-9- ]*$
Example:B
-
comment(optional):
string
Maximum Value:
4000
Example:Birth Certificate is a certificate
-
enabled(optional):
boolean
Example:
true
-
name:
string
Maximum Value:
1000
Example:Birth Certificate
Response
Supported Media Types
- application/json
201 Response
Travel Document Type has been created
Root Schema : Travel Document Type
Type:
object
Title:
Travel Document Type
Document Type
Show Source
-
code(optional):
string
Minimum Value:
1
Maximum Value:6
Pattern:^[a-zA-Z_0-9- ]*$
Example:B
-
comment(optional):
string
Minimum Value:
1
Maximum Value:4000
Pattern:^[a-zA-Z ]*$
Example:Birth Certificate is a certificate
-
enabled(optional):
boolean
Example:
true
-
name(optional):
string
Minimum Value:
1
Maximum Value:1000
Pattern:^[a-zA-Z ]*$
Example:Birth Certificate
400 Response
Invalid parameter(s) passed in
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
401 Response
You are not authorized to use this API
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
403 Response
You are forbidden to use this API
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
405 Response
This method is not available
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
409 Response
You are trying to create a Travel Document Type that already existed
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
415 Response
The media supplied is not supported
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
500 Response
Error occurred while processing this request
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
502 Response
Bad Gateway
503 Response
Service not available