Jump to

• Request
• Response
• Examples

Get a country

get

/services/rest/connect/v1.4/countries/{id}

Request

Path Parameters

• id: integer
  The unique identifier of the country.

Back to Top

Response

Default Response

Body ()

Root Schema : countries

Type: object

The details about the countries and provinces which are used to maintain accurate address information for the organizations and contacts in Oracle B2C Service.

Show Source

• abbreviation(optional): string
  Maximum Length: 3

  Pattern: ^[A-Z]{2,3}$

  The two or three character abbreviation for the country. For example, USA.
• createdTime(optional): string
  The date and time when the country was created. This attribute is read-only.
• displayOrder(optional): integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The position of the country in the Countries/Provinces tree and drop-down menu.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the country.
• iSOCode(optional): string
  Maximum Length: 2

  Pattern: ^[A-Z]{2}$

  The ISO 3166 country code.
• lookupName(optional): string
  Maximum Length: 255

  The name used to look up the country.
• name(optional): string
  Maximum Length: 80

  A list of labels or names used for this country on each unique interface.
• names(optional): object countries-names
  The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
• phoneCode(optional): string
  Maximum Length: 10

  Pattern: ^[][+0-9a-zA-Z[:blank:].,()#-/]*$

  The international telephone code for the country. This is used by the Click-to-Dial feature.
• phoneMask(optional): string
  Maximum Length: 80

  Pattern: ^(([U|L|M][#|A|L|C])|(F.))+$

  The string having twice the number of characters in the phone number. Two 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.
• postalMask(optional): string
  Maximum Length: 20

  Pattern: ^(([U|L|M][#|A|L|C])|(F.))+$

  The string having twice the number of characters in the target postal code. Two 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.
• provinces(optional): object countries-provinces
  The information about the provinces in the Countries/Provinces customizable menu.
• updatedTime(optional): string
  The date and time when the country was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The details about the countries and provinces which are used to maintain accurate address information for the organizations and contacts in Oracle B2C Service.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the country was last updated. This attribute is read-only."
        },
        "provinces":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"A list of states or provinces associated with this country.",
            "$ref":"#/definitions/countries-provinces"
        },
        "iSOCode":{
            "pattern":"^[A-Z]{2}$",
            "type":"string",
            "description":"The ISO 3166 country code.",
            "maxLength":2
        },
        "name":{
            "type":"string",
            "description":"A list of labels or names used for this country on each unique interface.",
            "maxLength":80
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the country.",
            "maxLength":255
        },
        "phoneMask":{
            "pattern":"^(([U|L|M][#|A|L|C])|(F.))+$",
            "type":"string",
            "description":"The string having twice the number of characters in the phone number. Two 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.",
            "maxLength":80
        },
        "abbreviation":{
            "pattern":"^[A-Z]{2,3}$",
            "type":"string",
            "description":"The two or three character abbreviation for the country. For example, USA.",
            "maxLength":3
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The name of the country in the language of the current interface. This attribute is read-only.",
            "$ref":"#/definitions/countries-names"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the country was created. This attribute is read-only."
        },
        "phoneCode":{
            "pattern":"^[][+0-9a-zA-Z[:blank:].,()#-/]*$",
            "type":"string",
            "description":"The international telephone code for the country. This is used by the Click-to-Dial feature.",
            "maxLength":10
        },
        "postalMask":{
            "pattern":"^(([U|L|M][#|A|L|C])|(F.))+$",
            "type":"string",
            "description":"The string having twice the number of characters in the target postal code. Two 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.",
            "maxLength":20
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the country.",
            "maximum":9.223372036854776E18
        },
        "displayOrder":{
            "minimum":1,
            "type":"integer",
            "description":"The position of the country in the Countries/Provinces tree and drop-down menu.",
            "maximum":2147483647
        }
    }
}

Nested Schema : countries-names

Type: object

The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.

Show Source

• labelText(optional): string
  Maximum Length: 80

  The language-specific label text. The value cannot be null or empty.
• language(optional): object namedIDs-countries-names-language
  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.

{
    "type":"object",
    "description":"The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":"string",
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":80
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-countries-names-language"
        }
    }
}

Nested Schema : countries-provinces

Type: object

The information about the provinces in the Countries/Provinces customizable menu.

Show Source

• displayOrder(optional): integer
  Minimum Value: 1

  Maximum Value: 32767

  The display position relative to other provinces associated with the same country.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the province.
• name(optional): string
  Maximum Length: 255

  The name of the province in the language of the current interface. This attribute is read-only.
• names(optional): object countries-provinces-names
  The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.

{
    "type":"object",
    "description":"The information about the provinces in the Countries/Provinces customizable menu.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the province in the language of the current interface. This attribute is read-only.",
            "maxLength":255
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The list of names or labels for the province for each available language.",
            "$ref":"#/definitions/countries-provinces-names"
        },
        "displayOrder":{
            "minimum":1,
            "type":"integer",
            "description":"The display position relative to other provinces associated with the same country.",
            "maximum":32767
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the province.",
            "maximum":9.223372036854776E18
        }
    }
}

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

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : countries-provinces-names

Type: object

The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.

Show Source

• labelText(optional): string
  Maximum Length: 80

  The language-specific label text. The value cannot be null or empty.
• language(optional): object namedIDs-countries-provinces-names-language
  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.

{
    "type":"object",
    "description":"The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":"string",
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":80
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-countries-provinces-names-language"
        }
    }
}

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

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Back to Top

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"
    }
  ]
}

Back to Top