Billiecart API

SearchAllContributionsRequest

**Requires Authentication**
Requires the role:	manager

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

namespace Application.Interfaces

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Contribution() = 
        member val EmployerId:String = null with get,set
        member val EmployerName:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val PaymentDate:DateTime = new DateTime() with get,set
        member val Distributed:Boolean = new Boolean() with get,set
        member val Id:String = null with get,set

    type SortDirection =
        | Ascending = 0
        | Descending = 1

    [<AllowNullLiteral>]
    type Sorting() = 
        member val By:String = null with get,set
        member val Direction:SortDirection = new SortDirection() with get,set

    [<AllowNullLiteral>]
    type Filtering() = 
        member val Fields:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Search:String = null with get,set

    [<AllowNullLiteral>]
    type SearchMetadata() = 
        member val Total:Int32 = new Int32() with get,set
        member val Limit:Int32 = new Int32() with get,set
        member val Offset:Int32 = new Int32() with get,set
        member val Sort:Sorting = null with get,set
        member val Filter:Filtering = null with get,set

    [<AllowNullLiteral>]
    type SearchAllContributionsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Contributions:ResizeArray<Contribution> = new ResizeArray<Contribution>() with get,set
        member val Metadata:SearchMetadata = null with get,set

    [<AllowNullLiteral>]
    type SearchAllContributionsRequest() = 
        inherit SearchOperationTenanted<SearchAllContributionsResponse>()

    [<AllowNullLiteral>]
    type SearchOperationTenanted<'TResponse>() = 
        inherit SearchOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type SearchOperationUnTenanted<'TResponse>() = 
        inherit GetOperationUnTenanted<TResponse>()
        member val Distinct:String = null with get,set
        member val Limit:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Offset:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Sort:String = null with get,set
        member val Filter:String = null with get,set
        member val Search:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationUnTenanted<'TResponse>() = 
        interface IGet
        member val Embed:String = null with get,set

F# SearchAllContributionsRequest DTOs

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 /contributions HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}