REST API for Oracle Commerce Cloud December 2017

getCountryRegions

get

/ccadmin/v1/countries/{id}

Get Country Regions. Get Country by country ID and all its regions.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The ID of the country which is ISO 3166-1 two letter country code.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getCountryRegions_response

Properties

countryCode: Type: string

ISO 3166-1 two letter country code.
displayName: Type: string

Localized country name.
regions: Type: array regions

Additional Properties Allowed:

The list of regions for particular country.
repositoryId: Type: string

The ID of the country item.

Nested Schema : regions

Type: array

The list of regions for particular country.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

abbreviation: Type: string

The region code in abbreviated form. Usually a 2 character ISO code
displayName: Type: string

Localized region name.
regionCode: Type: string

The region code (4 character ISO code).
repositoryId: Type: string

The ID of the region item.

Example application/json


{
    "regions":[
        {
            "regionCode":"CA-AB",
            "displayName":"Alberta",
            "repositoryId":"CA-AB",
            "abbreviation":"AB"
        },
        {
            "regionCode":"CA-BC",
            "displayName":"British Columbia",
            "repositoryId":"CA-BC",
            "abbreviation":"BC"
        },
        {
            "regionCode":"CA-MB",
            "displayName":"Manitoba",
            "repositoryId":"CA-MB",
            "abbreviation":"MB"
        },
        {
            "regionCode":"CA-NB",
            "displayName":"New Brunswick",
            "repositoryId":"CA-NB",
            "abbreviation":"NB"
        },
        {
            "regionCode":"CA-NL",
            "displayName":"Newfoundland and Labrador",
            "repositoryId":"CA-NL",
            "abbreviation":"NL"
        },
        {
            "regionCode":"CA-NT",
            "displayName":"Northwest Territories",
            "repositoryId":"CA-NT",
            "abbreviation":"NT"
        },
        {
            "regionCode":"CA-NS",
            "displayName":"Nova Scotia",
            "repositoryId":"CA-NS",
            "abbreviation":"NS"
        },
        {
            "regionCode":"CA-NU",
            "displayName":"Nunavut",
            "repositoryId":"CA-NU",
            "abbreviation":"NU"
        },
        {
            "regionCode":"CA-ON",
            "displayName":"Ontario",
            "repositoryId":"CA-ON",
            "abbreviation":"ON"
        },
        {
            "regionCode":"CA-PE",
            "displayName":"Prince Edward Island",
            "repositoryId":"CA-PE",
            "abbreviation":"PE"
        },
        {
            "regionCode":"CA-QC",
            "displayName":"Quebec",
            "repositoryId":"CA-QC",
            "abbreviation":"QC"
        },
        {
            "regionCode":"CA-SK",
            "displayName":"Saskatchewan",
            "repositoryId":"CA-SK",
            "abbreviation":"SK"
        },
        {
            "regionCode":"CA-YT",
            "displayName":"Yukon",
            "repositoryId":"CA-YT",
            "abbreviation":"YT"
        }
    ],
    "countryCode":"CA",
    "displayName":"Canada",
    "repositoryId":"CA"
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "regions": [
    {
      "regionCode": "CA-AB",
      "displayName": "Alberta",
      "repositoryId": "CA-AB",
      "abbreviation": "AB"
    },
    {
      "regionCode": "CA-BC",
      "displayName": "British Columbia",
      "repositoryId": "CA-BC",
      "abbreviation": "BC"
    },
    {
      "regionCode": "CA-MB",
      "displayName": "Manitoba",
      "repositoryId": "CA-MB",
      "abbreviation": "MB"
    },
    {
      "regionCode": "CA-NB",
      "displayName": "New Brunswick",
      "repositoryId": "CA-NB",
      "abbreviation": "NB"
    },
    {
      "regionCode": "CA-NL",
      "displayName": "Newfoundland and Labrador",
      "repositoryId": "CA-NL",
      "abbreviation": "NL"
    },
    {
      "regionCode": "CA-NT",
      "displayName": "Northwest Territories",
      "repositoryId": "CA-NT",
      "abbreviation": "NT"
    },
    {
      "regionCode": "CA-NS",
      "displayName": "Nova Scotia",
      "repositoryId": "CA-NS",
      "abbreviation": "NS"
    },
    {
      "regionCode": "CA-NU",
      "displayName": "Nunavut",
      "repositoryId": "CA-NU",
      "abbreviation": "NU"
    },
    {
      "regionCode": "CA-ON",
      "displayName": "Ontario",
      "repositoryId": "CA-ON",
      "abbreviation": "ON"
    },
    {
      "regionCode": "CA-PE",
      "displayName": "Prince Edward Island",
      "repositoryId": "CA-PE",
      "abbreviation": "PE"
    },
    {
      "regionCode": "CA-QC",
      "displayName": "Quebec",
      "repositoryId": "CA-QC",
      "abbreviation": "QC"
    },
    {
      "regionCode": "CA-SK",
      "displayName": "Saskatchewan",
      "repositoryId": "CA-SK",
      "abbreviation": "SK"
    },
    {
      "regionCode": "CA-YT",
      "displayName": "Yukon",
      "repositoryId": "CA-YT",
      "abbreviation": "YT"
    }
  ],
  "countryCode": "CA",
  "displayName": "Canada",
  "repositoryId": "CA"
}