GET | /topics/{topicid} | Use to get Resource Library Topic |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IncludeCompletionStatus | query | bool | No | |
Limit | query | string | No | |
Offset | query | string | No | |
TopicId | path | string | No | |
IsMobile | query | bool | No | |
DigitalFitness | query | bool | No | Set it to true if the topic being requested belogs to digital fitness. Don't set it if unsure. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResourceLibraryMemberId | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Topic | form | TopicLite | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
SubtopicItems | form | ICollection<SubtopicLite> | No | |
ResourceItems | form | ICollection<ResourceCard> | 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<ResourceCard> | 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 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /topics/{topicid} HTTP/1.1 Host: resourcelibrary.api.ashcompanies.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <TopicResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels"> <Topic xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models"> <d2p1:Id>String</d2p1:Id> <d2p1:IsVisible>String</d2p1:IsVisible> <d2p1:ResourceCount>0</d2p1:ResourceCount> <d2p1:ResourceItems i:nil="true" /> <d2p1:SubtopicItems i:nil="true" /> <d2p1:Title>String</d2p1:Title> </Topic> </TopicResponse>