ASH.ResourceLibrary.WebApi

<back to all web services

TopicRequest

Requires Authentication
The following routes are available for this service:
GET/topics/{topicid}Use to get Resource Library Topic
TopicRequest Parameters:
NameParameterData TypeRequiredDescription
IncludeCompletionStatusqueryboolNo
LimitquerystringNo
OffsetquerystringNo
TopicIdpathstringNo
IsMobilequeryboolNo
DigitalFitnessqueryboolNoSet it to true if the topic being requested belogs to digital fitness. Don't set it if unsure.
BasicResourceLibraryRequest Parameters:
NameParameterData TypeRequiredDescription
ResourceLibraryMemberIdformintNo
TopicResponse Parameters:
NameParameterData TypeRequiredDescription
TopicformTopicLiteNo
TopicLite Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
SubtopicItemsformICollection<SubtopicLite>No
ResourceItemsformICollection<ResourceCard>No
TitleformstringNo
IsVisibleformstringNo
ResourceCountformintNo
SubtopicLite Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo
ResourceCountformintNo
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 /topics/{topicid} HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"topic":{"id":"String","subtopicItems":null,"resourceItems":null,"title":"String","isVisible":"String","resourceCount":0}}