YM REST Services

<back to all web services

GroupMembershipLogs

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/GroupMembershipLogsReturn a list of group membership log entries by Group IDCan be optionally filtered by timestamp. Will return a maximum of 1,000 results.
GroupMembershipLogs Parameters:
NameParameterData TypeRequiredDescription
GroupIDqueryintNo
StartDatequeryDateTime?No
ItemIDqueryint?No
PageSizequeryintNo
PageNumberqueryintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
GroupMembershipLogsResponse Parameters:
NameParameterData TypeRequiredDescription
GroupFullNameformstringNo
GroupNameformstringNo
GroupTypeformstringNo
ServerGmtBiasformdoubleNo
ServerTimeformDateTimeNo
ItemsformList<Item>No
Item Parameters:
NameParameterData TypeRequiredDescription
ItemIDformint?No
IDformstringNo
ProfileIDformintNo
NamePrefixformstringNo
FirstNameformstringNo
MiddleNameformstringNo
LastNameformstringNo
SuffixformstringNo
NicknameformstringNo
EmployerNameformstringNo
WorkTitleformstringNo
DateformDateTimeNo
DescriptionformstringNo

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}/GroupMembershipLogs HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"GroupFullName":"String","GroupName":"String","GroupType":"String","ServerGmtBias":0,"ServerTime":"0001-01-01T00:00:00.0000000","Items":[{"ItemID":0,"ID":"String","ProfileID":0,"NamePrefix":"String","FirstName":"String","MiddleName":"String","LastName":"String","Suffix":"String","Nickname":"String","EmployerName":"String","WorkTitle":"String","Date":"0001-01-01T00:00:00.0000000","Description":"String"}],"GroupID":0,"StartDate":"0001-01-01T00:00:00.0000000","ItemID":0,"PageSize":0,"PageNumber":0,"UsingRedis":true,"AppInitTime":"2024-05-03T01:24:04.8651967-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-03T03:07:46.4378582-04:00","Device":"Desktop"}