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}
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Contribution() = 
        member val EmployerId:String = null with get,set
        member val EmployerName:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val PaymentDate:DateTime = new DateTime() with get,set
        member val Distributed:Boolean = new Boolean() with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type GetContributionResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Contribution:Contribution = null with get,set

    [<AllowNullLiteral>]
    type GetContributionRequest() = 
        inherit GetOperationTenanted<GetContributionResponse>()
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationTenanted<'TResponse>() = 
        inherit GetOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type GetOperationUnTenanted<'TResponse>() = 
        interface IGet
        member val Embed:String = null with get,set

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