Billiecart API

SearchAllContributionsRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
GET	/contributions

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Contributions
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces.Resources
Imports Application.Interfaces

Namespace Global

    Namespace Application.Interfaces

        Public Partial Class Filtering
            Public Sub New()
                Fields = New List(Of String)
            End Sub

            Public Overridable Property Fields As List(Of String)
            Public Overridable Property Search As String
        End Class

        Public Partial Class SearchMetadata
            Public Overridable Property Total As Integer
            Public Overridable Property Limit As Integer
            Public Overridable Property Offset As Integer
            Public Overridable Property Sort As Sorting
            Public Overridable Property Filter As Filtering
        End Class

        Public Enum SortDirection
            Ascending
            Descending
        End Enum

        Public Partial Class Sorting
            Public Overridable Property By As String
            Public Overridable Property Direction As SortDirection
        End Class
    End Namespace

    Namespace Application.Interfaces.Resources

        Public Partial Class Contribution
            Implements IIdentifiableResource
            Public Overridable Property EmployerId As String
            Public Overridable Property EmployerName As String
            Public Overridable Property Amount As Decimal
            Public Overridable Property PaymentDate As Date
            Public Overridable Property Distributed As Boolean
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class GetOperationUnTenanted(Of TResponse)
            Implements IHasGetOptions
            Implements IGet
            Public Overridable Property Embed As String
        End Class

        Public Partial Class SearchOperationTenanted(Of TResponse)
            Inherits SearchOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class SearchOperationUnTenanted(Of TResponse)
            Inherits GetOperationUnTenanted(Of TResponse)
            Implements IHasSearchOptions
            Public Overridable Property Distinct As String
            Public Overridable Property Limit As Nullable(Of Integer)
            Public Overridable Property Offset As Nullable(Of Integer)
            Public Overridable Property Sort As String
            Public Overridable Property Filter As String
            Public Overridable Property Search As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Contributions

        Public Partial Class SearchAllContributionsRequest
            Inherits SearchOperationTenanted(Of SearchAllContributionsResponse)
        End Class

        Public Partial Class SearchAllContributionsResponse
            Public Sub New()
                Contributions = New List(Of Contribution)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Contributions As List(Of Contribution)
            Public Overridable Property Metadata As SearchMetadata
        End Class
    End Namespace
End Namespace

VB.NET SearchAllContributionsRequest 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 /contributions HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"contributions":[{"employerId":"String","employerName":"String","amount":0,"distributed":false,"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}