| Requires any of the roles: | admin, oauthadmin | Required permission: | CanAdminMembers |
| GET | /Ams/{ClientID}/FindMembers | Lookup People - with cache. | Any one or more part of a person's name can be sent in as a term. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| term | query | string | No | |
| limit | query | int | No | |
| IsAmbassadorSearch | query | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| membersFound | form | List<MemberFound> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| id | form | int | No | |
| label | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/FindMembers HTTP/1.1
Host: ws.yourmembership.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"membersFound":[{"id":0,"label":"String"}],"term":"String","limit":0,"IsAmbassadorSearch":false,"UsingRedis":true,"AppInitTime":"2024-05-03T07:20:07.3002820-04:00","ServerID":"WS-5-155-994","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T07:21:06.0935656-04:00","Device":"Desktop"}