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 | 1638375529 |
Transactions Destination |
journey_destination
|
Journey destination | text | Belfast |
Transactions End Time |
journey_end_time
|
Journey end time | time | 1638375529 |
Transactions Origin |
journey_origin
|
Origin of journey | text | Edinburgh |
Transactions Start Time |
journey_start_time
|
Journey start time | time | 1641989731 |
Transactions Transaction Value |
journey_transaction_value
|
Journey transaction value | number | 145.0 |
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": "1638375529", "journey_destination": "Belfast", "journey_end_time": "1638375529", "journey_origin": "Edinburgh", "journey_start_time": "1641989731", "journey_transaction_value": "145.0" } }