GET | /topics/{topicid} | Use to get Resource Library Topic |
---|
namespace ASH.ResourceLibrary.Interfaces.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type Tag() =
member val Id:String = null with get,set
member val Title:String = null with get,set
[<AllowNullLiteral>]
type ScreenshotItem() =
member val LargeFilepathS3:String = null with get,set
member val ThumbFilepathS3:String = null with get,set
member val Order:Decimal = new Decimal() with get,set
member val Description:String = null with get,set
[<AllowNullLiteral>]
type ResourceCard() =
member val Id:String = null with get,set
member val Title:String = null with get,set
member val Description:String = null with get,set
member val DescriptionSummary:String = null with get,set
member val Type:String = null with get,set
member val Content:String = null with get,set
member val IsComplete:Boolean = new Boolean() with get,set
member val IsFavorite:Boolean = new Boolean() with get,set
member val IsImplicitlyComplete:Boolean = new Boolean() with get,set
member val MediaPath:String = null with get,set
member val IsConfirmable:Boolean = new Boolean() with get,set
member val IsWcagCompliant:Boolean = new Boolean() with get,set
member val Duration:String = null with get,set
member val Preview:String = null with get,set
member val Calories:Int32 = new Int32() with get,set
member val Instructor:String = null with get,set
member val Thumbnail:String = null with get,set
member val Difficulty:String = null with get,set
member val Tags:ResizeArray<Tag> = new ResizeArray<Tag>() with get,set
member val Subtitles:String = null with get,set
member val Screenshots:ResizeArray<ScreenshotItem> = new ResizeArray<ScreenshotItem>() with get,set
member val DrmEncrypted:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type SubtopicLite() =
member val Id:String = null with get,set
member val Title:String = null with get,set
member val ResourceCount:Int32 = new Int32() with get,set
member val ResourceItems:ICollection<ResourceCard> = null with get,set
[<AllowNullLiteral>]
type TopicLite() =
member val Id:String = null with get,set
member val SubtopicItems:ICollection<SubtopicLite> = null with get,set
member val ResourceItems:ICollection<ResourceCard> = null with get,set
member val Title:String = null with get,set
member val IsVisible:String = null with get,set
member val ResourceCount:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type TopicResponse() =
member val Topic:TopicLite = null with get,set
[<AllowNullLiteral>]
type BasicResourceLibraryRequest() =
member val ResourceLibraryMemberId:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type TopicRequest() =
inherit BasicResourceLibraryRequest()
member val IncludeCompletionStatus:Boolean = new Boolean() with get,set
member val Limit:String = null with get,set
member val Offset:String = null with get,set
member val TopicId:String = null with get,set
member val IsMobile:Boolean = new Boolean() with get,set
///<summary>
///Set it to true if the topic being requested belogs to digital fitness. Don't set it if unsure.
///</summary>
[<ApiMember(Description="Set it to true if the topic being requested belogs to digital fitness. Don't set it if unsure.")>]
member val DigitalFitness:Boolean = new Boolean() with get,set
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>