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
import java.math.*
import java.util.*
import net.servicestack.client.*


open class ResourceLookAheadRequest : BasicResourceLibraryRequest()
{
    var text:String? = null
    /**
    * Set it to true if requesting resources only from digital library
    */
    @ApiMember(Description="Set it to true if requesting resources only from digital library")
    var digitalFitness:Boolean? = null

    /**
    * Set it to true if requesting resources only from health library
    */
    @ApiMember(Description="Set it to true if requesting resources only from health library")
    var healthLibrary:Boolean? = null
}

open class BasicResourceLibraryRequest
{
    var resourceLibraryMemberId:Int? = null
}

open class ResourceLookAheadResponse
{
    var lookaheadResult:LookaheadResult? = null
}

open class LookaheadResult
{
    var id:String? = null
    var lookaheadTitles:ArrayList<LookaheadTitle> = ArrayList<LookaheadTitle>()
    var lookaheadTags:ArrayList<LookaheadTag> = ArrayList<LookaheadTag>()
}

open class LookaheadTitle
{
    var id:String? = null
    var title:String? = null
    var subtitle:String? = null
}

open class LookaheadTag
{
    var id:String? = null
    var title:String? = null
}

Kotlin ResourceLookAheadRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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