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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ASH.ResourceLibrary.Interfaces.ServiceModels;
using ASH.ResourceLibrary.Interfaces.Models;

namespace ASH.ResourceLibrary.Interfaces.Models
{
    public partial class ResourceCard
    {
        public ResourceCard()
        {
            Tags = new List<Tag>{};
            Screenshots = new List<ScreenshotItem>{};
        }

        public virtual string Id { get; set; }
        public virtual string Title { get; set; }
        public virtual string Description { get; set; }
        public virtual string DescriptionSummary { get; set; }
        public virtual string Type { get; set; }
        public virtual string Content { get; set; }
        public virtual bool IsComplete { get; set; }
        public virtual bool IsFavorite { get; set; }
        public virtual bool IsImplicitlyComplete { get; set; }
        public virtual string MediaPath { get; set; }
        public virtual bool IsConfirmable { get; set; }
        public virtual bool IsWcagCompliant { get; set; }
        public virtual string Duration { get; set; }
        public virtual string Preview { get; set; }
        public virtual int Calories { get; set; }
        public virtual string Instructor { get; set; }
        public virtual string Thumbnail { get; set; }
        public virtual string Difficulty { get; set; }
        public virtual List<Tag> Tags { get; set; }
        public virtual string Subtitles { get; set; }
        public virtual List<ScreenshotItem> Screenshots { get; set; }
        public virtual bool DrmEncrypted { get; set; }
    }

    public partial class ScreenshotItem
    {
        public virtual string LargeFilepathS3 { get; set; }
        public virtual string ThumbFilepathS3 { get; set; }
        public virtual decimal Order { get; set; }
        public virtual string Description { get; set; }
    }

    public partial class SubtopicLite
    {
        public virtual string Id { get; set; }
        public virtual string Title { get; set; }
        public virtual int ResourceCount { get; set; }
        public virtual ICollection<ResourceCard> ResourceItems { get; set; }
    }

    public partial class Tag
    {
        public virtual string Id { get; set; }
        public virtual string Title { get; set; }
    }

    public partial class TopicLite
    {
        public virtual string Id { get; set; }
        public virtual ICollection<SubtopicLite> SubtopicItems { get; set; }
        public virtual ICollection<ResourceCard> ResourceItems { get; set; }
        public virtual string Title { get; set; }
        public virtual string IsVisible { get; set; }
        public virtual int ResourceCount { get; set; }
    }

}

namespace ASH.ResourceLibrary.Interfaces.ServiceModels
{
    public partial class BasicResourceLibraryRequest
    {
        public virtual int ResourceLibraryMemberId { get; set; }
    }

    public partial class FeaturedTopicsRequest
        : BasicResourceLibraryRequest
    {
    }

    public partial class FeaturedTopicsResponse
    {
        public virtual ICollection<TopicLite> FeaturedTopics { get; set; }
    }

}

C# FeaturedTopicsRequest DTOs

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

<FeaturedTopicsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <FeaturedTopics xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models" i:nil="true" />
</FeaturedTopicsResponse>