Dataset: Utility Data Usage

Dataset name: ds_utility_data_usage

Description

Data usage

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Data Usage ID	id	The primary identifier for this record.	number	5
Data Usage Instance	instance	The instance this transaction relates to.	number	8
Data Usage Source	source	The source of the data - user or connection.	text
Data Transactions Charge Type	utility_data_usage_charge_type	The charge type	text	Included
Data Transactions Cost	utility_data_usage_cost	The cost	currency	12.45
Currency Code	utility_data_usage_currency_code	Currency code for the transaction	text	GBP
Data Transactions Data Used	utility_data_usage_data_used	Amonut of data used	number	2MB
Data Transactions Date	utility_data_usage_date	The date of the transaction	date	41254

---

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_utility_data_usage
  &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.

{
  "5": {
    "id": "5",
    "ds_id": "5",
    "utility_data_usage_charge_type": "Included",
    "utility_data_usage_cost": "12.45",
    "utility_data_usage_currency_code": "GBP",
    "utility_data_usage_data_used": "2MB",
    "utility_data_usage_date": "41254"
  }
}