Dataset: Loyalty Scheme

Dataset name: ds_loyalty_scheme

Description

Loyalty scheme data

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Loyalty Scheme ID	id	The primary identifier for this record.	number	5
Loyalty Scheme Instance	instance	The instance this transaction relates to.	number	8
Transactions Date	ls_date	Date of the transaction	date
Transactions Description	ls_description	Description of the transaction	text	Sainsbury's - Horsham
Transactions Monetary Value	ls_monetary_value	Monetary velaue of the transaction	currency
Transactions Currency Code	ls_monetary_value_currency_code	Currency code for the transaction	text	GBP
Transactions Points Value	ls_points_value	Points value for the transaction	number
Loyalty Scheme Source	source	The source of the data - user or connection.	text

---

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_loyalty_scheme
  &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.

{
  "5": {
    "id": "5",
    "ds_id": "5",
    "ls_date": null,
    "ls_description": "Sainsbury's - Horsham",
    "ls_monetary_value": null,
    "ls_monetary_value_currency_code": "GBP",
    "ls_points_value": null
  }
}