ASH.ResourceLibrary.WebApi

TopicRequest

The following routes are available for this service:
GET	/topics/{topicid}	Use to get Resource Library Topic

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 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 SubtopicLite
            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 ResourceCard)
        End Class

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

        Public Partial Class TopicLite
            Public Overridable Property Id As String
            Public Overridable Property SubtopicItems As ICollection(Of SubtopicLite)
            Public Overridable Property ResourceItems As ICollection(Of ResourceCard)
            Public Overridable Property Title As String
            Public Overridable Property IsVisible As String
            Public Overridable Property ResourceCount As Integer
        End Class
    End Namespace

    Namespace ASH.ResourceLibrary.Interfaces.ServiceModels

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

        Public Partial Class TopicRequest
            Inherits BasicResourceLibraryRequest
            Public Overridable Property IncludeCompletionStatus As Boolean
            Public Overridable Property Limit As String
            Public Overridable Property Offset As String
            Public Overridable Property TopicId As String
            Public Overridable Property IsMobile As Boolean
            '''<Summary>
            '''Set it to true if the topic being requested belogs to digital fitness. Don't set it if unsure.
            '''</Summary>
            <ApiMember(Description:="Set it to true if the topic being requested belogs to digital fitness. Don't set it if unsure.")>
            Public Overridable Property DigitalFitness As Boolean
        End Class

        Public Partial Class TopicResponse
            Public Overridable Property Topic As TopicLite
        End Class
    End Namespace
End Namespace

VB.NET TopicRequest 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.

GET /topics/{topicid} HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/xml

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

<TopicResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <Topic xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models">
    <d2p1:Id>String</d2p1:Id>
    <d2p1:IsVisible>String</d2p1:IsVisible>
    <d2p1:ResourceCount>0</d2p1:ResourceCount>
    <d2p1:ResourceItems i:nil="true" />
    <d2p1:SubtopicItems i:nil="true" />
    <d2p1:Title>String</d2p1:Title>
  </Topic>
</TopicResponse>