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
namespace ASH.ResourceLibrary.Interfaces.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BasicResourceLibraryRequest() = 
        member val ResourceLibraryMemberId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ResourceItemSearchRequest() = 
        inherit BasicResourceLibraryRequest()
        member val Request:String = null with get,set
        member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val CategoryId:String = null with get,set
        member val Offset:Int32 = new Int32() with get,set
        member val Limit:Int32 = new Int32() with get,set
        member val digitalFitness:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ResourceItemForSearch() = 
        member val Id:String = null with get,set
        member val Type:String = null with get,set
        member val Categories:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val CategoryIndexes:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Title:String = null with get,set
        member val Description:String = null with get,set
        member val DescriptionSummary:String = null with get,set
        member val Content:String = null with get,set
        member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val IsComplete:Boolean = new Boolean() with get,set
        member val IsFavorite:Boolean = new Boolean() with get,set
        member val IsImplicitlyComplete:Boolean = new Boolean() with get,set
        member val Transcript:String = null with get,set
        member val Thumbnail:String = null with get,set
        member val Difficulty:String = null with get,set
        member val Duration:String = null with get,set
        member val MediaPath:String = null with get,set

    [<AllowNullLiteral>]
    type Tag() = 
        member val Id:String = null with get,set
        member val Title:String = null with get,set

    [<AllowNullLiteral>]
    type SearchResult() = 
        member val Id:String = null with get,set
        member val ResourceItems:ResizeArray<ResourceItemForSearch> = new ResizeArray<ResourceItemForSearch>() with get,set
        member val SearchItems:ResizeArray<ResourceItemForSearch> = new ResizeArray<ResourceItemForSearch>() with get,set
        member val Tags:ResizeArray<Tag> = new ResizeArray<Tag>() with get,set
        member val ItemCount:Int64 = new Int64() with get,set

    [<AllowNullLiteral>]
    type ResourceItemSearchResponse() = 
        member val SearchResults:SearchResult = null with get,set

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