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.
namespace ASH.ResourceLibrary.Interfaces.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ResourceItemCompletion() = 
        member val ResourceCompletionId:Int32 = new Int32() with get,set
        member val ResourceProgressId:Int32 = new Int32() with get,set
        member val ProgressOnCompletion:Int32 = new Int32() with get,set
        member val ResourceId:String = null with get,set
        member val ResourceName:String = null with get,set
        member val ResourceType:String = null with get,set
        member val CompletionDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type ResourceItemCompletionResponse() = 
        member val MemberId:Int32 = new Int32() with get,set
        member val StartDate:DateTime = new DateTime() with get,set
        member val EndDate:DateTime = new DateTime() with get,set
        member val TotalCompletions:Int32 = new Int32() with get,set
        member val RetrievalAmount:Int32 = new Int32() with get,set
        member val ResourceCompletions:ResizeArray<ResourceItemCompletion> = new ResizeArray<ResourceItemCompletion>() with get,set

    [<AllowNullLiteral>]
    type ResourceItemCompletionRequest() = 
        member val MemberId:Int32 = new Int32() with get,set
        member val StartDate:DateTime = new DateTime() with get,set
        member val EndDate:DateTime = new DateTime() with get,set
        member val ResourceType:String = null with get,set
        member val RetrievalAmount:Nullable<Int32> = new Nullable<Int32>() with get,set

F# ResourceItemCompletionRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}