ASH.ResourceLibrary.WebApi

<back to all web services

ResourceItemCompletionRequest

Requires Authentication
The following routes are available for this service:
GET/memberResourceCompletions/{MemberId}/{StartDate}/{EndDate}Retrieves all completion records of all types for the member and the given date range.
GET/memberResourceCompletions/{MemberId}/{StartDate}/{EndDate}/{ResourceType}Retrieves all completion records for the specified type and date range of the member.
GET/memberResourceCompletions/{MemberId}/{StartDate}/{EndDate}/{ResourceType}/{RetrievalAmount}Retrieves member completions based on date range and resource type. If no resource type is specified it will return all completions.
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 ResourceItemCompletion:
    resource_completion_id: Optional[int] = None
    resource_progress_id: Optional[int] = None
    progress_on_completion: Optional[int] = None
    resource_id: Optional[str] = None
    resource_name: Optional[str] = None
    resource_type: Optional[str] = None
    completion_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourceItemCompletionResponse:
    member_id: Optional[int] = None
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    total_completions: Optional[int] = None
    retrieval_amount: Optional[int] = None
    resource_completions: Optional[List[ResourceItemCompletion]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourceItemCompletionRequest:
    member_id: Optional[int] = None
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    resource_type: Optional[str] = None
    retrieval_amount: Optional[int] = None

Python ResourceItemCompletionRequest DTOs

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

HTTP + CSV

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

GET /memberResourceCompletions/{MemberId}/{StartDate}/{EndDate} HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"memberId":0,"startDate":"0001-01-01T00:00:00.0000000","endDate":"0001-01-01T00:00:00.0000000","totalCompletions":0,"retrievalAmount":0,"resourceCompletions":[{"resourceCompletionId":0,"resourceProgressId":0,"progressOnCompletion":0,"resourceId":"String","resourceName":"String","resourceType":"String","completionDate":"0001-01-01T00:00:00.0000000"}]}