Billiecart API

CreateContributionRequest

**Requires Authentication**
Requires the role:	manager

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

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CreateContributionRequest extends PostOperationTenanted<CreateContributionResponse>
    {
        public BigDecimal amount = null;
        public Date paymentDate = null;
        public String employerId = null;
        
        public BigDecimal getAmount() { return amount; }
        public CreateContributionRequest setAmount(BigDecimal value) { this.amount = value; return this; }
        public Date getPaymentDate() { return paymentDate; }
        public CreateContributionRequest setPaymentDate(Date value) { this.paymentDate = value; return this; }
        public String getEmployerId() { return employerId; }
        public CreateContributionRequest setEmployerId(String value) { this.employerId = value; return this; }
    }

    public static class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public PostOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class PostOperationUnTenanted<TResponse> implements IPost
    {
        
    }

    public static class CreateContributionResponse
    {
        public ResponseStatus responseStatus = null;
        public Contribution contribution = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CreateContributionResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Contribution getContribution() { return contribution; }
        public CreateContributionResponse setContribution(Contribution value) { this.contribution = value; return this; }
    }

    public static class Contribution implements IIdentifiableResource
    {
        public String employerId = null;
        public String employerName = null;
        public BigDecimal amount = null;
        public Date paymentDate = null;
        public Boolean distributed = null;
        public String id = null;
        
        public String getEmployerId() { return employerId; }
        public Contribution setEmployerId(String value) { this.employerId = value; return this; }
        public String getEmployerName() { return employerName; }
        public Contribution setEmployerName(String value) { this.employerName = value; return this; }
        public BigDecimal getAmount() { return amount; }
        public Contribution setAmount(BigDecimal value) { this.amount = value; return this; }
        public Date getPaymentDate() { return paymentDate; }
        public Contribution setPaymentDate(Date value) { this.paymentDate = value; return this; }
        public Boolean isDistributed() { return distributed; }
        public Contribution setDistributed(Boolean value) { this.distributed = value; return this; }
        public String getId() { return id; }
        public Contribution setId(String value) { this.id = value; return this; }
    }

}

Java CreateContributionRequest 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.

POST /contributions HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateContributionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Contributions">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <Amount>0</Amount>
  <EmployerId>String</EmployerId>
  <PaymentDate>0001-01-01T00:00:00</PaymentDate>
</CreateContributionRequest>

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

<CreateContributionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Contributions">
  <Contribution xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Amount>0</d2p1:Amount>
    <d2p1:Distributed>false</d2p1:Distributed>
    <d2p1:EmployerId>String</d2p1:EmployerId>
    <d2p1:EmployerName>String</d2p1:EmployerName>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:PaymentDate>0001-01-01T00:00:00</d2p1:PaymentDate>
  </Contribution>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CreateContributionResponse>