Dataset: Device Record

Dataset name: ds_device_record

Description

Records of devices.

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Building ID	building_id	Building ID.	int	1
IMEI	device_imei	The IMEI of the device.	varchar	186122708298561
MAC Address	device_mac_address	The MAC Address of the device.	varchar	01-23-45-67-89-AB
Model Number	device_model_number	The model number of the device.	varchar	123AM45678
Name	device_name	Device Name.	varchar	Tablet-John
Phone Number	device_phone_number	The phone number of the device.	varchar	07123456789
Serial Number	device_serial_number	The serial number of the device.	varchar	AB123456BC7
Software Version Number	device_software_version_number	The software version number the device is running.	varchar	10.1
Type	device_type	Device Type.	varchar	Tablet
External ID	external_id	External ID.	int	1
Device Record ID	id	The primary identifier for a device record.	serial	1
Device Record Instance	instance	The instance this device record relates to.	int	2
Memo	memo	Memo	varchar	Description of the device
Device Record Source	source	The source of the data - user or connection (uid or con_id).	varchar
Status	status	Status	int	1
User ID	user_id	User ID.	int	1

---

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_device_record
  &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",
    "building_id": "1",
    "device_imei": "186122708298561",
    "device_mac_address": "01-23-45-67-89-AB",
    "device_model_number": "123AM45678",
    "device_name": "Tablet-John",
    "device_phone_number": "07123456789",
    "device_serial_number": "AB123456BC7",
    "device_software_version_number": "10.1",
    "device_type": "Tablet",
    "external_id": "1",
    "memo": "Description of the device",
    "status": "1",
    "user_id": "1"
  }
}