ASH.ResourceLibrary.WebApi

<back to all web services

FavoritesRequest

Requires Authentication
The following routes are available for this service:
GET,POST/favoritesUse to get a list Resource Items
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ASH.ResourceLibrary.Interfaces.ServiceModels
Imports ASH.ResourceLibrary.Interfaces.Models

Namespace Global

    Namespace ASH.ResourceLibrary.Interfaces.Models

        Public Partial Class Meta
            Public Overridable Property ResourceCount As Integer
            Public Overridable Property Title As String
        End Class

        Public Partial Class ResourceCard
            Public Sub New()
                Tags = New List(Of Tag)
                Screenshots = New List(Of ScreenshotItem)
            End Sub

            Public Overridable Property Id As String
            Public Overridable Property Title As String
            Public Overridable Property Description As String
            Public Overridable Property DescriptionSummary As String
            Public Overridable Property Type As String
            Public Overridable Property Content As String
            Public Overridable Property IsComplete As Boolean
            Public Overridable Property IsFavorite As Boolean
            Public Overridable Property IsImplicitlyComplete As Boolean
            Public Overridable Property MediaPath As String
            Public Overridable Property IsConfirmable As Boolean
            Public Overridable Property IsWcagCompliant As Boolean
            Public Overridable Property Duration As String
            Public Overridable Property Preview As String
            Public Overridable Property Calories As Integer
            Public Overridable Property Instructor As String
            Public Overridable Property Thumbnail As String
            Public Overridable Property Difficulty As String
            Public Overridable Property Tags As List(Of Tag)
            Public Overridable Property Subtitles As String
            Public Overridable Property Screenshots As List(Of ScreenshotItem)
            Public Overridable Property DrmEncrypted As Boolean
        End Class

        Public Partial Class ScreenshotItem
            Public Overridable Property LargeFilepathS3 As String
            Public Overridable Property ThumbFilepathS3 As String
            Public Overridable Property Order As Decimal
            Public Overridable Property Description As String
        End Class

        Public Partial Class Tag
            Public Overridable Property Id As String
            Public Overridable Property Title As String
        End Class
    End Namespace

    Namespace ASH.ResourceLibrary.Interfaces.ServiceModels

        Public Partial Class BasicResourceLibraryRequest
            Public Overridable Property ResourceLibraryMemberId As Integer
        End Class

        Public Partial Class FavoritesRequest
            Inherits 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 Overridable Property DigitalFitness As Boolean

            '''<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 Overridable Property HealthLibrary As Boolean

            '''<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 Overridable Property Vptr As Boolean

            '''<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 Overridable Property Wellbeing As Boolean

            '''<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 Overridable Property Health As Boolean

            Public Overridable Property Limit As String
            Public Overridable Property Offset As String
        End Class

        Public Partial Class ResourceItemsLiteResponse
            Implements IResourceItemsLiteResponse
            Public Sub New()
                ResourceItems = New List(Of ResourceCard)
            End Sub

            Public Overridable Property ResourceItems As List(Of ResourceCard)
            Public Overridable Property Meta As Meta
        End Class
    End Namespace
End Namespace

VB.NET FavoritesRequest DTOs

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>