Dataset: Community Profile

Dataset name: ds_community_profile

Description

Details of a member's community profile.

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
About Me	field_cp_about_me
Community Roles	field_cp_community_roles
Community Membership Preferences	field_cp_com_membership_prefs
Display Name	field_cp_display_name
Website	field_cp_website

---

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/pds/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_community_profile

Replace the following with your own details: UID KEY, API_KEY and CON_ID.

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.

The connection's read/write permissions are listed for each field. All instances of an accessible dataset are indexed with instance_N notation from N=0.

{
  "1": {
    "id": "1",
    "field_cp_about_me": null,
    "field_cp_community_roles": null,
    "field_cp_com_membership_prefs": null,
    "field_cp_display_name": null,
    "field_cp_website": null
  }
}