YM REST Services

Favorites

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

The following routes are available for this service:
GET	/Ams/{ClientID}/Member/{MemberID}/Favorites	Return a list of favorite URLs for a member.
POST	/Ams/{ClientID}/Member/{MemberID}/Favorites	Add a favorite URL to member profile.
PUT	/Ams/{ClientID}/Member/{MemberID}/Favorites/{Id}	Update an existing favorite URL for a member.
DELETE	/Ams/{ClientID}/Member/{MemberID}/Favorites/{Id}	Removes a favorite URL from member profile.

**Favorites** Parameters:
Name	Parameter	Data Type	Required
Category	body	string	No
PageNumber	body	int	No
PageSize	body	int	No

**Favorite** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TypeId	form	string	No
TypeName	form	string	No
Title	form	string	No
FavoriteParameters	form	string	No
IsPrivate	form	string	No
Url	form	string	No
Icon	form	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

**FavoritesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CategoryList	form	List<FavoriteCategory>	No

**FavoriteCategory** Parameters:
Name	Parameter	Data Type	Required	Description
Category	form	string	No
FavoriteItems	form	List<Favorite>	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}/Favorites HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Favorites 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>
  <FavoriteParameters>String</FavoriteParameters>
  <Icon>String</Icon>
  <Id>0</Id>
  <IsPrivate>String</IsPrivate>
  <Title>String</Title>
  <TypeId>String</TypeId>
  <TypeName>String</TypeName>
  <Url>String</Url>
  <Category>String</Category>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
</Favorites>

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

<FavoritesResponse 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>
  <FavoriteParameters>String</FavoriteParameters>
  <Icon>String</Icon>
  <Id>0</Id>
  <IsPrivate>String</IsPrivate>
  <Title>String</Title>
  <TypeId>String</TypeId>
  <TypeName>String</TypeName>
  <Url>String</Url>
  <Category>String</Category>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <CategoryList>
    <FavoriteCategory>
      <Category>String</Category>
      <FavoriteItems>
        <Favorite>
          <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:d6p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
            <d6p1:ErrorCode>String</d6p1:ErrorCode>
            <d6p1:Message>String</d6p1:Message>
            <d6p1:StackTrace>String</d6p1:StackTrace>
            <d6p1:Errors>
              <d6p1:ResponseError>
                <d6p1:ErrorCode>String</d6p1:ErrorCode>
                <d6p1:FieldName>String</d6p1:FieldName>
                <d6p1:Message>String</d6p1:Message>
                <d6p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:KeyValueOfstringstring>
                    <d9p1:Key>String</d9p1:Key>
                    <d9p1:Value>String</d9p1:Value>
                  </d9p1:KeyValueOfstringstring>
                </d6p1:Meta>
              </d6p1:ResponseError>
            </d6p1:Errors>
            <d6p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d6p1:Meta>
          </ResponseStatus>
          <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
          <FavoriteParameters>String</FavoriteParameters>
          <Icon>String</Icon>
          <Id>0</Id>
          <IsPrivate>String</IsPrivate>
          <Title>String</Title>
          <TypeId>String</TypeId>
          <TypeName>String</TypeName>
          <Url>String</Url>
        </Favorite>
      </FavoriteItems>
    </FavoriteCategory>
  </CategoryList>
</FavoritesResponse>