Dataset: Passport

Dataset name: ds_passport

Description

Data relating to a members passport details

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Code	field_pp_code		text
Date Of Expiry	field_pp_date_expiry	The expiry date of the members passport	date	29222
Date Of Issue	field_pp_date_issue	The date from which the members passport is Valid	date	29222
Date Of Birth	field_pp_dob	The members date of birth	date	29222
Expiry Alert	field_pp_expiry_alert		date
Given Names	field_pp_given_names	The member's first name	text	Catherine
Issuing Authority	field_pp_issuing_authority	The authority that issued the members passport	text	UKBA
Nationality	field_pp_nationality	The members nationality	text	British
Number	field_pp_number	The members passport number	text	123456789
Place Of Birth	field_pp_place_of_birth	The city in which the member was born	text	Manchester
Sex	field_pp_sex	The gender of the member	text	Female
Surname	field_pp_surname	The members surname	text	Jones
Type	field_pp_type		text

---

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_passport

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_pp_code": null,
    "field_pp_date_expiry": "29222",
    "field_pp_date_issue": "29222",
    "field_pp_dob": "29222",
    "field_pp_expiry_alert": null,
    "field_pp_given_names": "Catherine",
    "field_pp_issuing_authority": "UKBA",
    "field_pp_nationality": "British",
    "field_pp_number": "123456789",
    "field_pp_place_of_birth": "Manchester",
    "field_pp_sex": "Female",
    "field_pp_surname": "Jones",
    "field_pp_type": null
  }
}