ASH.ResourceLibrary.WebApi

ResourceItemSearchRequest

The following routes are available for this service:
GET	/searchResults	Use to search 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 ResourceItemForSearch
            Public Sub New()
                Categories = New List(Of String)
                CategoryIndexes = New List(Of String)
                Tags = New List(Of String)
            End Sub

            Public Overridable Property Id As String
            Public Overridable Property Type As String
            Public Overridable Property Categories As List(Of String)
            Public Overridable Property CategoryIndexes As List(Of String)
            Public Overridable Property Title As String
            Public Overridable Property Description As String
            Public Overridable Property DescriptionSummary As String
            Public Overridable Property Content As String
            Public Overridable Property Tags As List(Of String)
            Public Overridable Property IsComplete As Boolean
            Public Overridable Property IsFavorite As Boolean
            Public Overridable Property IsImplicitlyComplete As Boolean
            Public Overridable Property Transcript As String
            Public Overridable Property Thumbnail As String
            Public Overridable Property Difficulty As String
            Public Overridable Property Duration As String
            Public Overridable Property MediaPath As String
        End Class

        Public Partial Class SearchResult
            Public Sub New()
                ResourceItems = New List(Of ResourceItemForSearch)
                SearchItems = New List(Of ResourceItemForSearch)
                Tags = New List(Of Tag)
            End Sub

            Public Overridable Property Id As String
            Public Overridable Property ResourceItems As List(Of ResourceItemForSearch)
            Public Overridable Property SearchItems As List(Of ResourceItemForSearch)
            Public Overridable Property Tags As List(Of Tag)
            Public Overridable Property ItemCount As Long
        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 ResourceItemSearchRequest
            Inherits BasicResourceLibraryRequest
            Public Sub New()
                Tags = New List(Of String)
            End Sub

            Public Overridable Property Request As String
            Public Overridable Property Tags As List(Of String)
            Public Overridable Property CategoryId As String
            Public Overridable Property Offset As Integer
            Public Overridable Property Limit As Integer
            Public Overridable Property digitalFitness As Boolean
        End Class

        Public Partial Class ResourceItemSearchResponse
            Public Overridable Property SearchResults As SearchResult
        End Class
    End Namespace
End Namespace

VB.NET ResourceItemSearchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

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

{"searchResults":{"id":"String","resourceItems":[{"id":"String","type":"String","categories":["String"],"categoryIndexes":["String"],"title":"String","description":"String","descriptionSummary":"String","content":"String","tags":["String"],"isComplete":false,"isFavorite":false,"isImplicitlyComplete":false,"transcript":"String","thumbnail":"String","difficulty":"String","duration":"String","mediaPath":"String"}],"searchItems":[{"id":"String","type":"String","categories":["String"],"categoryIndexes":["String"],"title":"String","description":"String","descriptionSummary":"String","content":"String","tags":["String"],"isComplete":false,"isFavorite":false,"isImplicitlyComplete":false,"transcript":"String","thumbnail":"String","difficulty":"String","duration":"String","mediaPath":"String"}],"tags":[{"id":"String","title":"String"}],"itemCount":0}}