Dataset: Profiles
Dataset name:
ds_profiles
Description
Stores profiles that a member has created
Fields in this dataset
Name | Field Name | Description | Field Type | Field Example |
---|---|---|---|---|
Created Timestamp |
created_timestamp
|
Time of created profile | int | 1641909333 |
Profile Content |
profile_content
|
The content of the profile including the description and tags | BLOB | {"description":"This profile is for showing interest in Community Services and engagement","tags":["G41","Museums","Theatre","Music","Pop Culture"]} |
Profile ID |
profile_id
|
The unique id of a profile | int | 34 |
Profile Name |
profile_name
|
The name of the profile created by the user | text | Community Services |
Profile Shared With |
profile_shared_with
|
Where the profile has been shared to | BLOB | Inclued Citizen |
Profile Source |
profile_source
|
From where the profile was created | text | inclued-citizen |
Updated Timestamp |
updated_timestamp
|
Time of last edit to profile | int | 1641909333 |
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_profiles &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.
{ "null": { "id": "null", "ds_id": "null", "created_timestamp": "1641909333", "profile_content": "{\"description\":\"This profile is for showing interest in Community Services and engagement\",\"tags\":[\"G41\",\"Museums\",\"Theatre\",\"Music\",\"Pop Culture\"]}", "profile_id": "34", "profile_name": "Community Services", "profile_shared_with": "Inclued Citizen", "profile_source": "inclued-citizen", "updated_timestamp": "1641909333" } }