Dataset: Journal

Dataset name: ds_journal

Description

Journal

Fields in this dataset

Name Field Name Description Field Type Field Example
Created Timestamp created_timestamp Created Timestamp. int
Device Id device_id The device did the message originate from. varchar
Journal ID id The primary identifier for this record. serial
Journal Instance instance The instance this item relates to. int
Journal By journal_by The individual member or organisation member that created the journal. text
Journal Time Received journal_time_received The Unix timestamp that the journal was received. int
Journal Time Sent journal_time_sent The Unix timestamp that the journal was sent. int
Journal To journal_to The person/organisation they are replying to if this is a reply. text
Service Id service_id Which account or service did the message come from. text
Service Name service_name The unique name of the member on the service e.g Twitter handle. text
Journal Source source The source of the data - user or connection. varchar
Tags tags The tags associated with the journal (comma separated list). text
Title title The title of the journal. varchar
Type type The type of journal. varchar
Updated Timestamp updated_timestamp Updated Timestamp. int
Version Content version_content The content of previous versions. blob
Version Id version_id The id of the journal. int
Version Information version_information Meta data about the Revision, Version Number, Version Content, Version Change Description. 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_journal
  &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,
    "created_timestamp": null,
    "device_id": null,
    "journal_by": null,
    "journal_time_received": null,
    "journal_time_sent": null,
    "journal_to": null,
    "service_id": null,
    "service_name": null,
    "tags": null,
    "title": null,
    "type": null,
    "updated_timestamp": null,
    "version_content": null,
    "version_id": null,
    "version_information": null
  }
}