NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Retrieve nation record by using code
get
/spms/v1/configurations/nations/{code}
This is to retrieve a nation record by using code
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
Returns a nation by code
Root Schema : Nations
Type:
objectTitle:
NationsNationality
Show Source
-
abberviation(optional):
string
Pattern:
^[a-zA-Z ]*$Example:USA -
code:
string
Minimum Value:
1Maximum Value:6Pattern:^[a-zA-Z ]*$Example:US -
comment(optional):
string
Minimum Value:
1Maximum Value:4000Pattern:^[a-zA-Z ]*$Example:-USA-,-337- -
custom(optional):
string
Minimum Value:
1Maximum Value:50Pattern:^[a-zA-Z ]*$Example:USA -
enabled(optional):
boolean
Example:
true -
language(optional):
string
Pattern:
^[a-zA-Z ]*$Example:AZ -
name(optional):
string
Minimum Value:
1Maximum Value:1000Pattern:^[a-zA-Z ]*$Example:United States
400 Response
The supplied parameter(s) is not valid
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError 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:
objectTitle:
Error ResponseError 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:
objectTitle:
Error ResponseError 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
404 Response
The nation does not exist
Root Schema : Error Response
Type:
objectTitle:
Error ResponseError 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:
objectTitle:
Error ResponseError 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:
objectTitle:
Error ResponseError 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:
objectTitle:
Error ResponseError 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