Dataset: Employer

Dataset name: ds_employment

Description

Details of each employer.

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Employee ID	field_emp_employee_id	The member's employee ID	text
Employer Name	field_emp_employer_name	The name of the member's employer	text
End Date	field_emp_end_date	The member's end date of employment	date
Job Title	field_emp_job_title	The member's job title	text
Salary	field_emp_salary	The member's salary	number
Start Date	field_emp_start_date	The member's start date of employment	date

---

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_employment

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_emp_employee_id": null,
    "field_emp_employer_name": null,
    "field_emp_end_date": null,
    "field_emp_job_title": null,
    "field_emp_salary": null,
    "field_emp_start_date": null
  }
}