ASH.ResourceLibrary.WebApi

ResourceItemSearchRequest

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

**ResourceItemSearchRequest** Parameters:
Name	Parameter	Data Type	Required
Request	query	string	No
Tags	query	List<string>	No
CategoryId	query	string	No
Offset	query	int	No
Limit	query	int	No
digitalFitness	query	bool	No

**BasicResourceLibraryRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ResourceLibraryMemberId	form	int	No

**ResourceItemSearchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SearchResults	form	SearchResult	No

**SearchResult** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
ResourceItems	form	List<ResourceItemForSearch>	No
SearchItems	form	List<ResourceItemForSearch>	No
Tags	form	List<Tag>	No
ItemCount	form	long	No

**ResourceItemForSearch** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Type	form	string	No
Categories	form	List<string>	No
CategoryIndexes	form	List<string>	No
Title	form	string	No
Description	form	string	No
DescriptionSummary	form	string	No
Content	form	string	No
Tags	form	List<string>	No
IsComplete	form	bool	No
IsFavorite	form	bool	No
IsImplicitlyComplete	form	bool	No
Transcript	form	string	No
Thumbnail	form	string	No
Difficulty	form	string	No
Duration	form	string	No
MediaPath	form	string	No

**Tag** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Title	form	string	No

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>