YM REST Services

MemberGroups

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

The following routes are available for this service:
POST	/Ams/{ClientID}/MemberGroups	Create relationships between the supplied Member ID and Group Code.	There are three types of relationships that may be created for a group: Member, Administrator and Representative. When adding a member to a group as a member, 'IsPrimaryGroup' should be specified. When adding a member to a group as a 'Representative', a Title should be specified in the 'AddGroupRepTitle' argument. If the title does not exist, it will be created automatically.
PUT	/Ams/{ClientID}/MemberGroups	Remove relationships between the supplied Member ID and Group Code.	There are three types of relationships that may be removed for a group: Member, Administrator and Representative. When removing a member from a group as a 'Representative', a 'Title' should be specified.
GET	/Ams/{ClientID}/Member/{MemberID}/Groups	Return a list of groups for a member.

**MemberGroups** Parameters:
Name	Parameter	Data Type	Required	Description
PageNumber	body	int	No
PageSize	body	int	No
OffSet	body	int	No
Status	body	Status	No	Allowable Values None Joined Pending NotJoined JoinedOrPending
GroupTypeId	body	int	No
SearchTerm	body	string	No
AddAsMember	body	bool?	No
IsPrimaryGroup	body	bool?	No
AddAsGroupAdmin	body	bool?	No
AddGroupRepTitle	body	string	No
RemoveAsMember	body	bool?	No
RemoveAsGroupAdmin	body	bool?	No
RemoveGroupRepTitle	body	string	No
ID	body	int?	No
GroupCode	body	string	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

**MemberGroupsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
GroupTypeList	form	List<GroupType>	No

**GroupType** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TypeName	form	string	No
SortIndex	form	double?	No
Groups	form	List<Group>	No

**Group** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Status	form	Status?	No
JoinOption	form	JoinOption?	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.

POST /Ams/{ClientID}/MemberGroups HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MemberGroups 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>
  <AddAsGroupAdmin>false</AddAsGroupAdmin>
  <AddAsMember>false</AddAsMember>
  <AddGroupRepTitle>String</AddGroupRepTitle>
  <GroupCode>String</GroupCode>
  <GroupTypeId>0</GroupTypeId>
  <ID>0</ID>
  <IsPrimaryGroup>false</IsPrimaryGroup>
  <OffSet>0</OffSet>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <RemoveAsGroupAdmin>false</RemoveAsGroupAdmin>
  <RemoveAsMember>false</RemoveAsMember>
  <RemoveGroupRepTitle>String</RemoveGroupRepTitle>
  <SearchTerm>String</SearchTerm>
  <Status>None</Status>
</MemberGroups>

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

<MemberGroupsResponse 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>
  <AddAsGroupAdmin>false</AddAsGroupAdmin>
  <AddAsMember>false</AddAsMember>
  <AddGroupRepTitle>String</AddGroupRepTitle>
  <GroupCode>String</GroupCode>
  <GroupTypeId>0</GroupTypeId>
  <ID>0</ID>
  <IsPrimaryGroup>false</IsPrimaryGroup>
  <OffSet>0</OffSet>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <RemoveAsGroupAdmin>false</RemoveAsGroupAdmin>
  <RemoveAsMember>false</RemoveAsMember>
  <RemoveGroupRepTitle>String</RemoveGroupRepTitle>
  <SearchTerm>String</SearchTerm>
  <Status>None</Status>
  <GroupTypeList>
    <GroupType>
      <Groups>
        <Group>
          <Id>0</Id>
          <JoinOption>CanJoin</JoinOption>
          <Name>String</Name>
          <Status>None</Status>
        </Group>
      </Groups>
      <Id>0</Id>
      <SortIndex>0</SortIndex>
      <TypeName>String</TypeName>
    </GroupType>
  </GroupTypeList>
</MemberGroupsResponse>

YM REST Services

MemberGroups

Allowable Values

HTTP + XML