/memberfilters – Alida Help Center

Prerequisite

Create a member group

Resource URL

/v1/applications/{communityApiKeyName}/memberfilters

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	Returns a list of member groups.

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. You can filter the response on the items that match your criteria except for `categories`.	`/memberfilters?fields=name,id`
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: `categories` `links`	`/memberfilters?name=Canada&fields=name,id` `/memberfilters?q=constraints["hidden"]=true` Tip: If the query string parameter `q` does not work, encode its value in the URL. For example: `q=constraints[%22hidden%22]=true`
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 response on the following fields: `description` `lastUpdateDate` `name` `sourceId`	`/memberfilters?sort=name:d`

For more information, see Content control.

Available fields

Item Description

categories

The string value for the member variable category. Possible values are:

system
memberGroup
healthReporting

condition

The filter criteria for the member group.

Tip: You can view the filter criteria in the application by clicking Member Groups in the left hand menu, and clicking the group name.

constraints

The constraints collection specifies a set of behaviors that the system will implement for a given Member Variable. For the most part, these need not be adjusted from their defaults. For each supported constraint in the collection, a boolean value is recorded.

Property	Description
`deleted`	Not implemented
`hidden`	When set to `true`, the Member Variable will no longer be returned when sending a GET request to the `/membervariables` resource. However, it will remain accessible by specifying an id using the `/membervariables/{id}` resource.

createDate The date-timestamp UTC the member group was created.

createdBy The GUID of the user who created the member group.

description The text description of the member filter.

id The GUID for the member group.

lastUpdateDate The date-timestamp (UTC) for when the member group was last updated.

lastUpdatedBy The GUID of the user who last updated the member group.

links

URLs that link to the:

/membercount: Returns the number of members in the group.
/memberids: Returns the member IDs of the members in the group.
/members: Returns the system and profile variable values for the members in the group.

name

The string name of the member group as it appears in the application.
The GUID for a system filter.

sourceId This is an internal field.

GET Response Structure


{
   "meta": {
      "offset": 0,
      "limit": 1,
      "count": 1
   },
   "items": [
      {
         "id": <GUID of member group>,
         "sourceId": "00000000-0000-0000-0000-000000000000",
         "name": <unique string name of member group>,
         "description": <string description of member group>,
         "categories": [
            <system|memberGroup|healthReporting>
         ],
         "constraints": {
            "hidden": <true|false>,
            "deleted": <true|false>
         },
         "condition": {
            "operation": <and|or>,
            "conditions": [
               {
                  "operation": <in|notIn>,
                  "memberVariableId": <GUID of member variable>,
                  "memberVariableValueIds": [
                     <array of member variable value GUIDs>
                  ]
               }
            ]
         },
         "createDate": <date-time UTC>,
         "lastUpdateDate": <date-time UTC>,
         "createdBy": <GUID of user>,
         "lastUpdatedBy": <GUID of user>,
         "links": [
            {
               "rel": "memberCount",
               "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/MemberFilters/{memberfiltrerId}/membercount"
            },
            {
               "rel": "memberIds",
               "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/MemberFilters/{memberfiltrerId}/memberids"
            },
            {
               "rel": "members",
               "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/memberfilters/{memberfiltrerId}/members"
            }
         ],
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/memberfilters/{memberfiltrerId}"
      }
   ],
   "links": [
      {
         "rel": "first",
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/memberfilters?offset=0&limit=20"
      },
      {
         "rel": "prev"
      },
      {
         "rel": "last",
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/memberfilters?offset=40&limit=20"
      },
      {
         "rel": "next",
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/memberfilters?offset=20&limit=20"
      }
   ],
   "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/memberfilters"
}