Requires any of the roles: | admin, oauthadmin |
GET | /Ams/{ClientID}/MembersGroups | Members Groups lookup - with cache. | Return members' groups. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Timestamp | query | DateTime? | No | |
PageSize | query | int | No | |
PageNumber | query | int | No | |
OffSet | 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 |
---|---|---|---|---|
MembersGroupsList | form | List<MembersGroupData> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
WebSiteMemberID | form | int | No | |
GroupCode | form | string | No | |
GroupName | form | string | No | |
PrimaryGroup | form | bool | No | |
GroupID | form | 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}/MembersGroups HTTP/1.1 Host: ws.yourmembership.com Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"MembersGroupsList":[{"WebSiteMemberID":0,"GroupCode":"String","GroupName":"String","PrimaryGroup":false,"GroupID":0}],"Timestamp":"0001-01-01T00:00:00.0000000","PageSize":0,"PageNumber":0,"OffSet":0,"UsingRedis":true,"AppInitTime":"2025-01-15T07:45:29.5231982-05:00","ServerID":"WS-4-27-804","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":"2025-01-15T09:07:03.7008814-05:00","Device":"Desktop"}