Dataset: Driving Licence

Dataset name: ds_driving_licence

Description

Data relating to a members driving licence

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Date Of Birth	field_dl_dob	The members date of birth	date	29222
Expiry Alert	field_dl_expiry_alert		date
Groups	field_dl_groups		field_collection_table
Category	field_dl_groups_category		text
Date From	field_dl_group_date_from		date
Date To	field_dl_group_date_to		date
Issue Country	field_dl_issue_country		text	United Kingdom
Issuing Authority	field_dl_issuing_authority	The authority that issued the members driving licence	text	DVLA
Licence Number	field_dl_licence_number	The members driving licence number	text	888  8888 888
Other Names	field_dl_other_names	The member's surname	text	Jones
Place Of Birth	field_dl_pob	The Country in which the member was born	text	England
Surname	field_dl_surname	The members surname	text	Jones
Valid From	field_dl_valid_from	The date from which the members driving dicence is Valid	date	29222
Valid To	field_dl_valid_to	The expiry date of the members driving licence	date	29222

---

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_driving_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_dl_dob": "29222",
    "field_dl_expiry_alert": null,
    "field_dl_groups": null,
    "field_dl_groups_category": null,
    "field_dl_group_date_from": null,
    "field_dl_group_date_to": null,
    "field_dl_issue_country": "United Kingdom",
    "field_dl_issuing_authority": "DVLA",
    "field_dl_licence_number": "888  8888 888",
    "field_dl_other_names": "Jones",
    "field_dl_pob": "England",
    "field_dl_surname": "Jones",
    "field_dl_valid_from": "29222",
    "field_dl_valid_to": "29222"
  }
}