Dataset: Variables

Dataset name: ds_variables

Description

Table for storing variables.

Fields in this dataset

Name Field Name Description Field Type Field Example
Variables ID id ID - So the API can return multiple variables at once. serial
Variables Instance instance Instance - only because the API expects an instance. int
Name var_name The name of the variable. varchar
Value var_value The value of the variable stored serialized in a blob. blob

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_variables
  &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,
    "var_name": null,
    "var_value": null
  }
}