/membervariablevalues/{id} – Alida Help Center

Resource URL

/v1/applications/{communityApiKeyName}/membervariablevalues/{id}

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 specific Member Variable Value.
PUT	Modify an existing Member Variable Value. The PUT body must contain the entire entity in the request.
PATCH	Modifies an existing Member Variable Value. Only the fields that are being modified should be sent to the resource. The PATCH syntax follows RFC 6902. Supported operations: `add` `remove` `replace`

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.

GET 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/4e7bbc70-06f4-4308-aa1e-a5e00183b67d"
    }
  ],
  "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"
}

PUT requests

The following table describes the properties you can use to modify a Member Variable Value.

Property	Description
`constraints`	Specifies a set of behaviors that the system will implement for a given Member Variable Value. For the most part, these need not be adjusted from their defaults. For each supported constraint in the collection, a boolean value is recorded. `disabled`: Not implemented. `hidden`: When set to `true`, the Member Variable Value will no longer be returned when sending a GET request to the `/membervariablevalues` resource. However, it will remain accessible by specifying an `id` using the `/membervariablevalues/{id}` resource.
`description`	A text description of the Member Variable Value where a richer description is necessary.
`id`	The GUID identifier for a Member Variable Value. This will be generated by the system upon creation and cannot be set or modified. Note: This field cannot be patched.
`key`	The lower-cased, text representation of the `value`. Tip: When patching the `key` field, patch the `value` field at the same time.
`memberVariableId`	Specifies the Member Variable that this Member Variable Value belongs to. Note: This field cannot be patched.
`order`	An integer value that can be used to set and control explicit ordering of Member Variable Values.
`sequenceId`	The integer identifier for the Member Variable Value which is provided as an alternative to the GUID identifier. It will be unique only for Member Variables (not globally). This is generated by the system upon creation and cannot be set nor modified. Note: This field cannot be patched.
`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.

Example: PUT /membervariablevalues/{id}


{
   "memberVariableId": <GUID of member variable>,
   "key": "New York City",
   "value": "New York City"
}

PATCH requests