YM REST Services

TopContributors

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin, member, oauthmember

The following routes are available for this service:
GET	/Ams/{ClientID}/Member/{MemberID}/TopContributors	Return a list of TopContributors for the Member.
GET	/Ams/{ClientID}/TopContributors	Return a list of TopContributors for the Admin.

**TopContributors** Parameters:
Name	Parameter	Data Type	Required
DateBegin	query	DateTime	No
DateEnd	query	DateTime	No
PageNumber	query	int	No
PageSize	query	int	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**TopContributorsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CurrentContributor	form	TopContributor	No
ContributorList	form	List<TopContributor>	No

**TopContributor** Parameters:
Name	Parameter	Data Type	Required
RankNumber	form	int	No
RankPercentage	form	int	No
RankBaseline	form	int	No
Score	form	int	No
PostCount	form	int	No
CommentCount	form	int	No
LikeCount	form	int	No
LevelId	form	int	No
LevelName	form	string	No
DisplayOptions	form	DisplayOptions	No

**Connection** Parameters:
Name	Parameter	Data Type	Required
ConnectionStatus	form	ConnectionStatus?	No
ConnectionId	form	int	No
FirstName	form	string	No
LastName	form	string	No
ConnectionName	form	string	No
Organization	form	string	No
HeadShotImage	form	string	No
WorkTitle	form	string	No
MemberType	form	string	No
City	form	string	No
State	form	string	No
Location	form	string	No
Country	form	string	No
Shared	form	bool	No
Email	form	string	No
PhoneLabel	form	string	No
PhoneAreaCode	form	string	No
PhoneNumber	form	string	No
FaxLabel	form	string	No
FaxAreaCode	form	string	No
FaxNumber	form	string	No
CanShow	form	ShowPreferences	No
intCategoryID	form	int	No
IsAmbassador	form	bool	No

**ShowPreferences** Parameters:
Name	Parameter	Data Type	Required
City	form	bool	No
Location	form	bool	No
Country	form	bool	No
Phone	form	bool	No
Fax	form	bool	No
Email	form	bool	No
EmployerName	form	bool	No
EmployerTitle	form	bool	No

