/membervariablevalues – Alida Help Center

Resource URL

/v1/applications/{communityApiKeyName}/membervariablevalues

Note:

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 collection of Member Variable Values.
POST	Create a new Member Variable Value.

Parameters

Parameters can be appended to the request to further refine the results returned.

Operation	Description	Example
Refine the response by field	To reduce the number of fields returned, specify the fields in a comma separated list.	`/membervariablevalues?fields=values`
Filtering by value	By default, all the items are returned unless you specify your criteria using the variable name and value. You can filter the response on the values in all of the available fields except for: `constraints` `links` `description` `id`	`/membervariablevalues?value=PoorResponder`
Paging	By default, 20 items are returned at a time and the maximum is 1000.	Use the `limit` and `offset` query string parameters to effectively page through the results.
Sorting	You can sort the results on all of the available fields except for: `constraints` `href` `id` `sequenceId`	`/membervariablevalues?sort=value:d`

For more information, see Content control.

Field Descriptions

Field	Description
`constraints`	Specifies a set of behaviors that the system will implement for a given Member Variable Value. Possible values are: `disabled: true\|false` `hidden: true\|false`
`createDate`	The date and timestamp the member value was created.
`createdBy`	GUID of the user who created the value.
`description`	A text description of the Member Variable Value where a richer description is necessary.
`href`	The link to the member variable value.
`id`	The system generated GUID of the Member Variable Value.
`key`	The lower-cased, text representation of the value.
`lastUpdateDate`	Date and timestamp (UTC) of when the value was last modified.
`lastUpdatedBy`	GUID of the user who last updated the value.
`links`	This field will always be empty.
`memberVariableId`	GUID of the Member Variable that this Member Variable Value belongs to.
`order`	An integer value that can be used to set and control explicit ordering of Member Variable Values.
`sequenceId`	The system generated integer identifier for the Member Variable Value which is provided as an alternative to the GUID identifier.
`value`	The case-preserved value. The value's type will depend on the datatype of the Member Variable that this Member Variable Value belongs to.

Response Format


{
  "meta": {
    "offset": 0,
    "limit": 1,
    "count": 271
  },
  "items": [
    {
      "id": <GUID of this member variable value>,
      "memberVariableId": <GUID of member variable>,
      "sequenceId": <integer>,
      "key": <lower-cased string value>,
      "description": <member variable value description>,
      "order": <integer>,
      "value": <case-preserved value>,
      "constraints": {
        "disabled": <true|false>,
        "hidden": <true|false>
      },
      "createDate": <date-time UTC>,
      "lastUpdateDate": <date-time UTC>,
      "createdBy": <GUID of user>,
      "lastUpdatedBy": <GUID of user>,
      "links": [],
      "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervariablevalues/{membervariablevaluesID}"
    }
  ],
  "links": [
    {
      "rel": "first",
      "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervariablevalues?limit=1&offset=0"
    },
    {
      "rel": "prev"
    },
    {
      "rel": "last",
      "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervariablevalues?limit=1&offset=270"
    },
    {
      "rel": "next",
      "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervariablevalues?limit=1&offset=1"
    }
  ],
  "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/membervariablevalues?limit=1"
}

POST Behavior

The /membervariablevalues resource can be created by sending a POST request either for a single item or a collection to /membervariablevalues.

The following table indicates which properties must be included in a POST request, as well as the default values that will be set when not included.

Property	Required On POST?	Default
`membervariableid`	Yes	User input required
`key`	Yes	User input required (same as `value`)
`description`	No	Empty string
`order`	No	`-1`
`value`	Yes	User input required (same as `key`)
`constraints`	No	`false` for all

Note: When sending a POST request to create a new Member Variable Value we strongly recommend passing the same value for both key and value. While the service has the ability to store these differently, different values can have an unintended impact and should be avoided.

Example: POST /membervariablevalues


[
   {
      "memberVariableId": <GUID of member variable>,
      "key": "London",
      "value": "London"
   },
   {
      "memberVariableId": <GUID of member variable>,
      "key": "Paris",
      "value": "Paris"
   }
]