YM REST Services

<back to all web services

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

The following routes are available for this service:
POST	/Ams/{ClientID}/Member/{MemberID}/Shares	Share a post from the feed to a member's wall.
GET	/Ams/{ClientID}/Member/{MemberID}/Shares	Return a list of members who have shared a specific post.
GET	/Ams/{ClientID}/Shares	Return a list of members who have shared a specific post.

**Shares** Parameters:
Name	Parameter	Data Type	Required
PostId	body	int	No
PhotoId	body	int	No
PostText	body	string	No
PageNumber	body	int	No
PageSize	body	int	No
OffSet	body	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

**SharesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
NewPostId	form	int	No
MemberList	form	List<Share>	No

**Share** Parameters:
Name	Parameter	Data Type	Required
ShareId	form	int	No
PostId	form	int	No
PhotoId	form	int	No
DateShared	form	DateTime	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

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

<Shares 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>
  <OffSet>0</OffSet>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <PhotoId>0</PhotoId>
  <PostId>0</PostId>
  <PostText>String</PostText>
</Shares>

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

<SharesResponse 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>
  <OffSet>0</OffSet>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <PhotoId>0</PhotoId>
  <PostId>0</PostId>
  <PostText>String</PostText>
  <MemberList>
    <Share>
      <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>
      <DateShared>0001-01-01T00:00:00</DateShared>
      <PhotoId>0</PhotoId>
      <PostId>0</PostId>
      <ShareId>0</ShareId>
    </Share>
  </MemberList>
  <NewPostId>0</NewPostId>
</SharesResponse>