Billiecart API

<back to all web services

CreateContributionRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/contributions
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Contributions
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces.Resources

        Public Partial Class Contribution
            Implements IIdentifiableResource
            Public Overridable Property EmployerId As String
            Public Overridable Property EmployerName As String
            Public Overridable Property Amount As Decimal
            Public Overridable Property PaymentDate As Date
            Public Overridable Property Distributed As Boolean
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class PostOperationTenanted(Of TResponse)
            Inherits PostOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class PostOperationUnTenanted(Of TResponse)
            Implements IPost
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Contributions

        Public Partial Class CreateContributionRequest
            Inherits PostOperationTenanted(Of CreateContributionResponse)
            Public Overridable Property Amount As Nullable(Of Decimal)
            Public Overridable Property PaymentDate As Date
            Public Overridable Property EmployerId As String
        End Class

        Public Partial Class CreateContributionResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Contribution As Contribution
        End Class
    End Namespace
End Namespace

VB.NET CreateContributionRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	amount: 0,
	employerId: String,
	organisationId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
	}
}