View Region

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

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

path Parameters
Arrow
Name
Description
idstringrequired
Unique id of the region. Example id="2661876".


Example: id="2661876"
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[ region ]
An array of all created items.
Region
Name
Description
country_codestring
Country code.


Example: CH
full_namestring
Full name.


Example: Aargau, CH
idstring
A unique identifier generated by the Ocamba platform.


Example: 2661876
namestring
Region name.


Example: Aargau
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the region id, list the regions to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 1,
    "items": [
        {
          "id": "2661876",
          "name": "Aargau",
          "country_code": "CH",
          "full_name": "Aargau, CH"
        }
    ]
}

{
  "total": 1,
  "items": [
    {
      "id": "2661876",
      "name": "Aargau",
      "country_code": "CH",
      "full_name": "Aargau, CH"
    }
  ]
}