ASH.ResourceLibrary.WebApi

BannerTopicsRequest

The following routes are available for this service:
GET	/bannertopics	Use to get Resource Library Topics list for the banner


export class BasicResourceLibraryRequest
{
    public resourceLibraryMemberId?: number;

    public constructor(init?: Partial<BasicResourceLibraryRequest>) { (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 ActivityItem
{
    public name?: string;
    public id?: string;

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

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

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

export class AltMediaPaths
{
    public webm?: string;
    public ogv?: string;
    public mp4Low?: string;
    public mp4High?: string;

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

export class ResourceItem extends ResourceCard
{
    public content?: string;
    public credit?: string;
    public references?: string;
    public disclaimer?: string;
    public headerImage?: string;
    public origin?: string;
    public originId?: string;
    public tags?: Tag[];
    public categories?: Category[];
    public index?: number;
    public activityLevel?: string;
    public activityDetails?: string;
    public transcript?: string;
    public isArchived?: boolean;
    public activities?: ActivityItem[];
    public seriesItems?: SeriesItem[];
    public videoId?: string;
    public focus?: string;
    public series?: string;
    public seriesUrl?: string;
    public category?: string;
    public equipments?: string[];
    public durationRange?: string;
    public providerName?: string;
    public uploadDate?: string;
    public completionDate?: string;
    public level?: string;
    public bodyFocus?: string;
    public altMediaPaths?: AltMediaPaths;
    public subtitles?: string;
    public drmEncrypted?: boolean;
    public screenshots?: ScreenshotItem[];

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

export class SubTopic
{
    public id?: string;
    public title?: string;
    public resourceCount?: number;
    public resourceItems?: ResourceItem[];

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

export class Category
{
    public id?: string;
    public subtopicItems?: SubTopic[];
    public resourceItems?: ResourceItem[];
    public title?: string;
    public isVisible?: string;
    public resourceCount?: number;

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

export class BannerContent
{
    public topics?: Category[];
    public resources?: ResourceItem[];

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

export class BannerResourcesResponse
{
    public bannerContent?: BannerContent;

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

export class BannerTopicsRequest extends BasicResourceLibraryRequest
{
    public includeCompletionStatus?: boolean;

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

TypeScript BannerTopicsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /bannertopics HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"bannerContent":{"topics":[{"id":"String","subtopicItems":null,"resourceItems":null,"title":"String","isVisible":"String","resourceCount":0}],"resources":[{"content":"String","credit":"String","references":"String","disclaimer":"String","headerImage":"String","origin":"String","originId":"String","tags":[{"id":"String","title":"String"}],"categories":[{"id":"String","subtopicItems":null,"resourceItems":null,"title":"String","isVisible":"String","resourceCount":0}],"index":0,"activityLevel":"String","activityDetails":"String","transcript":"String","isArchived":false,"activities":[{"name":"String","id":"String"}],"seriesItems":[{"id":"String","title":"String"}],"videoId":"String","focus":"String","series":"String","seriesUrl":"String","category":"String","equipments":["String"],"durationRange":"String","providerName":"String","uploadDate":"String","completionDate":"0001-01-01T00:00:00.0000000","level":"String","bodyFocus":"String","altMediaPaths":{"webm":"String","ogv":"String","mp4Low":"String","mp4High":"String"},"subtitles":"String","drmEncrypted":false,"screenshots":[{"largeFilepathS3":"String","thumbFilepathS3":"String","order":0,"description":"String"}],"id":"String","title":"String","description":"String","descriptionSummary":"String","type":"String","isComplete":false,"isFavorite":false,"isImplicitlyComplete":false,"mediaPath":"String","isConfirmable":false,"isWcagCompliant":false,"duration":"String","preview":"String","calories":0,"instructor":"String","thumbnail":"String","difficulty":"String"}]}}