Dataset: Location Data

Dataset name: ds_location_data

Description

Location data from devices.

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Location Data ID	id	The primary identifier for a location data record.	serial	1
Location Data Instance	instance	The instance this location data record relates to.	int	3
Address Line 1	location_data_address1	The address line 1.	varchar	1 Example st
Address Line 2	location_data_address2	The address line 2.	varchar	18
App Name	location_data_app_name	The app name creating the location data record.	varchar	Google Maps
Country	location_data_country	The address country.	varchar	United Kingdom
County	location_data_county	The address county.	varchar	Lanarkshire
Device Name	location_data_device_name	The device name creating the location data record.	varchar	Tablet
Latitude	location_data_latitude	The latitude of the location.	numeric	55.8642
Longitude	location_data_longitude	The longitude of the location.	numeric	4.2518
Postcode	location_data_postcode	The address postcode.	varchar	AB1 2CD
Timestamp	location_data_timestamp	The timestamp the location data was created.	int	1638375529
Timezone	location_data_timezone	The timezone the location data was created.	varchar	Greenwich Mean Time
Town/City	location_data_towncity	The address town/city.	varchar	Glasgow
Location Data Source	source	The source of the data - user or connection (uid or con_id).	varchar

---

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/transaction/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_location_data
  &instance=N

Replace the following with your own details: UID KEY, API_KEY, CON_ID and instance N.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows.

{
  "1": {
    "id": "1",
    "ds_id": "1",
    "location_data_address1": "1 Example st",
    "location_data_address2": "18",
    "location_data_app_name": "Google Maps",
    "location_data_country": "United Kingdom",
    "location_data_county": "Lanarkshire",
    "location_data_device_name": "Tablet",
    "location_data_latitude": "55.8642",
    "location_data_longitude": "4.2518",
    "location_data_postcode": "AB1 2CD",
    "location_data_timestamp": "1638375529",
    "location_data_timezone": "Greenwich Mean Time",
    "location_data_towncity": "Glasgow"
  }
}