Dataset: Education

Dataset name: ds_education

Description

Data relating to a members education history

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Address Country	field_edu_country	The establishment country	text	England
Address County	field_edu_county	The establishment county	text	Essex
Courses	field_edu_courses		field_collection_embed
Date	field_edu_course_date	The date the member was awarded the qualification	date	29222
Level	field_edu_course_level	The level of the course	text	A Level
Mode Of Study	field_edu_course_mode_of_study	The mode of study for the course	text	Full Time
Name	field_edu_course_name	The name of the course the member undertook	text	Computer Science
Results Attained	field_edu_course_results	The grades awarded	text	Pass
Address DateFrom	field_edu_date_from	The date the member started at the establishment	date	29222
Address DateTo	field_edu_date_to	The date the member left the establishment	date	29222
Establishment Name	field_edu_establishment_name	The name of the establishment	text	Kings School
Address PostCode	field_edu_postcode	The establishment postcode	text	NB1 1AZ
Address Street	field_edu_street	The establishment street name and building name/ number	text	1 High Street
Address Telephone	field_edu_telephone	The establishment telephone number	text	(44) 01234 123456
Address Town	field_edu_town	The establishment town	text	Watford
Type	field_edu_type	The type of establishment	text	School
Address URL	field_edu_url	The establishment URL	text	www.name.com

---

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_education

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_edu_country": "England",
    "field_edu_county": "Essex",
    "field_edu_courses": null,
    "field_edu_course_date": "29222",
    "field_edu_course_level": "A Level",
    "field_edu_course_mode_of_study": "Full Time",
    "field_edu_course_name": "Computer Science",
    "field_edu_course_results": "Pass",
    "field_edu_date_from": "29222",
    "field_edu_date_to": "29222",
    "field_edu_establishment_name": "Kings School",
    "field_edu_postcode": "NB1 1AZ",
    "field_edu_street": "1 High Street",
    "field_edu_telephone": "(44) 01234 123456",
    "field_edu_town": "Watford",
    "field_edu_type": "School",
    "field_edu_url": "www.name.com"
  }
}