ASH.ResourceLibrary.WebApi

<back to all web services

WorkoutCategoriesRequest

Requires Authentication
The following routes are available for this service:
GET/workoutCategoriesUse to get workout categories list
WorkoutCategoriesRequest Parameters:
NameParameterData TypeRequiredDescription
WorkoutCategoriesqueryList<WorkoutCategory>No
WorkoutCategoryIdquerystringNo
BasicResourceLibraryRequest Parameters:
NameParameterData TypeRequiredDescription
ResourceLibraryMemberIdformintNo
WorkoutCategory Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
WorkoutCategoryImageformstringNo
ResourceItemsformICollection<ResourceItem>No
ResourceItem Parameters:
NameParameterData TypeRequiredDescription
ContentformstringNo
CreditformstringNo
ReferencesformstringNo
DisclaimerformstringNo
HeaderImageformstringNo
OriginformstringNo
OriginIdformstringNo
TagsformList<Tag>No
CategoriesformList<Category>No
IndexformintNo
ActivityLevelformstringNo
ActivityDetailsformstringNo
TranscriptformstringNo
IsArchivedformboolNo
ActivitiesformList<ActivityItem>No
SeriesItemsformList<SeriesItem>No
VideoIdformstringNo
FocusformstringNo
SeriesformstringNo
SeriesUrlformstringNo
CategoryformstringNo
EquipmentsformList<string>No
DurationRangeformstringNo
ProviderNameformstringNo
UploadDateformstringNo
CompletionDateformDateTime?No
LevelformstringNo
BodyFocusformstringNo
AltMediaPathsformAltMediaPathsNo
SubtitlesformstringNo
DrmEncryptedformboolNo
ScreenshotsformList<ScreenshotItem>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
Category Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
SubtopicItemsformICollection<SubTopic>No
ResourceItemsformICollection<ResourceItem>No
TitleformstringNo
IsVisibleformstringNo
ResourceCountformintNo
SubTopic Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo
ResourceCountformintNo
ResourceItemsformICollection<ResourceItem>No
ActivityItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
IdformstringNo
SeriesItem Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo
AltMediaPaths Parameters:
NameParameterData TypeRequiredDescription
WebmformstringNo
OgvformstringNo
Mp4LowformstringNo
Mp4HighformstringNo
WorkoutCategoriesResponse Parameters:
NameParameterData TypeRequiredDescription
WorkoutCategoriesformList<WorkoutCategory>No
MetaformMetaNo
Meta Parameters:
NameParameterData TypeRequiredDescription
ResourceCountformintNo
TitleformstringNo

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

<WorkoutCategoriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <Meta xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models">
    <d2p1:ResourceCount>0</d2p1:ResourceCount>
    <d2p1:Title>String</d2p1:Title>
  </Meta>
  <WorkoutCategories xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models">
    <d2p1:WorkoutCategory>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ResourceItems i:nil="true" />
      <d2p1:WorkoutCategoryImage>String</d2p1:WorkoutCategoryImage>
    </d2p1:WorkoutCategory>
  </WorkoutCategories>
</WorkoutCategoriesResponse>