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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GroupMembershipLogsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <GroupID>0</GroupID>
  <ItemID>0</ItemID>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <GroupFullName>String</GroupFullName>
  <GroupName>String</GroupName>
  <GroupType>String</GroupType>
  <Items>
    <Item>
      <Date>0001-01-01T00:00:00</Date>
      <Description>String</Description>
      <EmployerName>String</EmployerName>
      <FirstName>String</FirstName>
      <ID>String</ID>
      <ItemID>0</ItemID>
      <LastName>String</LastName>
      <MiddleName>String</MiddleName>
      <NamePrefix>String</NamePrefix>
      <Nickname>String</Nickname>
      <ProfileID>0</ProfileID>
      <Suffix>String</Suffix>
      <WorkTitle>String</WorkTitle>
    </Item>
  </Items>
  <ServerGmtBias>0</ServerGmtBias>
  <ServerTime>0001-01-01T00:00:00</ServerTime>
</GroupMembershipLogsResponse>