ASH.ResourceLibrary.WebApi

<back to all web services

FeaturedTopicsRequest

Requires Authentication
The following routes are available for this service:
GET/featuredTopicsUse to get Resource Library topics with featured resources

export class BasicResourceLibraryRequest
{
    public resourceLibraryMemberId?: number;

    public constructor(init?: Partial<BasicResourceLibraryRequest>) { (Object as any).assign(this, init); }
}

export class FeaturedTopicsRequest extends BasicResourceLibraryRequest
{

    public constructor(init?: Partial<FeaturedTopicsRequest>) { super(init); (Object as any).assign(this, init); }
}

export class Tag
{
    public id?: string;
    public title?: string;

    public constructor(init?: Partial<Tag>) { (Object as any).assign(this, init); }
}

export class ScreenshotItem
{
    public largeFilepathS3?: string;
    public thumbFilepathS3?: string;
    public order?: number;
    public description?: string;

    public constructor(init?: Partial<ScreenshotItem>) { (Object as any).assign(this, init); }
}

export class ResourceCard
{
    public id?: string;
    public title?: string;
    public description?: string;
    public descriptionSummary?: string;
    public type?: string;
    public content?: string;
    public isComplete?: boolean;
    public isFavorite?: boolean;
    public isImplicitlyComplete?: boolean;
    public mediaPath?: string;
    public isConfirmable?: boolean;
    public isWcagCompliant?: boolean;
    public duration?: string;
    public preview?: string;
    public calories?: number;
    public instructor?: string;
    public thumbnail?: string;
    public difficulty?: string;
    public tags?: Tag[];
    public subtitles?: string;
    public screenshots?: ScreenshotItem[];
    public drmEncrypted?: boolean;

    public constructor(init?: Partial<ResourceCard>) { (Object as any).assign(this, init); }
}

export class SubtopicLite
{
    public id?: string;
    public title?: string;
    public resourceCount?: number;
    public resourceItems?: ResourceCard[];

    public constructor(init?: Partial<SubtopicLite>) { (Object as any).assign(this, init); }
}

export class TopicLite
{
    public id?: string;
    public subtopicItems?: SubtopicLite[];
    public resourceItems?: ResourceCard[];
    public title?: string;
    public isVisible?: string;
    public resourceCount?: number;

    public constructor(init?: Partial<TopicLite>) { (Object as any).assign(this, init); }
}

export class FeaturedTopicsResponse
{
    public featuredTopics?: TopicLite[];

    public constructor(init?: Partial<FeaturedTopicsResponse>) { (Object as any).assign(this, init); }
}

TypeScript FeaturedTopicsRequest DTOs

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 /featuredTopics HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"featuredTopics":null}