| Requires any of the roles: | admin, oauthadmin |
| GET | /Ams/{ClientID}/PeopleIDs | Returns a list of People/Member/Non-Member IDs, based on UserType. | May be optionally filtered by Timestamp, GroupCodes, or GroupNames. Required parameters are PageSize, PageNumber, and UserType. Provided for data synchronization purposes it would typically be used in conjunction with subsequent calls to /Ams/{ClientID}/People (GET) for each ID returned. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserType | query | UserTypeEnum? | No | Allowable Values
|
| Timestamp | query | DateTime? | No | |
| ProfileID | query | int | No | |
| GroupCodes | query | List<string> | No | |
| GroupNames | query | List<string> | No | |
| PageSize | query | int | No | |
| PageNumber | query | int | 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 |
|---|---|---|---|---|
| IDList | form | List<int> | 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}/PeopleIDs HTTP/1.1
Host: ws.yourmembership.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"IDList":[0],"UserType":"All","Timestamp":"0001-01-01T00:00:00.0000000","ProfileID":0,"GroupCodes":["String"],"GroupNames":["String"],"PageSize":0,"PageNumber":0,"UsingRedis":true,"AppInitTime":"2024-05-03T00:47:02.7459456-04:00","ServerID":"WS-4-7-585","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-03T02:31:23.8389685-04:00","Device":"Desktop"}