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 | Messaging app |
Device Name |
app_setting_device_name
|
The name of the Device. | varchar | Tablet |
Setting Name |
app_setting_name
|
The name of the variable. | varchar | Switched on |
Setting Type |
app_setting_type
|
The type of setting. Value, Boolean (yes/no, on/off), Range (0 100 45). | varchar | yes/no |
Setting Value |
app_setting_value
|
The value/status of the variable. | varchar | yes |
Device App Settings ID |
id
|
The primary identifier for a device record. | serial | 1 |
Device App Settings Instance |
instance
|
Instance - only because the API expects an instance. | int | 4 |
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.
{ "1": { "id": "1", "ds_id": "1", "app_setting_app_name": "Messaging app", "app_setting_device_name": "Tablet", "app_setting_name": "Switched on", "app_setting_type": "yes/no", "app_setting_value": "yes" } }