ASH.ResourceLibrary.WebApi

TopicRequest

The following routes are available for this service:
GET	/topics/{topicid}	Use to get Resource Library Topic

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BasicResourceLibraryRequest:
    resource_library_member_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Tag:
    id: Optional[str] = None
    title: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScreenshotItem:
    large_filepath_s3: Optional[str] = None
    thumb_filepath_s3: Optional[str] = None
    order: Optional[Decimal] = None
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourceCard:
    id: Optional[str] = None
    title: Optional[str] = None
    description: Optional[str] = None
    description_summary: Optional[str] = None
    type: Optional[str] = None
    content: Optional[str] = None
    is_complete: Optional[bool] = None
    is_favorite: Optional[bool] = None
    is_implicitly_complete: Optional[bool] = None
    media_path: Optional[str] = None
    is_confirmable: Optional[bool] = None
    is_wcag_compliant: Optional[bool] = None
    duration: Optional[str] = None
    preview: Optional[str] = None
    calories: Optional[int] = None
    instructor: Optional[str] = None
    thumbnail: Optional[str] = None
    difficulty: Optional[str] = None
    tags: Optional[List[Tag]] = None
    subtitles: Optional[str] = None
    screenshots: Optional[List[ScreenshotItem]] = None
    drm_encrypted: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubtopicLite:
    id: Optional[str] = None
    title: Optional[str] = None
    resource_count: Optional[int] = None
    resource_items: Optional[List[ResourceCard]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TopicLite:
    id: Optional[str] = None
    subtopic_items: Optional[List[SubtopicLite]] = None
    resource_items: Optional[List[ResourceCard]] = None
    title: Optional[str] = None
    is_visible: Optional[str] = None
    resource_count: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TopicResponse:
    topic: Optional[TopicLite] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TopicRequest(BasicResourceLibraryRequest):
    include_completion_status: Optional[bool] = None
    limit: Optional[str] = None
    offset: Optional[str] = None
    topic_id: Optional[str] = None
    is_mobile: Optional[bool] = None
    # @ApiMember(Description="Set it to true if the topic being requested belogs to digital fitness. Don't set it if unsure.")
    digital_fitness: Optional[bool] = None
    """
    Set it to true if the topic being requested belogs to digital fitness. Don't set it if unsure.
    """

Python TopicRequest 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 /topics/{topicid} HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/json

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

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