Jump to

• Request
• Response

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(required): string
  The ID of the country which is ISO 3166-1 two letter country code.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getCountryRegions_response

Type: object

Show Source

• displayName: string
  Localized country name
• regions: array regions
  The list of regions for particular country.
• repositoryId: string
  The repository ID of the country item.

{
    "properties":{
        "regions":{
            "description":"The list of regions for particular country.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "regionCode":{
                        "description":"The region code (normally its ISO 3166-2 code).",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Localized region name.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The ID of the region item.",
                        "type":"string"
                    },
                    "abbreviation":{
                        "description":"The region code in abbreviated form. Usually a 2 letter country code",
                        "type":"string"
                    }
                }
            }
        },
        "displayName":{
            "description":"Localized country name",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository ID of the country item.",
            "type":"string"
        }
    }
}

Nested Schema : regions

Type: array

The list of regions for particular country.

Show Source

• Array of: object items

{
    "description":"The list of regions for particular country.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "regionCode":{
                "description":"The region code (normally its ISO 3166-2 code).",
                "type":"string"
            },
            "displayName":{
                "description":"Localized region name.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The ID of the region item.",
                "type":"string"
            },
            "abbreviation":{
                "description":"The region code in abbreviated form. Usually a 2 letter country code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• abbreviation: string
  The region code in abbreviated form. Usually a 2 letter country code
• displayName: string
  Localized region name.
• regionCode: string
  The region code (normally its ISO 3166-2 code).
• repositoryId: string
  The ID of the region item.

{
    "type":"object",
    "properties":{
        "regionCode":{
            "description":"The region code (normally its ISO 3166-2 code).",
            "type":"string"
        },
        "displayName":{
            "description":"Localized region name.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The ID of the region item.",
            "type":"string"
        },
        "abbreviation":{
            "description":"The region code in abbreviated form. Usually a 2 letter country code",
            "type":"string"
        }
    }
}

Example Response (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. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |80002|Exception occurred| |80001|The country code is either invalid or not configured : {countryId}| |80003|Exception occurred during sort|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top