View City

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

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

path Parameters
Arrow
Name
Description
idintegerrequired
Unique id of the city
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[ city ]
An array of all created items.
City
Name
Description
country_codestring
Two-letter, uppercase country code which is city located.


Example: CA
full_namestring
Full name.


Example: 100 Mile House, British Columbia, CA
idstring
A unique identifier generated by the Ocamba platform.


Example: 5881639
namestring
City name.


Example: 100 Mile House
regionstring
The region name which is city located.


Example: British Columbia
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the city id, list the cities to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 1,
    "items": [
        {
          "id": "5881639",
          "name": "100 Mile House",
          "region": "British Columbia",
          "country_code": "CA",
          "full_name": "100 Mile House, British Columbia, CA"
        }
    ]
}

{
  "total": 1,
  "items": [
    {
      "id": "5881639",
      "country_code": "CA",
      "region": "British Columbia",
      "name": "100 Mile House",
      "full_name": "100 Mile House, British Columbia, CA"
    }
  ]
}