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.*;

public class dtos
{

    public static class ResourceLookAheadRequest extends BasicResourceLibraryRequest
    {
        public String text = 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")
        public Boolean digitalFitness = 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")
        public Boolean healthLibrary = null;
        
        public String getText() { return text; }
        public ResourceLookAheadRequest setText(String value) { this.text = value; return this; }
        public Boolean isDigitalFitness() { return digitalFitness; }
        public ResourceLookAheadRequest setDigitalFitness(Boolean value) { this.digitalFitness = value; return this; }
        public Boolean isHealthLibrary() { return healthLibrary; }
        public ResourceLookAheadRequest setHealthLibrary(Boolean value) { this.healthLibrary = value; return this; }
    }

    public static class BasicResourceLibraryRequest
    {
        public Integer resourceLibraryMemberId = null;
        
        public Integer getResourceLibraryMemberId() { return resourceLibraryMemberId; }
        public BasicResourceLibraryRequest setResourceLibraryMemberId(Integer value) { this.resourceLibraryMemberId = value; return this; }
    }

    public static class ResourceLookAheadResponse
    {
        public LookaheadResult lookaheadResult = null;
        
        public LookaheadResult getLookaheadResult() { return lookaheadResult; }
        public ResourceLookAheadResponse setLookaheadResult(LookaheadResult value) { this.lookaheadResult = value; return this; }
    }

    public static class LookaheadResult
    {
        public String id = null;
        public ArrayList<LookaheadTitle> lookaheadTitles = null;
        public ArrayList<LookaheadTag> lookaheadTags = null;
        
        public String getId() { return id; }
        public LookaheadResult setId(String value) { this.id = value; return this; }
        public ArrayList<LookaheadTitle> getLookaheadTitles() { return lookaheadTitles; }
        public LookaheadResult setLookaheadTitles(ArrayList<LookaheadTitle> value) { this.lookaheadTitles = value; return this; }
        public ArrayList<LookaheadTag> getLookaheadTags() { return lookaheadTags; }
        public LookaheadResult setLookaheadTags(ArrayList<LookaheadTag> value) { this.lookaheadTags = value; return this; }
    }

    public static class LookaheadTitle
    {
        public String id = null;
        public String title = null;
        public String subtitle = null;
        
        public String getId() { return id; }
        public LookaheadTitle setId(String value) { this.id = value; return this; }
        public String getTitle() { return title; }
        public LookaheadTitle setTitle(String value) { this.title = value; return this; }
        public String getSubtitle() { return subtitle; }
        public LookaheadTitle setSubtitle(String value) { this.subtitle = value; return this; }
    }

    public static class LookaheadTag
    {
        public String id = null;
        public String title = null;
        
        public String getId() { return id; }
        public LookaheadTag setId(String value) { this.id = value; return this; }
        public String getTitle() { return title; }
        public LookaheadTag setTitle(String value) { this.title = value; return this; }
    }

}

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