Dataset: Journeys

Dataset name: ds_journeys

Description

Journey data

Fields in this dataset

Name Field Name Description Field Type Field Example
Journey ID id The primary identifier for this record. number 5
Journey Instance instance The instance this transaction relates to. number 8
Transactions Date journey_date Date of the journey date
Transactions Derstination journey_destination Journey destination text
Transactions End Time journey_end_time Journey end time time
Transactions Origin journey_origin Origin of journey text
Transactions Start Time journey_start_time Journey start time time
Transactions Transaction Value journey_transaction_value Journey transaction value number
Journey 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_journeys
  &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",
    "journey_date": null,
    "journey_destination": null,
    "journey_end_time": null,
    "journey_origin": null,
    "journey_start_time": null,
    "journey_transaction_value": null
  }
}