<back to all web services
FeaturedRequest
The following routes are available for this service:GET | /featured | Use to get Resource Library Featured list | |
---|
FeaturedRequest Parameters:Name | Parameter | Data Type | Required | Description |
---|
IncludeCompletionStatus | query | bool | No | |
BasicResourceLibraryRequest Parameters:Name | Parameter | Data Type | Required | Description |
---|
ResourceLibraryMemberId | form | int | No | |
TopicsResponse Parameters:Name | Parameter | Data Type | Required | Description |
---|
Topics | form | ICollection<Topic> | No | |
Topic Parameters: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 | |
SubTopic Parameters:Name | Parameter | Data Type | Required | Description |
---|
Id | form | string | No | |
Title | form | string | No | |
ResourceCount | form | int | No | |
ResourceItems | form | ICollection<ResourceItem> | No | |
ResourceItem Parameters: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 | |
ResourceCard Parameters: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 | |
Tag Parameters:Name | Parameter | Data Type | Required | Description |
---|
Id | form | string | No | |
Title | form | string | No | |
ScreenshotItem Parameters:Name | Parameter | Data Type | Required | Description |
---|
LargeFilepathS3 | form | string | No | |
ThumbFilepathS3 | form | string | No | |
Order | form | decimal | No | |
Description | form | string | No | |
Category Parameters: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 | |
ActivityItem Parameters:Name | Parameter | Data Type | Required | Description |
---|
Name | form | string | No | |
Id | form | string | No | |
SeriesItem Parameters:Name | Parameter | Data Type | Required | Description |
---|
Id | form | string | No | |
Title | form | string | No | |
AltMediaPaths Parameters: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
HTTP + CSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /featured HTTP/1.1
Host: resourcelibrary.api.ashcompanies.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"topics":null}