Retrieve list of enabled Nationality Groups
get
/spms/v1/configurations/nationalityGroups/enabled
This is to retrieve list of enabled Nationality Groups
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : CreateNationalityGroup
Type:
object
Nationality Group
Show Source
-
assignedNationalities(optional):
array assignedNationalities
-
code(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[a-zA-Z0-9 ]*$
Example:Asia
-
description(optional):
string
Minimum Length:
1
Maximum Length:20
Pattern:^[a-zA-Z0-9 ]*$
Example:Asia Nationality Group
-
enabled(optional):
boolean
Example:
true
Nested Schema : assignedNationalities
Type:
Show Source
array
-
Array of:
object assignedNationalities
Assigned Nationalities
Nested Schema : assignedNationalities
Type:
object
Assigned Nationalities
Show Source
-
code(optional):
string
Minimum Length:
1
Maximum Length:6
Pattern:^[a-zA-Z0-9 ]*$
Example:MY
-
description(optional):
string
Minimum Length:
1
Maximum Length:12
Pattern:^[a-zA-Z0-9 ]*$
Example:Malaysia
204 Response
No Content
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.2",
"title":"Bad Request",
"detail":"The parameter templateId 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":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"Access to this resource was forbidden"
}
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":"https://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
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":"https://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