ASH.ResourceLibrary.WebApi

<back to all web services

FilterDataRequest

Requires Authentication
The following routes are available for this service:
GET/filterResultsReturns paginated filtered data based on the requested filters.
FilterDataRequest Parameters:
NameParameterData TypeRequiredDescription
workoutCategoryIdquerystringNo
BitwiseLevelqueryintNo
BitwiseDurationqueryintNo
BitwiseInstructorqueryulongNo
OffsetquerystringNo
LimitquerystringNo
DigitalFitnessqueryboolNo
TopicIdquerystringNo
BasicResourceLibraryRequest Parameters:
NameParameterData TypeRequiredDescription
ResourceLibraryMemberIdformintNo
FilterDataResponse Parameters:
NameParameterData TypeRequiredDescription
FilterResultsformFilterResultNo
FilterResult Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CategoryNameformstringNo
ItemCountformlongNo
ResourceItemsformICollection<ResourceCard>No
ResourceCard Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo
DescriptionformstringNo
DescriptionSummaryformstringNo
TypeformstringNo
ContentformstringNo
IsCompleteformboolNo
IsFavoriteformboolNo
IsImplicitlyCompleteformboolNo
MediaPathformstringNo
IsConfirmableformboolNo
IsWcagCompliantformboolNo
DurationformstringNo
PreviewformstringNo
CaloriesformintNo
InstructorformstringNo
ThumbnailformstringNo
DifficultyformstringNo
TagsformList<Tag>No
SubtitlesformstringNo
ScreenshotsformList<ScreenshotItem>No
DrmEncryptedformboolNo
Tag Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo
ScreenshotItem Parameters:
NameParameterData TypeRequiredDescription
LargeFilepathS3formstringNo
ThumbFilepathS3formstringNo
OrderformdecimalNo
DescriptionformstringNo

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

{"filterResults":{"id":"String","categoryName":"String","itemCount":0,"resourceItems":null}}