Dataset: Local Authority

Dataset name: ds_local_authority

Description

Data relating to a members Local Authority

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Authority Name	field_la_authority_name	The name of the member's local authority	text	East Herts Council
Council Tax Band	field_la_council_tax_band	The Council Tax band	text	D
Council Address Country	field_la_country	The council country	text	England
Council Address County	field_la_county	The council county	text	Essex
Date From	field_la_date_from	The date the member moved into the area	date	29222
Date To	field_la_date_to	The date the member left the area	date	29222
Council Address eMail	field_la_email	The council email address	text	name@council.gov
Council Address Fax	field_la_fax	The council fax number	text	(44) 01234 123456
Council Address PostCode	field_la_postcode	The council postcode	text	NB1 1AZ
Council Address Street	field_la_street	The council street name and building name/ number	text	1 High Street
Council Address Telephone	field_la_telephone	The council telephone number	text	(44) 01234 123456
Council Address Town	field_la_town	The council town	text	Watford
My Contact Details eMail	field_la_user_email	The members email address registered with the council	text	name@emailprovider.com
My Contact Details Mobile	field_la_user_mobile	The members telephone number	text	(44) 01234 123456
My Contact Details Telephone	field_la_user_telephone	The members telephone number	text	(44) 01234 123456

---

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_local_authority

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_la_authority_name": "East Herts Council",
    "field_la_council_tax_band": "D",
    "field_la_country": "England",
    "field_la_county": "Essex",
    "field_la_date_from": "29222",
    "field_la_date_to": "29222",
    "field_la_email": "name@council.gov",
    "field_la_fax": "(44) 01234 123456",
    "field_la_postcode": "NB1 1AZ",
    "field_la_street": "1 High Street",
    "field_la_telephone": "(44) 01234 123456",
    "field_la_town": "Watford",
    "field_la_user_email": "name@emailprovider.com",
    "field_la_user_mobile": "(44) 01234 123456",
    "field_la_user_telephone": "(44) 01234 123456"
  }
}