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
ResourceLookAheadRequest Parameters:
NameParameterData TypeRequiredDescription
TextquerystringNo
DigitalFitnessqueryboolNoSet it to true if requesting resources only from digital library
HealthLibraryqueryboolNoSet it to true if requesting resources only from health library
BasicResourceLibraryRequest Parameters:
NameParameterData TypeRequiredDescription
ResourceLibraryMemberIdformintNo
ResourceLookAheadResponse Parameters:
NameParameterData TypeRequiredDescription
LookaheadResultformLookaheadResultNo
LookaheadResult Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
LookaheadTitlesformList<LookaheadTitle>No
LookaheadTagsformList<LookaheadTag>No
LookaheadTitle Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo
SubtitleformstringNo
LookaheadTag Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo

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