Dataset: Utility Account Details

Dataset name: ds_utility

Description

Data relating to a members utilities accounts

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Tariff	field_utility_tariff	Tariff or plan basis for consumption	text
Tel Number	field_utility_tel_number	The members telephone number	text	(44) 01234 123456
Account Name	field_utility_account_name	The members surname	text	Jones
Account Type	field_utility_account_type	The type of utility account held by the member	text	Pay as you go
Billing Address Country	field_utility_billing_country	The members home country	text	England
Billing Address County	field_utility_billing_county	The members home county	text	Essex
Billing Address PostCode	field_utility_billing_postcode	The members home postcode	text	NB1 1AZ
Billing Address Street	field_utility_billing_street	The member home house number and street name	text	1 High Street
Billing Address Town	field_utility_billing_town	The members home town	text	Watford
Contact Address Country	field_utility_contact_country	The utility company country	text	England
Contact Address County	field_utility_contact_county	The utility company county	text	Essex
Contact Address eMail	field_utility_contact_email	The utility company email address	text	name@utilityprovider.com
Contact Address Fax	field_utility_contact_fax	The utility company fax number	text	(44) 01234 123456
Contact Address Contact Name	field_utility_contact_name	The name of the contact at the utility company	text	Fred Bloggs
Contact Address PostCode	field_utility_contact_postcode	The utility company postcode	text	NB1 1AZ
Contact Address Street	field_utility_contact_street	The utility company street name and building name/ number	text	1 High Street
Contact Address Telephone	field_utility_contact_telephone	The utility company telephone number	text	(44) 01234 123456
Contact Address Town	field_utility_contact_town	The utility company town	text	Watford
Customer No	field_utility_customer_num	The members customer account number for the utility supply	text	12345678
Date From	field_utility_date_from	The date supply commenced	date	29222
Date To	field_utility_date_to	The date supply ceased	date	29222
Payment Method	field_utility_payment_method	The payment method used by the member	text	Direct Debit
Service	field_utility_service	The utility service supplied to the member	text	Gas
Supplied Address Country	field_utility_supplied_country	The members home country	text	England
Supplied Address County	field_utility_supplied_county	The members home county	text	Essex
Supplied Address PostCode	field_utility_supplied_postcode	The members home postcode	text	NB1 1AZ
Supplied Address Street	field_utility_supplied_street	The member supplied house number and street name	text	1 High Street
Supplied Address Town	field_utility_supplied_town	The members home town	text	Watford
Supplier Name	field_utility_supplier_name	The utility service supplier	text	British Gas

---

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/pds/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_utility

Replace the following with your own details: UID KEY, API_KEY and CON_ID.

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.

The connection's read/write permissions are listed for each field. All instances of an accessible dataset are indexed with instance_N notation from N=0.

{
  "1": {
    "id": "1",
    "field_utility_tariff": null,
    "field_utility_tel_number": "(44) 01234 123456",
    "field_utility_account_name": "Jones",
    "field_utility_account_type": "Pay as you go",
    "field_utility_billing_country": "England",
    "field_utility_billing_county": "Essex",
    "field_utility_billing_postcode": "NB1 1AZ",
    "field_utility_billing_street": "1 High Street",
    "field_utility_billing_town": "Watford",
    "field_utility_contact_country": "England",
    "field_utility_contact_county": "Essex",
    "field_utility_contact_email": "name@utilityprovider.com",
    "field_utility_contact_fax": "(44) 01234 123456",
    "field_utility_contact_name": "Fred Bloggs",
    "field_utility_contact_postcode": "NB1 1AZ",
    "field_utility_contact_street": "1 High Street",
    "field_utility_contact_telephone": "(44) 01234 123456",
    "field_utility_contact_town": "Watford",
    "field_utility_customer_num": "12345678",
    "field_utility_date_from": "29222",
    "field_utility_date_to": "29222",
    "field_utility_payment_method": "Direct Debit",
    "field_utility_service": "Gas",
    "field_utility_supplied_country": "England",
    "field_utility_supplied_county": "Essex",
    "field_utility_supplied_postcode": "NB1 1AZ",
    "field_utility_supplied_street": "1 High Street",
    "field_utility_supplied_town": "Watford",
    "field_utility_supplier_name": "British Gas"
  }
}