Dataset: Device App Settings

Dataset name: ds_device_app_settings

Description

Table for storing device app setting variables.

Fields in this dataset

Name Field Name Description Field Type Field Example
App Name app_setting_app_name The name of the app. varchar
Device Name app_setting_device_name The name of the Device. varchar
Setting Name app_setting_name The name of the variable. varchar
Setting Type app_setting_type The type of setting. Value, Boolean (yes/no, on/off), Range (0 100 45). varchar
Setting Value app_setting_value The value/status of the variable. varchar
Device App Settings ID id The primary identifier for a device record. serial
Device App Settings Instance instance Instance - only because the API expects an instance. int
Device App Settings Source source The source of the data - user or connection. 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_device_app_settings
  &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.

{
  "": {
    "id": null,
    "ds_id": null,
    "app_setting_app_name": null,
    "app_setting_device_name": null,
    "app_setting_name": null,
    "app_setting_type": null,
    "app_setting_value": null
  }
}