Dataset: Invites

Dataset name: ds_invites

Description

Invites

Fields in this dataset

Name Field Name Description Field Type Field Example
Created Timestamp created_timestamp Created Timestamp. int
Expire Timestamp expire_timestamp Unix Timestamp of when the invite expires. int
Invites ID id The primary identifier for this record. serial
Identifier identifier Unique Identifier of what the invite is inviting the member to. varchar
Invites Instance instance The instance this item relates to. int
Known As known_as A label for the invite so that we know who we are inviting before we have a mydexid, and for good UX. varchar
Name name Name of invited member. varchar
One Time Code one_time_code One time code that is generated with the invite. varchar
Recipient recipient Either phone number or email address. varchar
Route route The route the invite used, either email, SMS or mydexId. varchar
Invites Source source The source of the data - user or connection. varchar
Status status The status of the invite. varchar
Type type The type of the invite. varchar
Updated Timestamp updated_timestamp Updated Timestamp. 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_invites
  &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,
    "expire_timestamp": null,
    "identifier": null,
    "known_as": null,
    "name": null,
    "one_time_code": null,
    "recipient": null,
    "route": null,
    "status": null,
    "type": null,
    "updated_timestamp": null
  }
}