ASH.ResourceLibrary.WebApi

ResourceItemSearchRequest

The following routes are available for this service:
GET	/searchResults	Use to search Resource Items


export class BasicResourceLibraryRequest
{
    public resourceLibraryMemberId?: number;

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

export class ResourceItemSearchRequest extends BasicResourceLibraryRequest
{
    public request?: string;
    public tags?: string[];
    public categoryId?: string;
    public offset?: number;
    public limit?: number;
    public digitalFitness?: boolean;

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

export class ResourceItemForSearch
{
    public id?: string;
    public type?: string;
    public categories?: string[];
    public categoryIndexes?: string[];
    public title?: string;
    public description?: string;
    public descriptionSummary?: string;
    public content?: string;
    public tags?: string[];
    public isComplete?: boolean;
    public isFavorite?: boolean;
    public isImplicitlyComplete?: boolean;
    public transcript?: string;
    public thumbnail?: string;
    public difficulty?: string;
    public duration?: string;
    public mediaPath?: string;

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

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

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

export class SearchResult
{
    public id?: string;
    public resourceItems?: ResourceItemForSearch[];
    public searchItems?: ResourceItemForSearch[];
    public tags?: Tag[];
    public itemCount?: number;

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

export class ResourceItemSearchResponse
{
    public searchResults?: SearchResult;

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

TypeScript ResourceItemSearchRequest DTOs

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 /searchResults HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResourceItemSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <SearchResults xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models">
    <d2p1:Id>String</d2p1:Id>
    <d2p1:ItemCount>0</d2p1:ItemCount>
    <d2p1:ResourceItems>
      <d2p1:ResourceItemForSearch>
        <d2p1:Categories xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d2p1:Categories>
        <d2p1:CategoryIndexes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d2p1:CategoryIndexes>
        <d2p1:Content>String</d2p1:Content>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:DescriptionSummary>String</d2p1:DescriptionSummary>
        <d2p1:Difficulty>String</d2p1:Difficulty>
        <d2p1:Duration>String</d2p1:Duration>
        <d2p1:Id>String</d2p1:Id>
        <d2p1:IsComplete>false</d2p1:IsComplete>
        <d2p1:IsFavorite>false</d2p1:IsFavorite>
        <d2p1:IsImplicitlyComplete>false</d2p1:IsImplicitlyComplete>
        <d2p1:MediaPath>String</d2p1:MediaPath>
        <d2p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d2p1:Tags>
        <d2p1:Thumbnail>String</d2p1:Thumbnail>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:Transcript>String</d2p1:Transcript>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:ResourceItemForSearch>
    </d2p1:ResourceItems>
    <d2p1:SearchItems>
      <d2p1:ResourceItemForSearch>
        <d2p1:Categories xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d2p1:Categories>
        <d2p1:CategoryIndexes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d2p1:CategoryIndexes>
        <d2p1:Content>String</d2p1:Content>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:DescriptionSummary>String</d2p1:DescriptionSummary>
        <d2p1:Difficulty>String</d2p1:Difficulty>
        <d2p1:Duration>String</d2p1:Duration>
        <d2p1:Id>String</d2p1:Id>
        <d2p1:IsComplete>false</d2p1:IsComplete>
        <d2p1:IsFavorite>false</d2p1:IsFavorite>
        <d2p1:IsImplicitlyComplete>false</d2p1:IsImplicitlyComplete>
        <d2p1:MediaPath>String</d2p1:MediaPath>
        <d2p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d2p1:Tags>
        <d2p1:Thumbnail>String</d2p1:Thumbnail>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:Transcript>String</d2p1:Transcript>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:ResourceItemForSearch>
    </d2p1:SearchItems>
    <d2p1:Tags>
      <d2p1:Tag>
        <d2p1:_x003C_Id_x003E_k__BackingField>String</d2p1:_x003C_Id_x003E_k__BackingField>
        <d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
      </d2p1:Tag>
    </d2p1:Tags>
  </SearchResults>
</ResourceItemSearchResponse>