Locations

Contents

  1. Locations Get

Locations Get

Locations are structured as a tree

  1. countries
    • have no parent
    • subdivisions as children
  2. subdivisions
    • country or subdivisions as parent
    • subdivisions or cities as children
  3. cities
    • subdivisions as parent
    • no children
Request
Method GET
Target

https://console.connatix.com/api/locations/get/<id>

<id>: location identifier (optional)

When <id> is not supplied server responds with countries

Headers  content-type: application/json
cookie: ConnatixAuth=<connatix_auth_cookie_value>

 

Response
Status  HTTP Status Code
Headers  set-cookie: ConnatixAuth=<connatix_auth_cookie_value>
Body

JSON object with properties

items [object] Array of location objects
id number
name string
abbrev string
parentId number
hasSubdivisions boolean

 

EXAMPLES

Countries Get

curl -X GET 'https://console.connatix.com/api/locations/get' -H 'content-type: application/json' -H 'Cookie: ConnatixAuth=<cookie_value>'

  

HTTP/1.1 200 OK
{"Items": 
[{"ID":1,"Name":"Afghanistan","Abbrev":"AF","ParentID":null,"HasSubdivisions":false},
{"ID":1153,"Name":"Aland Islands","Abbrev":"AX","ParentID":null,"HasSubdivisions":false},
... }]
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.

Powered by Zendesk