YM REST Services

<back to all web services

MembersGroups

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/MembersGroupsMembers Groups lookup - with cache.Return members' groups.
MembersGroups Parameters:
NameParameterData TypeRequiredDescription
TimestampqueryDateTime?No
PageSizequeryintNo
PageNumberqueryintNo
OffSetqueryintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MembersGroupsResponse Parameters:
NameParameterData TypeRequiredDescription
MembersGroupsListformList<MembersGroupData>No
MembersGroupData Parameters:
NameParameterData TypeRequiredDescription
WebSiteMemberIDformintNo
GroupCodeformstringNo
GroupNameformstringNo
PrimaryGroupformboolNo
GroupIDformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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":"2024-05-03T08:23:16.9245126-04:00","ServerID":"WS-6-134-823","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-03T09:48:01.7451062-04:00","Device":"Desktop"}