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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class ResourceItemCompletionRequest
    {
        public Integer memberId = null;
        public Date startDate = null;
        public Date endDate = null;
        public String resourceType = null;
        public Integer retrievalAmount = null;
        
        public Integer getMemberId() { return memberId; }
        public ResourceItemCompletionRequest setMemberId(Integer value) { this.memberId = value; return this; }
        public Date getStartDate() { return startDate; }
        public ResourceItemCompletionRequest setStartDate(Date value) { this.startDate = value; return this; }
        public Date getEndDate() { return endDate; }
        public ResourceItemCompletionRequest setEndDate(Date value) { this.endDate = value; return this; }
        public String getResourceType() { return resourceType; }
        public ResourceItemCompletionRequest setResourceType(String value) { this.resourceType = value; return this; }
        public Integer getRetrievalAmount() { return retrievalAmount; }
        public ResourceItemCompletionRequest setRetrievalAmount(Integer value) { this.retrievalAmount = value; return this; }
    }

    public static class ResourceItemCompletionResponse
    {
        public Integer memberId = null;
        public Date startDate = null;
        public Date endDate = null;
        public Integer totalCompletions = null;
        public Integer retrievalAmount = null;
        public ArrayList<ResourceItemCompletion> resourceCompletions = null;
        
        public Integer getMemberId() { return memberId; }
        public ResourceItemCompletionResponse setMemberId(Integer value) { this.memberId = value; return this; }
        public Date getStartDate() { return startDate; }
        public ResourceItemCompletionResponse setStartDate(Date value) { this.startDate = value; return this; }
        public Date getEndDate() { return endDate; }
        public ResourceItemCompletionResponse setEndDate(Date value) { this.endDate = value; return this; }
        public Integer getTotalCompletions() { return totalCompletions; }
        public ResourceItemCompletionResponse setTotalCompletions(Integer value) { this.totalCompletions = value; return this; }
        public Integer getRetrievalAmount() { return retrievalAmount; }
        public ResourceItemCompletionResponse setRetrievalAmount(Integer value) { this.retrievalAmount = value; return this; }
        public ArrayList<ResourceItemCompletion> getResourceCompletions() { return resourceCompletions; }
        public ResourceItemCompletionResponse setResourceCompletions(ArrayList<ResourceItemCompletion> value) { this.resourceCompletions = value; return this; }
    }

    public static class ResourceItemCompletion
    {
        public Integer resourceCompletionId = null;
        public Integer resourceProgressId = null;
        public Integer progressOnCompletion = null;
        public String resourceId = null;
        public String resourceName = null;
        public String resourceType = null;
        public Date completionDate = null;
        
        public Integer getResourceCompletionId() { return resourceCompletionId; }
        public ResourceItemCompletion setResourceCompletionId(Integer value) { this.resourceCompletionId = value; return this; }
        public Integer getResourceProgressId() { return resourceProgressId; }
        public ResourceItemCompletion setResourceProgressId(Integer value) { this.resourceProgressId = value; return this; }
        public Integer getProgressOnCompletion() { return progressOnCompletion; }
        public ResourceItemCompletion setProgressOnCompletion(Integer value) { this.progressOnCompletion = value; return this; }
        public String getResourceId() { return resourceId; }
        public ResourceItemCompletion setResourceId(String value) { this.resourceId = value; return this; }
        public String getResourceName() { return resourceName; }
        public ResourceItemCompletion setResourceName(String value) { this.resourceName = value; return this; }
        public String getResourceType() { return resourceType; }
        public ResourceItemCompletion setResourceType(String value) { this.resourceType = value; return this; }
        public Date getCompletionDate() { return completionDate; }
        public ResourceItemCompletion setCompletionDate(Date value) { this.completionDate = value; return this; }
    }

}

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