GET,POST | /favorites | Use to get a list Resource Items |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ASH.ResourceLibrary.Interfaces.ServiceModels;
using ASH.ResourceLibrary.Interfaces.Models;
namespace ASH.ResourceLibrary.Interfaces.Models
{
public partial class Meta
{
public virtual int ResourceCount { get; set; }
public virtual string Title { get; set; }
}
public partial class ResourceCard
{
public ResourceCard()
{
Tags = new List<Tag>{};
Screenshots = new List<ScreenshotItem>{};
}
public virtual string Id { get; set; }
public virtual string Title { get; set; }
public virtual string Description { get; set; }
public virtual string DescriptionSummary { get; set; }
public virtual string Type { get; set; }
public virtual string Content { get; set; }
public virtual bool IsComplete { get; set; }
public virtual bool IsFavorite { get; set; }
public virtual bool IsImplicitlyComplete { get; set; }
public virtual string MediaPath { get; set; }
public virtual bool IsConfirmable { get; set; }
public virtual bool IsWcagCompliant { get; set; }
public virtual string Duration { get; set; }
public virtual string Preview { get; set; }
public virtual int Calories { get; set; }
public virtual string Instructor { get; set; }
public virtual string Thumbnail { get; set; }
public virtual string Difficulty { get; set; }
public virtual List<Tag> Tags { get; set; }
public virtual string Subtitles { get; set; }
public virtual List<ScreenshotItem> Screenshots { get; set; }
public virtual bool DrmEncrypted { get; set; }
}
public partial class ScreenshotItem
{
public virtual string LargeFilepathS3 { get; set; }
public virtual string ThumbFilepathS3 { get; set; }
public virtual decimal Order { get; set; }
public virtual string Description { get; set; }
}
public partial class Tag
{
public virtual string Id { get; set; }
public virtual string Title { get; set; }
}
}
namespace ASH.ResourceLibrary.Interfaces.ServiceModels
{
public partial class BasicResourceLibraryRequest
{
public virtual int ResourceLibraryMemberId { get; set; }
}
public partial class FavoritesRequest
: BasicResourceLibraryRequest
{
///<summary>
///Set it to true if requesting saved resources only from digital library
///</summary>
[ApiMember(Description="Set it to true if requesting saved resources only from digital library")]
public virtual bool DigitalFitness { get; set; }
///<summary>
///Set it to true if requesting saved resources only from health library
///</summary>
[ApiMember(Description="Set it to true if requesting saved resources only from health library")]
public virtual bool HealthLibrary { get; set; }
///<summary>
///Set it to true if requesting saved resources only from vptr
///</summary>
[ApiMember(Description="Set it to true if requesting saved resources only from vptr")]
public virtual bool Vptr { get; set; }
///<summary>
///Set it to true if requesting saved resources only from wellbeing
///</summary>
[ApiMember(Description="Set it to true if requesting saved resources only from wellbeing")]
public virtual bool Wellbeing { get; set; }
///<summary>
///Set it to true if requesting saved resources only from health
///</summary>
[ApiMember(Description="Set it to true if requesting saved resources only from health")]
public virtual bool Health { get; set; }
public virtual string Limit { get; set; }
public virtual string Offset { get; set; }
}
public partial class ResourceItemsLiteResponse
: IResourceItemsLiteResponse
{
public ResourceItemsLiteResponse()
{
ResourceItems = new List<ResourceCard>{};
}
public virtual List<ResourceCard> ResourceItems { get; set; }
public virtual Meta Meta { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>