ASH.ResourceLibrary.WebApi

<back to all web services

CategoryRequest

Requires Authentication
The following routes are available for this service:
GET/categories/{CategoryId}Use to get Resource Items for specific Category
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CategoryRequest extends BasicResourceLibraryRequest
    {
        public Boolean includeCompletionStatus = null;
        public String categoryId = null;
        
        public Boolean isIncludeCompletionStatus() { return includeCompletionStatus; }
        public CategoryRequest setIncludeCompletionStatus(Boolean value) { this.includeCompletionStatus = value; return this; }
        public String getCategoryId() { return categoryId; }
        public CategoryRequest setCategoryId(String value) { this.categoryId = 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 Category
    {
        public String id = null;
        public ArrayList<SubTopic> subtopicItems = null;
        public ArrayList<ResourceItem> resourceItems = null;
        public String title = null;
        public String isVisible = null;
        public Integer resourceCount = null;
        
        public String getId() { return id; }
        public Category setId(String value) { this.id = value; return this; }
        public ArrayList<SubTopic> getSubtopicItems() { return subtopicItems; }
        public Category setSubtopicItems(ArrayList<SubTopic> value) { this.subtopicItems = value; return this; }
        public ArrayList<ResourceItem> getResourceItems() { return resourceItems; }
        public Category setResourceItems(ArrayList<ResourceItem> value) { this.resourceItems = value; return this; }
        public String getTitle() { return title; }
        public Category setTitle(String value) { this.title = value; return this; }
        public String getIsVisible() { return isVisible; }
        public Category setIsVisible(String value) { this.isVisible = value; return this; }
        public Integer getResourceCount() { return resourceCount; }
        public Category setResourceCount(Integer value) { this.resourceCount = value; return this; }
    }

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

    public static class ResourceItem extends ResourceCard
    {
        public String content = null;
        public String credit = null;
        public String references = null;
        public String disclaimer = null;
        public String headerImage = null;
        public String origin = null;
        public String originId = null;
        public ArrayList<Tag> tags = null;
        public ArrayList<Category> categories = null;
        public Integer index = null;
        public String activityLevel = null;
        public String activityDetails = null;
        public String transcript = null;
        public Boolean isArchived = null;
        public ArrayList<ActivityItem> activities = null;
        public ArrayList<SeriesItem> seriesItems = null;
        public String videoId = null;
        public String focus = null;
        public String series = null;
        public String seriesUrl = null;
        public String category = null;
        public ArrayList<String> equipments = null;
        public String durationRange = null;
        public String providerName = null;
        public String uploadDate = null;
        public Date completionDate = null;
        public String level = null;
        public String bodyFocus = null;
        public AltMediaPaths altMediaPaths = null;
        public String subtitles = null;
        public Boolean drmEncrypted = null;
        public ArrayList<ScreenshotItem> screenshots = null;
        
        public String getContent() { return content; }
        public ResourceItem setContent(String value) { this.content = value; return this; }
        public String getCredit() { return credit; }
        public ResourceItem setCredit(String value) { this.credit = value; return this; }
        public String getReferences() { return references; }
        public ResourceItem setReferences(String value) { this.references = value; return this; }
        public String getDisclaimer() { return disclaimer; }
        public ResourceItem setDisclaimer(String value) { this.disclaimer = value; return this; }
        public String getHeaderImage() { return headerImage; }
        public ResourceItem setHeaderImage(String value) { this.headerImage = value; return this; }
        public String getOrigin() { return origin; }
        public ResourceItem setOrigin(String value) { this.origin = value; return this; }
        public String getOriginId() { return originId; }
        public ResourceItem setOriginId(String value) { this.originId = value; return this; }
        public ArrayList<Tag> getTags() { return tags; }
        public ResourceItem setTags(ArrayList<Tag> value) { this.tags = value; return this; }
        public ArrayList<Category> getCategories() { return categories; }
        public ResourceItem setCategories(ArrayList<Category> value) { this.categories = value; return this; }
        public Integer getIndex() { return index; }
        public ResourceItem setIndex(Integer value) { this.index = value; return this; }
        public String getActivityLevel() { return activityLevel; }
        public ResourceItem setActivityLevel(String value) { this.activityLevel = value; return this; }
        public String getActivityDetails() { return activityDetails; }
        public ResourceItem setActivityDetails(String value) { this.activityDetails = value; return this; }
        public String getTranscript() { return transcript; }
        public ResourceItem setTranscript(String value) { this.transcript = value; return this; }
        public Boolean getIsArchived() { return isArchived; }
        public ResourceItem setIsArchived(Boolean value) { this.isArchived = value; return this; }
        public ArrayList<ActivityItem> getActivities() { return activities; }
        public ResourceItem setActivities(ArrayList<ActivityItem> value) { this.activities = value; return this; }
        public ArrayList<SeriesItem> getSeriesItems() { return seriesItems; }
        public ResourceItem setSeriesItems(ArrayList<SeriesItem> value) { this.seriesItems = value; return this; }
        public String getVideoId() { return videoId; }
        public ResourceItem setVideoId(String value) { this.videoId = value; return this; }
        public String getFocus() { return focus; }
        public ResourceItem setFocus(String value) { this.focus = value; return this; }
        public String getSeries() { return series; }
        public ResourceItem setSeries(String value) { this.series = value; return this; }
        public String getSeriesUrl() { return seriesUrl; }
        public ResourceItem setSeriesUrl(String value) { this.seriesUrl = value; return this; }
        public String getCategory() { return category; }
        public ResourceItem setCategory(String value) { this.category = value; return this; }
        public ArrayList<String> getEquipments() { return equipments; }
        public ResourceItem setEquipments(ArrayList<String> value) { this.equipments = value; return this; }
        public String getDurationRange() { return durationRange; }
        public ResourceItem setDurationRange(String value) { this.durationRange = value; return this; }
        public String getProviderName() { return providerName; }
        public ResourceItem setProviderName(String value) { this.providerName = value; return this; }
        public String getUploadDate() { return uploadDate; }
        public ResourceItem setUploadDate(String value) { this.uploadDate = value; return this; }
        public Date getCompletionDate() { return completionDate; }
        public ResourceItem setCompletionDate(Date value) { this.completionDate = value; return this; }
        public String getLevel() { return level; }
        public ResourceItem setLevel(String value) { this.level = value; return this; }
        public String getBodyFocus() { return bodyFocus; }
        public ResourceItem setBodyFocus(String value) { this.bodyFocus = value; return this; }
        public AltMediaPaths getAltMediaPaths() { return altMediaPaths; }
        public ResourceItem setAltMediaPaths(AltMediaPaths value) { this.altMediaPaths = value; return this; }
        public String getSubtitles() { return subtitles; }
        public ResourceItem setSubtitles(String value) { this.subtitles = value; return this; }
        public Boolean isDrmEncrypted() { return drmEncrypted; }
        public ResourceItem setDrmEncrypted(Boolean value) { this.drmEncrypted = value; return this; }
        public ArrayList<ScreenshotItem> getScreenshots() { return screenshots; }
        public ResourceItem setScreenshots(ArrayList<ScreenshotItem> value) { this.screenshots = 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; }
    }

    public static class ActivityItem
    {
        public String name = null;
        public String id = null;
        
        public String getName() { return name; }
        public ActivityItem setName(String value) { this.name = value; return this; }
        public String getId() { return id; }
        public ActivityItem setId(String value) { this.id = value; return this; }
    }

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

    public static class AltMediaPaths
    {
        public String webm = null;
        public String ogv = null;
        public String mp4Low = null;
        public String mp4High = null;
        
        public String getWebm() { return webm; }
        public AltMediaPaths setWebm(String value) { this.webm = value; return this; }
        public String getOgv() { return ogv; }
        public AltMediaPaths setOgv(String value) { this.ogv = value; return this; }
        public String getMp4Low() { return mp4Low; }
        public AltMediaPaths setMp4Low(String value) { this.mp4Low = value; return this; }
        public String getMp4High() { return mp4High; }
        public AltMediaPaths setMp4High(String value) { this.mp4High = value; return this; }
    }

}

Java CategoryRequest 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 /categories/{CategoryId} HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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