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 .xml suffix or ?format=xml

HTTP + XML

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

<ResourceLookAheadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <LookaheadResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models">
    <d2p1:Id>String</d2p1:Id>
    <d2p1:LookaheadTags>
      <d2p1:LookaheadTag>
        <d2p1:Id>String</d2p1:Id>
        <d2p1:Title>String</d2p1:Title>
      </d2p1:LookaheadTag>
    </d2p1:LookaheadTags>
    <d2p1:LookaheadTitles>
      <d2p1:LookaheadTitle>
        <d2p1:Id>String</d2p1:Id>
        <d2p1:Subtitle>String</d2p1:Subtitle>
        <d2p1:Title>String</d2p1:Title>
      </d2p1:LookaheadTitle>
    </d2p1:LookaheadTitles>
  </LookaheadResult>
</ResourceLookAheadResponse>