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.
ResourceItemCompletionRequest Parameters:
NameParameterData TypeRequiredDescription
MemberIdpathintNo
StartDatepathDateTimeNo
EndDatepathDateTimeNo
ResourceTypepathstringNo
RetrievalAmountpathint?No
ResourceItemCompletionResponse Parameters:
NameParameterData TypeRequiredDescription
MemberIdformintNo
StartDateformDateTimeNo
EndDateformDateTimeNo
TotalCompletionsformintNo
RetrievalAmountformintNo
ResourceCompletionsformList<ResourceItemCompletion>No
ResourceItemCompletion Parameters:
NameParameterData TypeRequiredDescription
ResourceCompletionIdformintNo
ResourceProgressIdformintNo
ProgressOnCompletionformintNo
ResourceIdformstringNo
ResourceNameformstringNo
ResourceTypeformstringNo
CompletionDateformDateTimeNo

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