The Person object is normally retrieved by users for themselves (or occasionally admins) with the Social - Person - Get API request.
Its main use is to get community identifiers (and also the user's "_id"), though users can always alternatively be identified by their email address, and communities can usually be identified by pattern matching on their titles (but not always, eg Config - Source - Save).
Code Block | ||||
---|---|---|---|---|
| ||||
{
// System parameters:
"_id": string, // String representation of MongoDB ObjectId
"created": string, // Java date format, time when user was created
"modified": string, // Java date format, time when account details were last changed
// Joint system/display parameters:
"accountStatus": string, // "active" or "suspended"
"email": string, // The user's primary email address, used both for display and for system communications
// Display parameters copied or derived from "register" API call
"firstName": string, // (from register/update)
"lastName": string, // (from register/update)
"displayName": string, // Generated as "firstName" + " " + "displayName"
"phone": string, // (from register/update)
// Community information:
"communities": [{
"_id": string, // String representation of MongoDB ObjectId, unique identified for the community
"name": string // The title of the community (as it was when the user joined; not updated if it is later changed by the owner)
}],
// CMS parameters copied from "register" API call
"WPUserID": string,
"SubscriptionID": string,
"SubscriptionTypeID": string,
"SubscriptionStartDate": string, // Java date format
"SubscriptionEndDate": string, // Java date format
// Display parameters that currently must be populated by hand in the DB
"organization": string,
"title": string,
"location": string,
"languages": [ string ],
"biography": string,
"avatar": string, // (intended to be a URL pointing to a JPG or PNG)
"contacts": [{
"type": string, // (eg mobile, home, office, fax)
"value": string
}],
"links": [{
"title": string,
"url": string
}],
"tags": [ string ]
} |