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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class TopicRequest extends BasicResourceLibraryRequest
    {
        public Boolean includeCompletionStatus = null;
        public String limit = null;
        public String offset = null;
        public String topicId = null;
        public Boolean isMobile = null;
        /**
        * Set it to true if the topic being requested belogs to digital fitness. Don't set it if unsure.
        */
        @ApiMember(Description="Set it to true if the topic being requested belogs to digital fitness. Don't set it if unsure.")
        public Boolean digitalFitness = null;
        
        public Boolean isIncludeCompletionStatus() { return includeCompletionStatus; }
        public TopicRequest setIncludeCompletionStatus(Boolean value) { this.includeCompletionStatus = value; return this; }
        public String getLimit() { return limit; }
        public TopicRequest setLimit(String value) { this.limit = value; return this; }
        public String getOffset() { return offset; }
        public TopicRequest setOffset(String value) { this.offset = value; return this; }
        public String getTopicId() { return topicId; }
        public TopicRequest setTopicId(String value) { this.topicId = value; return this; }
        public Boolean getIsMobile() { return isMobile; }
        public TopicRequest setIsMobile(Boolean value) { this.isMobile = value; return this; }
        public Boolean isDigitalFitness() { return digitalFitness; }
        public TopicRequest setDigitalFitness(Boolean value) { this.digitalFitness = value; return this; }
    }

    public static class BasicResourceLibraryRequest
    {
        public Integer resourceLibraryMemberId = null;
        
        public Integer getResourceLibraryMemberId() { return resourceLibraryMemberId; }
        public BasicResourceLibraryRequest setResourceLibraryMemberId(Integer value) { this.resourceLibraryMemberId = value; return this; }
    }

    public static class TopicResponse
    {
        public TopicLite topic = null;
        
        public TopicLite getTopic() { return topic; }
        public TopicResponse setTopic(TopicLite value) { this.topic = value; return this; }
    }

    public static class TopicLite
    {
        public String id = null;
        public ArrayList<SubtopicLite> subtopicItems = null;
        public ArrayList<ResourceCard> resourceItems = null;
        public String title = null;
        public String isVisible = null;
        public Integer resourceCount = null;
        
        public String getId() { return id; }
        public TopicLite setId(String value) { this.id = value; return this; }
        public ArrayList<SubtopicLite> getSubtopicItems() { return subtopicItems; }
        public TopicLite setSubtopicItems(ArrayList<SubtopicLite> value) { this.subtopicItems = value; return this; }
        public ArrayList<ResourceCard> getResourceItems() { return resourceItems; }
        public TopicLite setResourceItems(ArrayList<ResourceCard> value) { this.resourceItems = value; return this; }
        public String getTitle() { return title; }
        public TopicLite setTitle(String value) { this.title = value; return this; }
        public String getIsVisible() { return isVisible; }
        public TopicLite setIsVisible(String value) { this.isVisible = value; return this; }
        public Integer getResourceCount() { return resourceCount; }
        public TopicLite setResourceCount(Integer value) { this.resourceCount = value; return this; }
    }

    public static class SubtopicLite
    {
        public String id = null;
        public String title = null;
        public Integer resourceCount = null;
        public ArrayList<ResourceCard> resourceItems = null;
        
        public String getId() { return id; }
        public SubtopicLite setId(String value) { this.id = value; return this; }
        public String getTitle() { return title; }
        public SubtopicLite setTitle(String value) { this.title = value; return this; }
        public Integer getResourceCount() { return resourceCount; }
        public SubtopicLite setResourceCount(Integer value) { this.resourceCount = value; return this; }
        public ArrayList<ResourceCard> getResourceItems() { return resourceItems; }
        public SubtopicLite setResourceItems(ArrayList<ResourceCard> value) { this.resourceItems = value; return this; }
    }

    public static class ResourceCard
    {
        public String id = null;
        public String title = null;
        public String description = null;
        public String descriptionSummary = null;
        public String type = null;
        public String content = null;
        public Boolean isComplete = null;
        public Boolean isFavorite = null;
        public Boolean isImplicitlyComplete = null;
        public String mediaPath = null;
        public Boolean isConfirmable = null;
        public Boolean isWcagCompliant = null;
        public String duration = null;
        public String preview = null;
        public Integer calories = null;
        public String instructor = null;
        public String thumbnail = null;
        public String difficulty = null;
        public ArrayList<Tag> tags = null;
        public String subtitles = null;
        public ArrayList<ScreenshotItem> screenshots = null;
        public Boolean drmEncrypted = null;
        
        public String getId() { return id; }
        public ResourceCard setId(String value) { this.id = value; return this; }
        public String getTitle() { return title; }
        public ResourceCard setTitle(String value) { this.title = value; return this; }
        public String getDescription() { return description; }
        public ResourceCard setDescription(String value) { this.description = value; return this; }
        public String getDescriptionSummary() { return descriptionSummary; }
        public ResourceCard setDescriptionSummary(String value) { this.descriptionSummary = value; return this; }
        public String getType() { return type; }
        public ResourceCard setType(String value) { this.type = value; return this; }
        public String getContent() { return content; }
        public ResourceCard setContent(String value) { this.content = value; return this; }
        public Boolean getIsComplete() { return isComplete; }
        public ResourceCard setIsComplete(Boolean value) { this.isComplete = value; return this; }
        public Boolean getIsFavorite() { return isFavorite; }
        public ResourceCard setIsFavorite(Boolean value) { this.isFavorite = value; return this; }
        public Boolean getIsImplicitlyComplete() { return isImplicitlyComplete; }
        public ResourceCard setIsImplicitlyComplete(Boolean value) { this.isImplicitlyComplete = value; return this; }
        public String getMediaPath() { return mediaPath; }
        public ResourceCard setMediaPath(String value) { this.mediaPath = value; return this; }
        public Boolean getIsConfirmable() { return isConfirmable; }
        public ResourceCard setIsConfirmable(Boolean value) { this.isConfirmable = value; return this; }
        public Boolean getIsWcagCompliant() { return isWcagCompliant; }
        public ResourceCard setIsWcagCompliant(Boolean value) { this.isWcagCompliant = value; return this; }
        public String getDuration() { return duration; }
        public ResourceCard setDuration(String value) { this.duration = value; return this; }
        public String getPreview() { return preview; }
        public ResourceCard setPreview(String value) { this.preview = value; return this; }
        public Integer getCalories() { return calories; }
        public ResourceCard setCalories(Integer value) { this.calories = value; return this; }
        public String getInstructor() { return instructor; }
        public ResourceCard setInstructor(String value) { this.instructor = value; return this; }
        public String getThumbnail() { return thumbnail; }
        public ResourceCard setThumbnail(String value) { this.thumbnail = value; return this; }
        public String getDifficulty() { return difficulty; }
        public ResourceCard setDifficulty(String value) { this.difficulty = value; return this; }
        public ArrayList<Tag> getTags() { return tags; }
        public ResourceCard setTags(ArrayList<Tag> value) { this.tags = value; return this; }
        public String getSubtitles() { return subtitles; }
        public ResourceCard setSubtitles(String value) { this.subtitles = value; return this; }
        public ArrayList<ScreenshotItem> getScreenshots() { return screenshots; }
        public ResourceCard setScreenshots(ArrayList<ScreenshotItem> value) { this.screenshots = value; return this; }
        public Boolean isDrmEncrypted() { return drmEncrypted; }
        public ResourceCard setDrmEncrypted(Boolean value) { this.drmEncrypted = value; return this; }
    }

    public static class Tag
    {
        public String id = null;
        public String title = null;
        
        public String getId() { return id; }
        public Tag setId(String value) { this.id = value; return this; }
        public String getTitle() { return title; }
        public Tag setTitle(String value) { this.title = value; return this; }
    }

    public static class ScreenshotItem
    {
        public String largeFilepathS3 = null;
        public String thumbFilepathS3 = null;
        public BigDecimal order = null;
        public String description = null;
        
        public String getLargeFilepathS3() { return largeFilepathS3; }
        public ScreenshotItem setLargeFilepathS3(String value) { this.largeFilepathS3 = value; return this; }
        public String getThumbFilepathS3() { return thumbFilepathS3; }
        public ScreenshotItem setThumbFilepathS3(String value) { this.thumbFilepathS3 = value; return this; }
        public BigDecimal getOrder() { return order; }
        public ScreenshotItem setOrder(BigDecimal value) { this.order = value; return this; }
        public String getDescription() { return description; }
        public ScreenshotItem setDescription(String value) { this.description = value; return this; }
    }

}

Java TopicRequest 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 /topics/{topicid} HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"topic":{"id":"String","subtopicItems":null,"resourceItems":null,"title":"String","isVisible":"String","resourceCount":0}}