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 .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 /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>