Billiecart API

<back to all web services

GetContributionRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
GET/contributions/{Id}
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;

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 GetOperationTenanted<TResponse>
        : GetOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class GetOperationUnTenanted<TResponse>
        : IHasGetOptions, IGet
    {
        public virtual string Embed { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Contributions
{
    public partial class GetContributionRequest
        : GetOperationTenanted<GetContributionResponse>
    {
        public virtual string Id { get; set; }
    }

    public partial class GetContributionResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual Contribution Contribution { get; set; }
    }

}

C# GetContributionRequest 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/{Id} 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"}},"contribution":{"employerId":"String","employerName":"String","amount":0,"distributed":false,"id":"String"}}