Dataset: Referrals Log

Dataset name: ds_referrals_log

Description

A record of all referrals made on behalf of the member (citizen) to service providers by other servi

Fields in this dataset

Name Field Name Description Field Type Field Example
Action action varchar
End Time end_time int
Referrals Log ID id The primary identifier for this record. serial
Referrals Log Instance instance The instance this item relates to. int
Responsible User ID responsible_user_id The status of the service order. int
Service Order ID service_order_id Link to the service order int
Referrals Log Source source The source of the data - user or connection. varchar
Start Time start_time int
Referral Status status The status of the service order. int
User ID user_id Link to the user who changed the order status. int

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_referrals_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,
    "action": null,
    "end_time": null,
    "responsible_user_id": null,
    "service_order_id": null,
    "start_time": null,
    "status": null,
    "user_id": null
  }
}