Dataset: Assurance Log

Dataset name: ds_assurance_log

Description

Logs all assurance records.

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Date Created	assurance_created	The timestamp of the created Assurance record.	int
Data Used	assurance_data_used	The actual data used to gain the assurance level.	varchar
IDP	assurance_idp	The IDP of the assurance record.	varchar
Assurance Level	assurance_level	The level of assurance.	int
Matching Datasets	assurance_matching_datasets	The matching datasets used for the assurance level.	varchar
PID	assurance_pid	The PID of the record (GOV.UK Assurance).	varchar
Assurance Log ID	id	The primary identifier for Assurance record.	serial
Assurance Log Instance	instance	The instance this transaction relates to.	int
Assurance Log Source	source	The source of the data - user or connection.	varchar

---

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/transaction/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_assurance_log
  &instance=N

Replace the following with your own details: UID KEY, API_KEY, CON_ID and instance N.

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.

{
  "": {
    "id": null,
    "ds_id": null,
    "assurance_created": null,
    "assurance_data_used": null,
    "assurance_idp": null,
    "assurance_level": null,
    "assurance_matching_datasets": null,
    "assurance_pid": null
  }
}