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.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ASH.ResourceLibrary.Interfaces.ServiceModels
Imports ASH.ResourceLibrary.Interfaces.Models

Namespace Global

    Namespace ASH.ResourceLibrary.Interfaces.Models

        Public Partial Class ResourceItemCompletion
            Public Overridable Property ResourceCompletionId As Integer
            Public Overridable Property ResourceProgressId As Integer
            Public Overridable Property ProgressOnCompletion As Integer
            Public Overridable Property ResourceId As String
            Public Overridable Property ResourceName As String
            Public Overridable Property ResourceType As String
            Public Overridable Property CompletionDate As Date
        End Class
    End Namespace

    Namespace ASH.ResourceLibrary.Interfaces.ServiceModels

        Public Partial Class ResourceItemCompletionRequest
            Public Overridable Property MemberId As Integer
            Public Overridable Property StartDate As Date
            Public Overridable Property EndDate As Date
            Public Overridable Property ResourceType As String
            Public Overridable Property RetrievalAmount As Nullable(Of Integer)
        End Class

        Public Partial Class ResourceItemCompletionResponse
            Public Sub New()
                ResourceCompletions = New List(Of ResourceItemCompletion)
            End Sub

            Public Overridable Property MemberId As Integer
            Public Overridable Property StartDate As Date
            Public Overridable Property EndDate As Date
            Public Overridable Property TotalCompletions As Integer
            Public Overridable Property RetrievalAmount As Integer
            Public Overridable Property ResourceCompletions As List(Of ResourceItemCompletion)
        End Class
    End Namespace
End Namespace

VB.NET ResourceItemCompletionRequest 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.

GET /memberResourceCompletions/{MemberId}/{StartDate}/{EndDate} HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResourceItemCompletionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.ServiceModels">
  <EndDate>0001-01-01T00:00:00</EndDate>
  <MemberId>0</MemberId>
  <ResourceCompletions xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASH.ResourceLibrary.Interfaces.Models">
    <d2p1:ResourceItemCompletion>
      <d2p1:CompletionDate>0001-01-01T00:00:00</d2p1:CompletionDate>
      <d2p1:ProgressOnCompletion>0</d2p1:ProgressOnCompletion>
      <d2p1:ResourceCompletionId>0</d2p1:ResourceCompletionId>
      <d2p1:ResourceId>String</d2p1:ResourceId>
      <d2p1:ResourceName>String</d2p1:ResourceName>
      <d2p1:ResourceProgressId>0</d2p1:ResourceProgressId>
      <d2p1:ResourceType>String</d2p1:ResourceType>
    </d2p1:ResourceItemCompletion>
  </ResourceCompletions>
  <RetrievalAmount>0</RetrievalAmount>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <TotalCompletions>0</TotalCompletions>
</ResourceItemCompletionResponse>