Dataset: TV Licence

Dataset name: ds_tv_licence

Description

Television licence details.

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
County	field_tv_licence_county	The members home county	text	Essex
TV Licence Fee	field_tv_licence_fee	The TV licence fee	number
Licence Holder's Name	field_tv_licence_holders_name	The name of licence holder	text	Catherine Jones
TV Licence Number	field_tv_licence_number	The TV licence number	text
Payment Frequency	field_tv_licence_payment_freq	The TV licence payment frequency	text
Payment Method	field_tv_licence_payment_method	The TV licence payment method	text
Post Code	field_tv_licence_post_code	The members home postcode	text	NB1 1AZ
Street	field_tv_licence_street	The member home house number and street name	text	1 High Street
Town	field_tv_licence_town	The members home town	text	Watford
TV Licence Type	field_tv_licence_type	The TV licence type	text
Valid Until	field_tv_licence_valid_until	The expiration date of the TV licence	date

---

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_tv_licence

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_tv_licence_county": "Essex",
    "field_tv_licence_fee": null,
    "field_tv_licence_holders_name": "Catherine Jones",
    "field_tv_licence_number": null,
    "field_tv_licence_payment_freq": null,
    "field_tv_licence_payment_method": null,
    "field_tv_licence_post_code": "NB1 1AZ",
    "field_tv_licence_street": "1 High Street",
    "field_tv_licence_town": "Watford",
    "field_tv_licence_type": null,
    "field_tv_licence_valid_until": null
  }
}