Dataset: National Insurance

Dataset name: ds_ni

Description

Data relating to a members National Insurance details

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Name	field_ni_name	The member's surname	text	Jones
Number	field_ni_number	A member's NI Number	text	XX XXXXX X

---

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_ni

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_ni_name": "Jones",
    "field_ni_number": "XX XXXXX X"
  }
}