**DisplayOptions** Parameters:
Name	Parameter	Data Type	Required
ShowOnlineNow	form	bool	No
ShowOrganization	form	bool	No
ShowMessageButton	form	bool	No
ShowConnectButton	form	bool	No
ShowIMUsername	form	bool	No
ShowNickName	form	bool	No
ShowMaidenName	form	bool	No
ShowBirthdayDate	form	bool	No
ShowMarriageStatus	form	bool	No
ShowWeddingDate	form	bool	No
ShowSpouse	form	bool	No
ShowPrimaryEmail	form	bool	No
ShowHomeAddress	form	bool	No
ShowHomeAddress2	form	bool	No
ShowHomeCity	form	bool	No
ShowHomeZip	form	bool	No
ShowHomePhone	form	bool	No
ShowHomeFax	form	bool	No
ShowWorkAddress	form	bool	No
ShowWorkAddress2	form	bool	No
ShowWorkCity	form	bool	No
ShowWorkZip	form	bool	No
ShowWorkPhone	form	bool	No
ShowWorkFax	form	bool	No
ShowEmployerName	form	bool	No
ShowEmployerTitle	form	bool	No
ShowEmployerLocation	form	bool	No
ShowEmployerOwnsBusiness	form	bool	No
ShowHomeCountry	form	bool	No
ShowHomeLocation	form	bool	No
ShowWorkCountry	form	bool	No
ShowResume	form	bool	No
ProfilePhoto	form	bool	No
ShowGameBadge	form	bool	No

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}/Member/{MemberID}/TopContributors HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TopContributorsResponse 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>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <DateBegin>0001-01-01T00:00:00</DateBegin>
  <DateEnd>0001-01-01T00:00:00</DateEnd>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <ContributorList>
    <TopContributor>
      <CanShow>
        <City>false</City>
        <Country>false</Country>
        <Email>false</Email>
        <EmployerName>false</EmployerName>
        <EmployerTitle>false</EmployerTitle>
        <Fax>false</Fax>
        <Location>false</Location>
        <Phone>false</Phone>
      </CanShow>
      <City>String</City>
      <ConnectionId>0</ConnectionId>
      <ConnectionName>String</ConnectionName>
      <ConnectionStatus>None</ConnectionStatus>
      <Country>String</Country>
      <Email>String</Email>
      <FaxAreaCode>String</FaxAreaCode>
      <FaxLabel>String</FaxLabel>
      <FaxNumber>String</FaxNumber>
      <FirstName>String</FirstName>
      <HeadShotImage>String</HeadShotImage>
      <IsAmbassador>false</IsAmbassador>
      <LastName>String</LastName>
      <Location>String</Location>
      <MemberType>String</MemberType>
      <Organization>String</Organization>
      <PhoneAreaCode>String</PhoneAreaCode>
      <PhoneLabel>String</PhoneLabel>
      <PhoneNumber>String</PhoneNumber>
      <Shared>false</Shared>
      <State>String</State>
      <WorkTitle>String</WorkTitle>
      <intCategoryID>0</intCategoryID>
      <CommentCount>0</CommentCount>
      <DisplayOptions>
        <ProfilePhoto>false</ProfilePhoto>
        <ShowBirthdayDate>false</ShowBirthdayDate>
        <ShowConnectButton>false</ShowConnectButton>
        <ShowEmployerLocation>false</ShowEmployerLocation>
        <ShowEmployerName>false</ShowEmployerName>
        <ShowEmployerOwnsBusiness>false</ShowEmployerOwnsBusiness>
        <ShowEmployerTitle>false</ShowEmployerTitle>
        <ShowGameBadge>false</ShowGameBadge>
        <ShowHomeAddress>false</ShowHomeAddress>
        <ShowHomeAddress2>false</ShowHomeAddress2>
        <ShowHomeCity>false</ShowHomeCity>
        <ShowHomeCountry>false</ShowHomeCountry>
        <ShowHomeFax>false</ShowHomeFax>
        <ShowHomeLocation>false</ShowHomeLocation>
        <ShowHomePhone>false</ShowHomePhone>
        <ShowHomeZip>false</ShowHomeZip>
        <ShowIMUsername>false</ShowIMUsername>
        <ShowMaidenName>false</ShowMaidenName>
        <ShowMarriageStatus>false</ShowMarriageStatus>
        <ShowMessageButton>false</ShowMessageButton>
        <ShowNickName>false</ShowNickName>
        <ShowOnlineNow>false</ShowOnlineNow>
        <ShowOrganization>false</ShowOrganization>
        <ShowPrimaryEmail>false</ShowPrimaryEmail>
        <ShowResume>false</ShowResume>
        <ShowSpouse>false</ShowSpouse>
        <ShowWeddingDate>false</ShowWeddingDate>
        <ShowWorkAddress>false</ShowWorkAddress>
        <ShowWorkAddress2>false</ShowWorkAddress2>
        <ShowWorkCity>false</ShowWorkCity>
        <ShowWorkCountry>false</ShowWorkCountry>
        <ShowWorkFax>false</ShowWorkFax>
        <ShowWorkPhone>false</ShowWorkPhone>
        <ShowWorkZip>false</ShowWorkZip>
      </DisplayOptions>
      <LevelId>0</LevelId>
      <LevelName>String</LevelName>
      <LikeCount>0</LikeCount>
      <PostCount>0</PostCount>
      <RankBaseline>0</RankBaseline>
      <RankNumber>0</RankNumber>
      <RankPercentage>0</RankPercentage>
      <Score>0</Score>
    </TopContributor>
  </ContributorList>
  <CurrentContributor>
    <CanShow>
      <City>false</City>
      <Country>false</Country>
      <Email>false</Email>
      <EmployerName>false</EmployerName>
      <EmployerTitle>false</EmployerTitle>
      <Fax>false</Fax>
      <Location>false</Location>
      <Phone>false</Phone>
    </CanShow>
    <City>String</City>
    <ConnectionId>0</ConnectionId>
    <ConnectionName>String</ConnectionName>
    <ConnectionStatus>None</ConnectionStatus>
    <Country>String</Country>
    <Email>String</Email>
    <FaxAreaCode>String</FaxAreaCode>
    <FaxLabel>String</FaxLabel>
    <FaxNumber>String</FaxNumber>
    <FirstName>String</FirstName>
    <HeadShotImage>String</HeadShotImage>
    <IsAmbassador>false</IsAmbassador>
    <LastName>String</LastName>
    <Location>String</Location>
    <MemberType>String</MemberType>
    <Organization>String</Organization>
    <PhoneAreaCode>String</PhoneAreaCode>
    <PhoneLabel>String</PhoneLabel>
    <PhoneNumber>String</PhoneNumber>
    <Shared>false</Shared>
    <State>String</State>
    <WorkTitle>String</WorkTitle>
    <intCategoryID>0</intCategoryID>
    <CommentCount>0</CommentCount>
    <DisplayOptions>
      <ProfilePhoto>false</ProfilePhoto>
      <ShowBirthdayDate>false</ShowBirthdayDate>
      <ShowConnectButton>false</ShowConnectButton>
      <ShowEmployerLocation>false</ShowEmployerLocation>
      <ShowEmployerName>false</ShowEmployerName>
      <ShowEmployerOwnsBusiness>false</ShowEmployerOwnsBusiness>
      <ShowEmployerTitle>false</ShowEmployerTitle>
      <ShowGameBadge>false</ShowGameBadge>
      <ShowHomeAddress>false</ShowHomeAddress>
      <ShowHomeAddress2>false</ShowHomeAddress2>
      <ShowHomeCity>false</ShowHomeCity>
      <ShowHomeCountry>false</ShowHomeCountry>
      <ShowHomeFax>false</ShowHomeFax>
      <ShowHomeLocation>false</ShowHomeLocation>
      <ShowHomePhone>false</ShowHomePhone>
      <ShowHomeZip>false</ShowHomeZip>
      <ShowIMUsername>false</ShowIMUsername>
      <ShowMaidenName>false</ShowMaidenName>
      <ShowMarriageStatus>false</ShowMarriageStatus>
      <ShowMessageButton>false</ShowMessageButton>
      <ShowNickName>false</ShowNickName>
      <ShowOnlineNow>false</ShowOnlineNow>
      <ShowOrganization>false</ShowOrganization>
      <ShowPrimaryEmail>false</ShowPrimaryEmail>
      <ShowResume>false</ShowResume>
      <ShowSpouse>false</ShowSpouse>
      <ShowWeddingDate>false</ShowWeddingDate>
      <ShowWorkAddress>false</ShowWorkAddress>
      <ShowWorkAddress2>false</ShowWorkAddress2>
      <ShowWorkCity>false</ShowWorkCity>
      <ShowWorkCountry>false</ShowWorkCountry>
      <ShowWorkFax>false</ShowWorkFax>
      <ShowWorkPhone>false</ShowWorkPhone>
      <ShowWorkZip>false</ShowWorkZip>
    </DisplayOptions>
    <LevelId>0</LevelId>
    <LevelName>String</LevelName>
    <LikeCount>0</LikeCount>
    <PostCount>0</PostCount>
    <RankBaseline>0</RankBaseline>
    <RankNumber>0</RankNumber>
    <RankPercentage>0</RankPercentage>
    <Score>0</Score>
  </CurrentContributor>
</TopContributorsResponse>