Retrieve an instance of countries

get

/services/rest/connect/latest/countries/{id}

Request

Path Parameters

Response

Supported Media Types

Default Response

Body ()
Represents a country object defined in the system.
Root Schema : countries
Type: object
Represents a country object defined in the system.
Show Source
  • Maximum Length: 3
    Pattern: ^[A-Z]{2,3}$
    The two or three character abbreviation for this country.
  • Creation date and time. Read-only
  • Minimum Value: 1
    Maximum Value: 2147483647
    The position of the country in the Countries/Provinces tree and drop-down menu.
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Primary key identifier
  • Maximum Length: 2
    Pattern: ^[A-Z]{2}$
    The ISO 3166 country code.
  • Maximum Length: 255
    Name used to lookup this object
  • Maximum Length: 80
    Name of the Country in the current interface's language. Read-only.
  • countries-names
    Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
  • Maximum Length: 10
    Pattern: ^[][+0-9a-zA-Z[:blank:].,()#-/]*$
    used by the Click-to-Dial feature."
  • Maximum Length: 80
    Pattern: ^(([U|L|M][#|A|L|C])|(F.))+$
    A string of twice as many characters as found in the phone number. Two (2) characters are needed to represent every digit or character in the phone number. The first character of the mask describes the target character and the second constrains its type.
  • Maximum Length: 20
    Pattern: ^(([U|L|M][#|A|L|C])|(F.))+$
    A string of twice as many characters as found in the postal code (target). Two (2) characters are needed to represent every digit or character in the postal code. The first character of the mask describes the target character and the second constrains its type.
  • countries-provinces
    Contains information about the provinces in the Countries/Provinces customizable menu.
  • Last updated date and time. Read-only
Nested Schema : countries-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : countries-provinces
Type: object
Contains information about the provinces in the Countries/Provinces customizable menu.
Show Source
  • Minimum Value: 1
    Maximum Value: 32767
    Display position relative to other provinces associated with the same country.
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    The Province ID.
  • Maximum Length: 255
    The name of the province in the current interface's language. Read-only.
  • countries-provinces-names
    Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Nested Schema : namedIDs-countries-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : countries-provinces-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : namedIDs-countries-provinces-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source

Examples

Use GET with the following syntax to retrieve data for a country:

https://your_site_interface/services/rest/connect/version/countries/country_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/countries/2

Response body example

{
  "id": 2,
  "lookupName": "CA",
  "abbreviation": "CA",
  "displayOrder": 2,
  "iSOCode": "CA",
  "name": "Canada",
  "names": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/countries/2/names"
      }
    ]
  },
  "provinces": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/countries/2/provinces"
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/countries/2"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/countries/2"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/countries",
      "mediaType": "application/schema+json"
    }
  ]
}