Billiecart API

SearchAllContributionsRequest

**Requires Authentication**
Requires the role:	manager

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

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

namespace Application.Interfaces
{
    public partial class Filtering
    {
        public Filtering()
        {
            Fields = new List<string>{};
        }

        public virtual List<string> Fields { get; set; }
        public virtual string Search { get; set; }
    }

    public partial class SearchMetadata
    {
        public virtual int Total { get; set; }
        public virtual int Limit { get; set; }
        public virtual int Offset { get; set; }
        public virtual Sorting Sort { get; set; }
        public virtual Filtering Filter { get; set; }
    }

    public enum SortDirection
    {
        Ascending,
        Descending,
    }

    public partial class Sorting
    {
        public virtual string By { get; set; }
        public virtual SortDirection Direction { get; set; }
    }

}

namespace Application.Interfaces.Resources
{
    public partial class Contribution
        : IIdentifiableResource
    {
        public virtual string EmployerId { get; set; }
        public virtual string EmployerName { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual DateTime PaymentDate { get; set; }
        public virtual bool Distributed { get; set; }
        public virtual string Id { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class GetOperationUnTenanted<TResponse>
        : IHasGetOptions, IGet
    {
        public virtual string Embed { get; set; }
    }

    public partial class SearchOperationTenanted<TResponse>
        : SearchOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class SearchOperationUnTenanted<TResponse>
        : GetOperationUnTenanted<TResponse>, IHasSearchOptions
    {
        public virtual string Distinct { get; set; }
        public virtual int? Limit { get; set; }
        public virtual int? Offset { get; set; }
        public virtual string Sort { get; set; }
        public virtual string Filter { get; set; }
        public virtual string Search { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Contributions
{
    public partial class SearchAllContributionsRequest
        : SearchOperationTenanted<SearchAllContributionsResponse>
    {
    }

    public partial class SearchAllContributionsResponse
    {
        public SearchAllContributionsResponse()
        {
            Contributions = new List<Contribution>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<Contribution> Contributions { get; set; }
        public virtual SearchMetadata Metadata { get; set; }
    }

}

C# 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"}}}