ASH.ResourceLibrary.WebApi

<back to all web services

ResourceItemSearchRequest

Requires Authentication
The following routes are available for this service:
GET/searchResultsUse to search Resource Items
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ASH.ResourceLibrary.Interfaces.ServiceModels;
using ASH.ResourceLibrary.Interfaces.Models;

namespace ASH.ResourceLibrary.Interfaces.Models
{
    public partial class ResourceItemForSearch
    {
        public ResourceItemForSearch()
        {
            Categories = new List<string>{};
            CategoryIndexes = new List<string>{};
            Tags = new List<string>{};
        }

        public virtual string Id { get; set; }
        public virtual string Type { get; set; }
        public virtual List<string> Categories { get; set; }
        public virtual List<string> CategoryIndexes { get; set; }
        public virtual string Title { get; set; }
        public virtual string Description { get; set; }
        public virtual string DescriptionSummary { get; set; }
        public virtual string Content { get; set; }
        public virtual List<string> Tags { get; set; }
        public virtual bool IsComplete { get; set; }
        public virtual bool IsFavorite { get; set; }
        public virtual bool IsImplicitlyComplete { get; set; }
        public virtual string Transcript { get; set; }
        public virtual string Thumbnail { get; set; }
        public virtual string Difficulty { get; set; }
        public virtual string Duration { get; set; }
        public virtual string MediaPath { get; set; }
    }

    public partial class SearchResult
    {
        public SearchResult()
        {
            ResourceItems = new List<ResourceItemForSearch>{};
            SearchItems = new List<ResourceItemForSearch>{};
            Tags = new List<Tag>{};
        }

        public virtual string Id { get; set; }
        public virtual List<ResourceItemForSearch> ResourceItems { get; set; }
        public virtual List<ResourceItemForSearch> SearchItems { get; set; }
        public virtual List<Tag> Tags { get; set; }
        public virtual long ItemCount { get; set; }
    }

    public partial class Tag
    {
        public virtual string Id { get; set; }
        public virtual string Title { get; set; }
    }

}

namespace ASH.ResourceLibrary.Interfaces.ServiceModels
{
    public partial class BasicResourceLibraryRequest
    {
        public virtual int ResourceLibraryMemberId { get; set; }
    }

    public partial class ResourceItemSearchRequest
        : BasicResourceLibraryRequest
    {
        public ResourceItemSearchRequest()
        {
            Tags = new List<string>{};
        }

        public virtual string Request { get; set; }
        public virtual List<string> Tags { get; set; }
        public virtual string CategoryId { get; set; }
        public virtual int Offset { get; set; }
        public virtual int Limit { get; set; }
        public virtual bool digitalFitness { get; set; }
    }

    public partial class ResourceItemSearchResponse
    {
        public virtual SearchResult SearchResults { get; set; }
    }

}

C# 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>