ASH.ResourceLibrary.WebApi

<back to all web services

ResourceItemProgressRequest

Requires Authentication
The following routes are available for this service:
PUT/resourceProgressUse to save progress of a resource.
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 ResourceItemProgressResponse:
    member_resource_progress_i_d: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourceItemProgressRequest:
    member_id: Optional[int] = None
    resource_id: Optional[str] = None
    percentage_completed: Optional[int] = None
    is_completed: Optional[bool] = None

Python ResourceItemProgressRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /resourceProgress HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ResourceItemProgressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <IsCompleted>false</IsCompleted>
  <MemberId>0</MemberId>
  <PercentageCompleted>0</PercentageCompleted>
  <ResourceId>String</ResourceId>
</ResourceItemProgressRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResourceItemProgressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <MemberResourceProgressID>0</MemberResourceProgressID>
</ResourceItemProgressResponse>