| GET,POST | /favorites | Use to get a list Resource Items |
|---|
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 Meta:
resource_count: Optional[int] = None
title: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourceItemsLiteResponse(IResourceItemsLiteResponse):
resource_items: Optional[List[ResourceCard]] = None
meta: Optional[Meta] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FavoritesRequest(BasicResourceLibraryRequest):
# @ApiMember(Description="Set it to true if requesting saved resources only from digital library")
digital_fitness: Optional[bool] = None
"""
Set it to true if requesting saved resources only from digital library
"""
# @ApiMember(Description="Set it to true if requesting saved resources only from health library")
health_library: Optional[bool] = None
"""
Set it to true if requesting saved resources only from health library
"""
# @ApiMember(Description="Set it to true if requesting saved resources only from vptr")
vptr: Optional[bool] = None
"""
Set it to true if requesting saved resources only from vptr
"""
# @ApiMember(Description="Set it to true if requesting saved resources only from wellbeing")
wellbeing: Optional[bool] = None
"""
Set it to true if requesting saved resources only from wellbeing
"""
# @ApiMember(Description="Set it to true if requesting saved resources only from health")
health: Optional[bool] = None
"""
Set it to true if requesting saved resources only from health
"""
limit: Optional[str] = None
offset: Optional[str] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /favorites HTTP/1.1
Host: resourcelibrary.api.ashcompanies.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FavoritesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
<ResourceLibraryMemberId>0</ResourceLibraryMemberId>
<DigitalFitness>false</DigitalFitness>
<Health>false</Health>
<HealthLibrary>false</HealthLibrary>
<Limit>String</Limit>
<Offset>String</Offset>
<Vptr>false</Vptr>
<Wellbeing>false</Wellbeing>
</FavoritesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ResourceItemsLiteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
<Meta xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models">
<d2p1:ResourceCount>0</d2p1:ResourceCount>
<d2p1:Title>String</d2p1:Title>
</Meta>
<ResourceItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models">
<d2p1:ResourceCard>
<d2p1:Calories>0</d2p1:Calories>
<d2p1:Content>String</d2p1:Content>
<d2p1:Description>String</d2p1:Description>
<d2p1:DescriptionSummary>String</d2p1:DescriptionSummary>
<d2p1:Difficulty>String</d2p1:Difficulty>
<d2p1:DrmEncrypted>false</d2p1:DrmEncrypted>
<d2p1:Duration>String</d2p1:Duration>
<d2p1:Id>String</d2p1:Id>
<d2p1:Instructor>String</d2p1:Instructor>
<d2p1:IsComplete>false</d2p1:IsComplete>
<d2p1:IsConfirmable>false</d2p1:IsConfirmable>
<d2p1:IsFavorite>false</d2p1:IsFavorite>
<d2p1:IsImplicitlyComplete>false</d2p1:IsImplicitlyComplete>
<d2p1:IsWcagCompliant>false</d2p1:IsWcagCompliant>
<d2p1:MediaPath>String</d2p1:MediaPath>
<d2p1:Preview>String</d2p1:Preview>
<d2p1:Screenshots>
<d2p1:ScreenshotItem>
<d2p1:Description>String</d2p1:Description>
<d2p1:LargeFilepathS3>String</d2p1:LargeFilepathS3>
<d2p1:Order>0</d2p1:Order>
<d2p1:ThumbFilepathS3>String</d2p1:ThumbFilepathS3>
</d2p1:ScreenshotItem>
</d2p1:Screenshots>
<d2p1:Subtitles>String</d2p1:Subtitles>
<d2p1:Tags>
<d2p1:Tag>
<d2p1:_x003C_Id_x003E_k__BackingField>String</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_Title_x003E_k__BackingField>String</d2p1:_x003C_Title_x003E_k__BackingField>
</d2p1:Tag>
</d2p1:Tags>
<d2p1:Thumbnail>String</d2p1:Thumbnail>
<d2p1:Title>String</d2p1:Title>
<d2p1:Type>String</d2p1:Type>
</d2p1:ResourceCard>
</ResourceItems>
</ResourceItemsLiteResponse>