Returns a single Member Value based on the unique identifier for the item and exposes very detailed information about, and interaction with, member data.
Member Values record information on the assignment of a Member Variable Value for a Member Variable to a member as of a given effective date. However, the resource includes additional information about the referenced entities (e.g. the name of a Member Variable that is also referenced by ID). This additional information is included in order to make a Member Value more autonomously usable by a consumer.
Using a spreadsheet analogy, a Member Value is analogous to the contents of a particular cell at a particular point in time. However, it also includes information on the row (i.e. the member) as well as the column (i.e. the Member Variable) in order to make it easier to use the atomic pieces of information for consumption and filtering.
Resource URL
/v1/applications/{communityApiKeyName}/membervalues/{id}
Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see Shared responsibility.
Available Methods
| Method | Description |
|---|---|
| GET | Get a specific member value. |
Field Descriptions
| Field | Description |
|---|---|
communityId
|
This field is deprecated and will likely be removed from this resource. Please do not use. |
createDate
|
Date and timestamp (UTC) the Member Value was created. |
createdBy
|
GUID of the user who created the Member Value. |
effectiveDate
|
This field exposes the time-series aspect
of Member Value data. The date-time is formatted as UTC at which this Member
Value is effective.
The implication is that the said Member Value is valid from this time forward, unless another Member Value is recorded at a later point in time, in which case the newer Member Value would then take precedence. |
href
|
Link to the Member Value. |
id
|
GUID of the Member Value. |
lastUpdateDate
|
Date and timestamp (UTC) the Member Value was last updated. |
lastUpdatedBy
|
GUID of the user who last updated the Member Value. |
links
|
This field will always be empty. |
memberDataSetType
|
Live or
Test, distinguishing if this Member Value
represents test data or live data.
|
memberEmail
|
The current email address for the member to
whom this Member Value belongs.
Note:
memberEmail is modeled and stored as a
System Variable called email, but returned here for convenience given the
prominence of email as an external identifier for members.
|
memberId
|
The GUID of the member to whom this Member Value belongs. |
memberSequenceId
|
The integer ID of the member to whom this Member Value belongs. |
memberVariableId
|
The GUID of the Member Variable to which the assigned Member Variable Value belongs. |
memberVariableName
|
The name of the Member Variable to which the assigned Member Variable Value belongs. |
memberVariableSequenceId
|
The integer ID of the Member Variable to which the assigned Member Variable Value belongs. |
memberVariableType
|
The type of Member Variable to which the assigned Member Variable Value belongs. |
memberVariableValue
|
The value of the Member Variable Value being assigned. |
memberVariableValueId
|
The GUID of the Member Variable Value being assigned. |
memberVariableValueSequenceId
|
The integer ID of the Member Variable Value being assigned. |
GET response format
{
"id": <GUID of member value>,
"communityId": <DEPRECATED>,
"memberId": <GUID of member>,
"memberEmail": <current email address of member>,
"memberVariableId": <GUID of member variable>,
"memberVariableName": <name of member variable>,
"memberVariableType": <type of member variable>,
"memberVariableValueId": <GUID of member variable value>,
"memberVariableValue": <value of member variable value>,
"memberSequenceId": <integer ID of member>,
"memberVariableSequenceId": <integer ID member variable>,
"memberVariableValueSequenceId": <integer ID member variable value>,
"memberDataSetType": <Live|Test>,
"effectiveDate": <date-time (UTC) as of when this member value became effective>
"createDate": <date-time (UTC of create date)>,
"lastUpdateDate": <date-time UTC of last update>,
"createdBy": <GUID of user>,
"lastUpdatedBy": <GUID of user>,
"links": [],
"href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervalues/{membervaluesId}"
}