Requires the role: | manager |
POST | /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;
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 PostOperationTenanted<TResponse>
: PostOperationUnTenanted<TResponse>, ITenantedRequest
{
public virtual string OrganisationId { get; set; }
}
public partial class PostOperationUnTenanted<TResponse>
: IPost
{
}
}
namespace Infrastructure.Api.Interfaces.ServiceOperations.Contributions
{
public partial class CreateContributionRequest
: PostOperationTenanted<CreateContributionResponse>
{
public virtual decimal? Amount { get; set; }
public virtual DateTime PaymentDate { get; set; }
public virtual string EmployerId { get; set; }
}
public partial class CreateContributionResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual Contribution Contribution { get; set; }
}
}
C# CreateContributionRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>