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
ResourceItemSearchRequest Parameters:
NameParameterData TypeRequiredDescription
RequestquerystringNo
TagsqueryList<string>No
CategoryIdquerystringNo
OffsetqueryintNo
LimitqueryintNo
digitalFitnessqueryboolNo
BasicResourceLibraryRequest Parameters:
NameParameterData TypeRequiredDescription
ResourceLibraryMemberIdformintNo
ResourceItemSearchResponse Parameters:
NameParameterData TypeRequiredDescription
SearchResultsformSearchResultNo
SearchResult Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ResourceItemsformList<ResourceItemForSearch>No
SearchItemsformList<ResourceItemForSearch>No
TagsformList<Tag>No
ItemCountformlongNo
ResourceItemForSearch Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TypeformstringNo
CategoriesformList<string>No
CategoryIndexesformList<string>No
TitleformstringNo
DescriptionformstringNo
DescriptionSummaryformstringNo
ContentformstringNo
TagsformList<string>No
IsCompleteformboolNo
IsFavoriteformboolNo
IsImplicitlyCompleteformboolNo
TranscriptformstringNo
ThumbnailformstringNo
DifficultyformstringNo
DurationformstringNo
MediaPathformstringNo
Tag Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo

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 /searchResults HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"searchResults":{"id":"String","resourceItems":[{"id":"String","type":"String","categories":["String"],"categoryIndexes":["String"],"title":"String","description":"String","descriptionSummary":"String","content":"String","tags":["String"],"isComplete":false,"isFavorite":false,"isImplicitlyComplete":false,"transcript":"String","thumbnail":"String","difficulty":"String","duration":"String","mediaPath":"String"}],"searchItems":[{"id":"String","type":"String","categories":["String"],"categoryIndexes":["String"],"title":"String","description":"String","descriptionSummary":"String","content":"String","tags":["String"],"isComplete":false,"isFavorite":false,"isImplicitlyComplete":false,"transcript":"String","thumbnail":"String","difficulty":"String","duration":"String","mediaPath":"String"}],"tags":[{"id":"String","title":"String"}],"itemCount":0}}