YM REST Services

Memberships

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin	Requires the permission:	CanAdminMembers

The following routes are available for this service:
GET	/Ams/{ClientID}/Memberships/	Return a list of memberships for a client.	With cache is GET.
GET	/Ams/{ClientID}/Memberships/{MemberTypeId}	Return a list of memberships for a client.	With cache is GET.

**Memberships** Parameters:
Name	Parameter	Data Type	Required	Description
MemberTypeId	path	int	No
ExpirationDate	query	DateTime	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	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

**MembershipsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
membershipList	form	List<Membership>	No

**Membership** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Code	form	string	No
Name	form	string	No
DuesAmount	form	double	No
ProRatedDues	form	bool	No
ProRateFactor	form	double	No
AllowMultipleOpenInvoices	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}/Memberships/ HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml

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

<MembershipsResponse 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>
  <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
  <MemberTypeId>0</MemberTypeId>
  <membershipList>
    <Membership>
      <AllowMultipleOpenInvoices>false</AllowMultipleOpenInvoices>
      <Code>String</Code>
      <DuesAmount>0</DuesAmount>
      <Id>0</Id>
      <Name>String</Name>
      <ProRateFactor>0</ProRateFactor>
      <ProRatedDues>false</ProRatedDues>
    </Membership>
  </membershipList>
</MembershipsResponse>