View Country

GET /countries/{id}
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/countries/{id}

Retrieves the details of a Country if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique id of the country


Example: AF
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ country ]
An array of all created items.
Country
Name
Description
codestring
Two-letter, uppercase country code.


Example: AF
code3string
Three-letter, uppercase country code.


Example: AFG
idstring
A unique identifier generated by the Ocamba platform.


Example: AF
namestring
Country name.


Example: Afghanistan
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the country id, list the countries to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 1,
    "items": [
        {
            "id": "AF",
            "code": "AF",
            "code3": "AFG",
            "name": "Afghanistan"
        }
    ]
}

{
  "total": 1,
  "items": [
    {
      "id": "AF",
      "code": "AF",
      "code3": "AFG",
      "name": "Afghanistan"
    }
  ]
}