Dataset: Voluntary

Dataset name: ds_voluntary

Description

Details of voluntary activities.

Fields in this dataset

Name Field Name Description Field Type Field Example
CRB CRB Number field_vol_crb_number The member's CRB number text
CRB Date of Expiry field_vol_date_of_expiry The expiration date of the CRB date
CRB Expiry Alert field_vol_expiry_alert The expiration alert date of the CRB date
Host Organisation field_vol_host_organisation The host organisation name text
ID Number field_vol_id_number The member's ID number text
Notes field_vol_notes Additional notes text
Contact Address Country field_vol_organisation_country The contact address country text
Contact Address County field_vol_organisation_county The contact address county text
Organisation Name field_vol_organisation_name The name of the organisation text
Contact Address Postcode field_vol_organisation_postcode The contact address postcode text
Contact Address Street field_vol_organisation_street The contact address street text
Contact Address Town field_vol_organisation_town The contact address town text
Place of Activity field_vol_place_of_activity The volunteering place of activity text
Volunteering Pathway field_vol_volunteering_pathway Volunteering pathway text
Volunteer Hours field_vol_volunteer_hours The member's volunteering hours text
Volunteer Role field_vol_volunteer_role The member's volunteer role 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_voluntary

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_vol_crb_number": null,
    "field_vol_date_of_expiry": null,
    "field_vol_expiry_alert": null,
    "field_vol_host_organisation": null,
    "field_vol_id_number": null,
    "field_vol_notes": null,
    "field_vol_organisation_country": null,
    "field_vol_organisation_county": null,
    "field_vol_organisation_name": null,
    "field_vol_organisation_postcode": null,
    "field_vol_organisation_street": null,
    "field_vol_organisation_town": null,
    "field_vol_place_of_activity": null,
    "field_vol_volunteering_pathway": null,
    "field_vol_volunteer_hours": null,
    "field_vol_volunteer_role": null
  }
}