Skip to main content

GET /api/v1/service/countryCodes

Use this method to return a list of country and region codes.

Authentication​

Authentication with username and password is required.

Resource URI​

GET https://{orchestrator_server_IP}/api/v1/service/countryCodes

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.

Response body​

When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).

AttributesTypeDescription
resultsArray of objectsInformation about each country or region
 abbreviationStringTwo-letter ISO 3166 code for the country or region
 nameStringCountry or region name
_linksObjectResource URI (see Links)
The following example is returned if the request is successful.
{
   "result": [
      {
         "abbreviation": "AO",
         "name": "ANGOLA"
      },
      {
         "abbreviation": "AR",
         "name": "ARGENTINA"
      },
      ...,
      {
         "abbreviation": "ZM",
         "name": "ZAMBIA"
      },
      {
         "abbreviation": "ZW",
         "name": "ZIMBABWE"
      }
   ],
   "_links": {
      "rel": "self",
      "uri": "/api/v1/service/countryCodes"
   }
}