GET,POST | /resourceItems | Use to get a list Resource Items |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IncludeCompletionStatus | body | bool | No | |
IncludeContent | body | bool | No | |
IsFavorite | body | bool | No | |
IsDigitalWorkoutFeatured | body | bool | No | |
MultipleDWFeaturedResources | body | bool | No | |
WorkoutCategoryId | body | string | No | |
ResourceItemIds | body | List<string> | No | |
DigitalFitness | body | bool | No | Set it to true if requesting resources only from digital library |
HealthLibrary | body | bool | No | Set it to true if requesting resources only from health library |
Limit | body | string | No | |
Offset | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResourceLibraryMemberId | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResourceItems | form | List<ResourceItem> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Content | form | string | No | |
Credit | form | string | No | |
References | form | string | No | |
Disclaimer | form | string | No | |
HeaderImage | form | string | No | |
Origin | form | string | No | |
OriginId | form | string | No | |
Tags | form | List<Tag> | No | |
Categories | form | List<Category> | No | |
Index | form | int | No | |
ActivityLevel | form | string | No | |
ActivityDetails | form | string | No | |
Transcript | form | string | No | |
IsArchived | form | bool | No | |
Activities | form | List<ActivityItem> | No | |
SeriesItems | form | List<SeriesItem> | No | |
VideoId | form | string | No | |
Focus | form | string | No | |
Series | form | string | No | |
SeriesUrl | form | string | No | |
Category | form | string | No | |
Equipments | form | List<string> | No | |
DurationRange | form | string | No | |
ProviderName | form | string | No | |
UploadDate | form | string | No | |
CompletionDate | form | DateTime? | No | |
Level | form | string | No | |
BodyFocus | form | string | No | |
AltMediaPaths | form | AltMediaPaths | No | |
Subtitles | form | string | No | |
DrmEncrypted | form | bool | No | |
Screenshots | form | List<ScreenshotItem> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Title | form | string | No | |
Description | form | string | No | |
DescriptionSummary | form | string | No | |
Type | form | string | No | |
Content | form | string | No | |
IsComplete | form | bool | No | |
IsFavorite | form | bool | No | |
IsImplicitlyComplete | form | bool | No | |
MediaPath | form | string | No | |
IsConfirmable | form | bool | No | |
IsWcagCompliant | form | bool | No | |
Duration | form | string | No | |
Preview | form | string | No | |
Calories | form | int | No | |
Instructor | form | string | No | |
Thumbnail | form | string | No | |
Difficulty | form | string | No | |
Tags | form | List<Tag> | No | |
Subtitles | form | string | No | |
Screenshots | form | List<ScreenshotItem> | No | |
DrmEncrypted | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Title | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LargeFilepathS3 | form | string | No | |
ThumbFilepathS3 | form | string | No | |
Order | form | decimal | No | |
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
SubtopicItems | form | ICollection<SubTopic> | No | |
ResourceItems | form | ICollection<ResourceItem> | No | |
Title | form | string | No | |
IsVisible | form | string | No | |
ResourceCount | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Title | form | string | No | |
ResourceCount | form | int | No | |
ResourceItems | form | ICollection<ResourceItem> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Title | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Webm | form | string | No | |
Ogv | form | string | No | |
Mp4Low | form | string | No | |
Mp4High | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /resourceItems HTTP/1.1
Host: resourcelibrary.api.ashcompanies.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"includeCompletionStatus":false,"includeContent":false,"isFavorite":false,"isDigitalWorkoutFeatured":false,"multipleDWFeaturedResources":false,"workoutCategoryId":"String","resourceItemIds":["String"],"digitalFitness":false,"healthLibrary":false,"limit":"String","offset":"String","resourceLibraryMemberId":0}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"resourceItems":[{"content":"String","credit":"String","references":"String","disclaimer":"String","headerImage":"String","origin":"String","originId":"String","tags":[{"id":"String","title":"String"}],"categories":[{"id":"String","subtopicItems":null,"resourceItems":null,"title":"String","isVisible":"String","resourceCount":0}],"index":0,"activityLevel":"String","activityDetails":"String","transcript":"String","isArchived":false,"activities":[{"name":"String","id":"String"}],"seriesItems":[{"id":"String","title":"String"}],"videoId":"String","focus":"String","series":"String","seriesUrl":"String","category":"String","equipments":["String"],"durationRange":"String","providerName":"String","uploadDate":"String","completionDate":"0001-01-01T00:00:00.0000000","level":"String","bodyFocus":"String","altMediaPaths":{"webm":"String","ogv":"String","mp4Low":"String","mp4High":"String"},"subtitles":"String","drmEncrypted":false,"screenshots":[{"largeFilepathS3":"String","thumbFilepathS3":"String","order":0,"description":"String"}],"id":"String","title":"String","description":"String","descriptionSummary":"String","type":"String","isComplete":false,"isFavorite":false,"isImplicitlyComplete":false,"mediaPath":"String","isConfirmable":false,"isWcagCompliant":false,"duration":"String","preview":"String","calories":0,"instructor":"String","thumbnail":"String","difficulty":"String"}]}