ASH.ResourceLibrary.WebApi

<back to all web services

SubTopicsRequest

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 ActivityItem
            Public Overridable Property Name As String
            Public Overridable Property Id As String
        End Class

        Public Partial Class AltMediaPaths
            Public Overridable Property Webm As String
            Public Overridable Property Ogv As String
            Public Overridable Property Mp4Low As String
            Public Overridable Property Mp4High As String
        End Class

        Public Partial Class Category
            Public Overridable Property Id As String
            Public Overridable Property SubtopicItems As ICollection(Of SubTopic)
            Public Overridable Property ResourceItems As ICollection(Of ResourceItem)
            Public Overridable Property Title As String
            Public Overridable Property IsVisible As String
            Public Overridable Property ResourceCount As Integer
        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 ResourceItem
            Inherits ResourceCard
            Public Sub New()
                Tags = New List(Of Tag)
                Categories = New List(Of Category)
                Activities = New List(Of ActivityItem)
                SeriesItems = New List(Of SeriesItem)
                Equipments = New List(Of String)
                Screenshots = New List(Of ScreenshotItem)
            End Sub

            Public Overridable Property Content As String
            Public Overridable Property Credit As String
            Public Overridable Property References As String
            Public Overridable Property Disclaimer As String
            Public Overridable Property HeaderImage As String
            Public Overridable Property Origin As String
            Public Overridable Property OriginId As String
            Public Overridable Property Tags As List(Of Tag)
            Public Overridable Property Categories As List(Of Category)
            Public Overridable Property Index As Integer
            Public Overridable Property ActivityLevel As String
            Public Overridable Property ActivityDetails As String
            Public Overridable Property Transcript As String
            Public Overridable Property IsArchived As Boolean
            Public Overridable Property Activities As List(Of ActivityItem)
            Public Overridable Property SeriesItems As List(Of SeriesItem)
            Public Overridable Property VideoId As String
            Public Overridable Property Focus As String
            Public Overridable Property Series As String
            Public Overridable Property SeriesUrl As String
            Public Overridable Property Category As String
            Public Overridable Property Equipments As List(Of String)
            Public Overridable Property DurationRange As String
            Public Overridable Property ProviderName As String
            Public Overridable Property UploadDate As String
            Public Overridable Property CompletionDate As Nullable(Of Date)
            Public Overridable Property Level As String
            Public Overridable Property BodyFocus As String
            Public Overridable Property AltMediaPaths As AltMediaPaths
            Public Overridable Property Subtitles As String
            Public Overridable Property DrmEncrypted As Boolean
            Public Overridable Property Screenshots As List(Of ScreenshotItem)
        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 SeriesItem
            Public Overridable Property Id As String
            Public Overridable Property Title As String
        End Class

        Public Partial Class SubTopic
            Public Overridable Property Id As String
            Public Overridable Property Title As String
            Public Overridable Property ResourceCount As Integer
            Public Overridable Property ResourceItems As ICollection(Of ResourceItem)
        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 SubTopicsRequest
            Inherits BasicResourceLibraryRequest
            Public Overridable Property IncludeCompletionStatus As Boolean
            '''<Summary>
            '''Set it to true if the subtopics being requested belogs to digital fitness. Don't set it if unsure.
            '''</Summary>
            <ApiMember(Description:="Set it to true if the subtopics being requested belogs to digital fitness. Don't set it if unsure.")>
            Public Overridable Property DigitalFitness As Boolean
        End Class

        Public Partial Class SubTopicsResponse
            Public Overridable Property SubTopics As ICollection(Of SubTopic)
        End Class
    End Namespace
End Namespace

VB.NET SubTopicsRequest DTOs

GET /subtopicItems HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"subTopics":null}