ASH.ResourceLibrary.WebApi

<back to all web services

ResourceItemProgressRequest

Requires Authentication
The following routes are available for this service:
PUT/resourceProgressUse to save progress of a resource.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class ResourceItemProgressRequest
    {
        public Integer memberId = null;
        public String resourceId = null;
        public Integer percentageCompleted = null;
        public Boolean isCompleted = null;
        
        public Integer getMemberId() { return memberId; }
        public ResourceItemProgressRequest setMemberId(Integer value) { this.memberId = value; return this; }
        public String getResourceId() { return resourceId; }
        public ResourceItemProgressRequest setResourceId(String value) { this.resourceId = value; return this; }
        public Integer getPercentageCompleted() { return percentageCompleted; }
        public ResourceItemProgressRequest setPercentageCompleted(Integer value) { this.percentageCompleted = value; return this; }
        public Boolean getIsCompleted() { return isCompleted; }
        public ResourceItemProgressRequest setIsCompleted(Boolean value) { this.isCompleted = value; return this; }
    }

    public static class ResourceItemProgressResponse
    {
        public Integer memberResourceProgressID = null;
        
        public Integer getMemberResourceProgressID() { return memberResourceProgressID; }
        public ResourceItemProgressResponse setMemberResourceProgressID(Integer value) { this.memberResourceProgressID = value; return this; }
    }

}

Java ResourceItemProgressRequest DTOs

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

HTTP + XML

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

PUT /resourceProgress HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ResourceItemProgressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <IsCompleted>false</IsCompleted>
  <MemberId>0</MemberId>
  <PercentageCompleted>0</PercentageCompleted>
  <ResourceId>String</ResourceId>
</ResourceItemProgressRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResourceItemProgressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <MemberResourceProgressID>0</MemberResourceProgressID>
</ResourceItemProgressResponse>