Subscriber Location¶

This interface provides a set of functions to handle the subscriber location information, and is only required if the location_id is being returned by the subscriber_search and subscriber_detail interfaces.

We use this interface to maintain an up-to-date location map. This is also used to update locations if a user account provides a location_id that does not currently exist in our database.

Subscriber Location Parameters (HTTP GET)¶

The lookup is done using HTTP GET with the following parameters:

Element Name	Description
id	Unique id of the location
key	Key used for securing query pages. This is same key as used in search

Response JSON¶

The JSON response is an object with the following properties:

Property Name	Description
error	If there is an error this contains a short description of the problem retrieving the customer info. If there was no error this should be set to null
location	A location object. If there is no error set then this is used as the result for the given location_id

Location Object:

Element Name	Required	Description
id	yes	unique id of location, this is used to get the location ID in our database or update our map
status	yes	status of location which must be one of the following values ‘active’ or ‘disabled’
name	yes,	Name of the location

Example Response JSON¶

Example query URL:

http://www.example.com/subscriberlocation?id=54321

JSON Response Body:

{'error': null,
 'location': [{
   'id': 54321,
   'status': 'active',
   'name': 'Example Location Name'
 }]
}

Subscriber Location¶