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

export class BasicResourceLibraryRequest
{
    public resourceLibraryMemberId?: number;

    public constructor(init?: Partial<BasicResourceLibraryRequest>) { (Object as any).assign(this, init); }
}

export class ResourceLookAheadRequest extends BasicResourceLibraryRequest
{
    public text?: string;
    /**
    * Set it to true if requesting resources only from digital library
    */
    // @ApiMember(Description="Set it to true if requesting resources only from digital library")
    public digitalFitness?: boolean;

    /**
    * Set it to true if requesting resources only from health library
    */
    // @ApiMember(Description="Set it to true if requesting resources only from health library")
    public healthLibrary?: boolean;

    public constructor(init?: Partial<ResourceLookAheadRequest>) { super(init); (Object as any).assign(this, init); }
}

export class LookaheadTitle
{
    public id?: string;
    public title?: string;
    public subtitle?: string;

    public constructor(init?: Partial<LookaheadTitle>) { (Object as any).assign(this, init); }
}

export class LookaheadTag
{
    public id?: string;
    public title?: string;

    public constructor(init?: Partial<LookaheadTag>) { (Object as any).assign(this, init); }
}

export class LookaheadResult
{
    public id?: string;
    public lookaheadTitles?: LookaheadTitle[];
    public lookaheadTags?: LookaheadTag[];

    public constructor(init?: Partial<LookaheadResult>) { (Object as any).assign(this, init); }
}

export class ResourceLookAheadResponse
{
    public lookaheadResult?: LookaheadResult;

    public constructor(init?: Partial<ResourceLookAheadResponse>) { (Object as any).assign(this, init); }
}

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