ASH.ResourceLibrary.WebApi

<back to all web services

ResourceLookAheadRequest

Requires Authentication
The following routes are available for this service:
GET/lookaheadResultsUse to get lookahead response for resourceitems
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 LookaheadResult
            Public Sub New()
                LookaheadTitles = New List(Of LookaheadTitle)
                LookaheadTags = New List(Of LookaheadTag)
            End Sub

            Public Overridable Property Id As String
            Public Overridable Property LookaheadTitles As List(Of LookaheadTitle)
            Public Overridable Property LookaheadTags As List(Of LookaheadTag)
        End Class

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

        Public Partial Class LookaheadTitle
            Public Overridable Property Id As String
            Public Overridable Property Title As String
            Public Overridable Property Subtitle 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 ResourceLookAheadRequest
            Inherits BasicResourceLibraryRequest
            Public Overridable Property Text As String
            '''<Summary>
            '''Set it to true if requesting resources only from digital library
            '''</Summary>
            <ApiMember(Description:="Set it to true if requesting resources only from digital library")>
            Public Overridable Property DigitalFitness As Boolean

            '''<Summary>
            '''Set it to true if requesting resources only from health library
            '''</Summary>
            <ApiMember(Description:="Set it to true if requesting resources only from health library")>
            Public Overridable Property HealthLibrary As Boolean
        End Class

        Public Partial Class ResourceLookAheadResponse
            Public Overridable Property LookaheadResult As LookaheadResult
        End Class
    End Namespace
End Namespace

VB.NET ResourceLookAheadRequest 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 /lookaheadResults HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"lookaheadResult":{"id":"String","lookaheadTitles":[{"id":"String","title":"String","subtitle":"String"}],"lookaheadTags":[{"id":"String","title":"String"}]}}