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
namespace ASH.ResourceLibrary.Interfaces.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BasicResourceLibraryRequest() = 
        member val ResourceLibraryMemberId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ResourceLookAheadRequest() = 
        inherit BasicResourceLibraryRequest()
        member val Text:String = null with get,set
        ///<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")>]
        member val DigitalFitness:Boolean = new Boolean() with get,set

        ///<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")>]
        member val HealthLibrary:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type LookaheadTitle() = 
        member val Id:String = null with get,set
        member val Title:String = null with get,set
        member val Subtitle:String = null with get,set

    [<AllowNullLiteral>]
    type LookaheadTag() = 
        member val Id:String = null with get,set
        member val Title:String = null with get,set

    [<AllowNullLiteral>]
    type LookaheadResult() = 
        member val Id:String = null with get,set
        member val LookaheadTitles:ResizeArray<LookaheadTitle> = new ResizeArray<LookaheadTitle>() with get,set
        member val LookaheadTags:ResizeArray<LookaheadTag> = new ResizeArray<LookaheadTag>() with get,set

    [<AllowNullLiteral>]
    type ResourceLookAheadResponse() = 
        member val LookaheadResult:LookaheadResult = null with get,set

F# 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"}]}}