ASH.ResourceLibrary.WebApi

<back to all web services

FavoritesRequest

export class BasicResourceLibraryRequest
{
    public resourceLibraryMemberId?: number;

    public constructor(init?: Partial<BasicResourceLibraryRequest>) { (Object as any).assign(this, init); }
}

export class Tag
{
    public id?: string;
    public title?: string;

    public constructor(init?: Partial<Tag>) { (Object as any).assign(this, init); }
}

export class ScreenshotItem
{
    public largeFilepathS3?: string;
    public thumbFilepathS3?: string;
    public order?: number;
    public description?: string;

    public constructor(init?: Partial<ScreenshotItem>) { (Object as any).assign(this, init); }
}

export class ResourceCard
{
    public id?: string;
    public title?: string;
    public description?: string;
    public descriptionSummary?: string;
    public type?: string;
    public content?: string;
    public isComplete?: boolean;
    public isFavorite?: boolean;
    public isImplicitlyComplete?: boolean;
    public mediaPath?: string;
    public isConfirmable?: boolean;
    public isWcagCompliant?: boolean;
    public duration?: string;
    public preview?: string;
    public calories?: number;
    public instructor?: string;
    public thumbnail?: string;
    public difficulty?: string;
    public tags?: Tag[];
    public subtitles?: string;
    public screenshots?: ScreenshotItem[];
    public drmEncrypted?: boolean;

    public constructor(init?: Partial<ResourceCard>) { (Object as any).assign(this, init); }
}

export class Meta
{
    public resourceCount?: number;
    public title?: string;

    public constructor(init?: Partial<Meta>) { (Object as any).assign(this, init); }
}

export class ResourceItemsLiteResponse implements IResourceItemsLiteResponse
{
    public resourceItems?: ResourceCard[];
    public meta?: Meta;

    public constructor(init?: Partial<ResourceItemsLiteResponse>) { (Object as any).assign(this, init); }
}

export class FavoritesRequest extends BasicResourceLibraryRequest
{
    /**
    * Set it to true if requesting saved resources only from digital library
    */
    // @ApiMember(Description="Set it to true if requesting saved resources only from digital library")
    public digitalFitness?: boolean;

    /**
    * Set it to true if requesting saved resources only from health library
    */
    // @ApiMember(Description="Set it to true if requesting saved resources only from health library")
    public healthLibrary?: boolean;

    /**
    * Set it to true if requesting saved resources only from vptr
    */
    // @ApiMember(Description="Set it to true if requesting saved resources only from vptr")
    public vptr?: boolean;

    /**
    * Set it to true if requesting saved resources only from wellbeing
    */
    // @ApiMember(Description="Set it to true if requesting saved resources only from wellbeing")
    public wellbeing?: boolean;

    /**
    * Set it to true if requesting saved resources only from health
    */
    // @ApiMember(Description="Set it to true if requesting saved resources only from health")
    public health?: boolean;

    public limit?: string;
    public offset?: string;

    public constructor(init?: Partial<FavoritesRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript FavoritesRequest DTOs

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>