ASH.ResourceLibrary.WebApi

FavoritesRequest

The following routes are available for this service:
GET,POST	/favorites	Use to get a list Resource Items

**FavoritesRequest** Parameters:
Name	Parameter	Data Type	Required	Description
DigitalFitness	body	bool	No	Set it to true if requesting saved resources only from digital library
HealthLibrary	body	bool	No	Set it to true if requesting saved resources only from health library
Vptr	body	bool	No	Set it to true if requesting saved resources only from vptr
Wellbeing	body	bool	No	Set it to true if requesting saved resources only from wellbeing
Health	body	bool	No	Set it to true if requesting saved resources only from health
Limit	body	string	No
Offset	body	string	No

**BasicResourceLibraryRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ResourceLibraryMemberId	form	int	No

**ResourceItemsLiteResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResourceItems	form	List<ResourceCard>	No
Meta	form	Meta	No

**ResourceCard** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Title	form	string	No
Description	form	string	No
DescriptionSummary	form	string	No
Type	form	string	No
Content	form	string	No
IsComplete	form	bool	No
IsFavorite	form	bool	No
IsImplicitlyComplete	form	bool	No
MediaPath	form	string	No
IsConfirmable	form	bool	No
IsWcagCompliant	form	bool	No
Duration	form	string	No
Preview	form	string	No
Calories	form	int	No
Instructor	form	string	No
Thumbnail	form	string	No
Difficulty	form	string	No
Tags	form	List<Tag>	No
Subtitles	form	string	No
Screenshots	form	List<ScreenshotItem>	No
DrmEncrypted	form	bool	No

**Tag** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Title	form	string	No

**ScreenshotItem** Parameters:
Name	Parameter	Data Type	Required
LargeFilepathS3	form	string	No
ThumbFilepathS3	form	string	No
Order	form	decimal	No
Description	form	string	No

**Meta** Parameters:
Name	Parameter	Data Type	Required	Description
ResourceCount	form	int	No
Title	form	string	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 /favorites HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FavoritesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <ResourceLibraryMemberId>0</ResourceLibraryMemberId>
  <DigitalFitness>false</DigitalFitness>
  <Health>false</Health>
  <HealthLibrary>false</HealthLibrary>
  <Limit>String</Limit>
  <Offset>String</Offset>
  <Vptr>false</Vptr>
  <Wellbeing>false</Wellbeing>
</FavoritesRequest>

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

<ResourceItemsLiteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <Meta xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models">
    <d2p1:ResourceCount>0</d2p1:ResourceCount>
    <d2p1:Title>String</d2p1:Title>
  </Meta>
  <ResourceItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models">
    <d2p1:ResourceCard>
      <d2p1:Calories>0</d2p1:Calories>
      <d2p1:Content>String</d2p1:Content>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DescriptionSummary>String</d2p1:DescriptionSummary>
      <d2p1:Difficulty>String</d2p1:Difficulty>
      <d2p1:DrmEncrypted>false</d2p1:DrmEncrypted>
      <d2p1:Duration>String</d2p1:Duration>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:Instructor>String</d2p1:Instructor>
      <d2p1:IsComplete>false</d2p1:IsComplete>
      <d2p1:IsConfirmable>false</d2p1:IsConfirmable>
      <d2p1:IsFavorite>false</d2p1:IsFavorite>
      <d2p1:IsImplicitlyComplete>false</d2p1:IsImplicitlyComplete>
      <d2p1:IsWcagCompliant>false</d2p1:IsWcagCompliant>
      <d2p1:MediaPath>String</d2p1:MediaPath>
      <d2p1:Preview>String</d2p1:Preview>
      <d2p1:Screenshots>
        <d2p1:ScreenshotItem>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:LargeFilepathS3>String</d2p1:LargeFilepathS3>
          <d2p1:Order>0</d2p1:Order>
          <d2p1:ThumbFilepathS3>String</d2p1:ThumbFilepathS3>
        </d2p1:ScreenshotItem>
      </d2p1:Screenshots>
      <d2p1:Subtitles>String</d2p1:Subtitles>
      <d2p1:Tags>
        <d2p1:Tag>
          <d2p1:_x003C_Id_x003E_k__BackingField>String</d2p1:_x003C_Id_x003E_k__BackingField>
          <d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
        </d2p1:Tag>
      </d2p1:Tags>
      <d2p1:Thumbnail>String</d2p1:Thumbnail>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:Type>String</d2p1:Type>
    </d2p1:ResourceCard>
  </ResourceItems>
</ResourceItemsLiteResponse>