| GET,POST | /favorites | Use 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"digitalFitness":false,"healthLibrary":false,"vptr":false,"wellbeing":false,"health":false,"limit":"String","offset":"String","resourceLibraryMemberId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"resourceItems":[{"id":"String","title":"String","description":"String","descriptionSummary":"String","type":"String","content":"String","isComplete":false,"isFavorite":false,"isImplicitlyComplete":false,"mediaPath":"String","isConfirmable":false,"isWcagCompliant":false,"duration":"String","preview":"String","calories":0,"instructor":"String","thumbnail":"String","difficulty":"String","tags":[{"id":"String","title":"String"}],"subtitles":"String","screenshots":[{"largeFilepathS3":"String","thumbFilepathS3":"String","order":0,"description":"String"}],"drmEncrypted":false}],"meta":{"resourceCount":0,"title":"String"}}