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 Foundation
import ServiceStack

public class ResourceItemCompletionRequest : Codable
{
    public var memberId:Int?
    public var startDate:Date?
    public var endDate:Date?
    public var resourceType:String?
    public var retrievalAmount:Int?

    required public init(){}
}

public class ResourceItemCompletionResponse : Codable
{
    public var memberId:Int?
    public var startDate:Date?
    public var endDate:Date?
    public var totalCompletions:Int?
    public var retrievalAmount:Int?
    public var resourceCompletions:[ResourceItemCompletion] = []

    required public init(){}
}

public class ResourceItemCompletion : Codable
{
    public var resourceCompletionId:Int?
    public var resourceProgressId:Int?
    public var progressOnCompletion:Int?
    public var resourceId:String?
    public var resourceName:String?
    public var resourceType:String?
    public var completionDate:Date?

    required public init(){}
}


Swift 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"}]}