Billiecart API

<back to all web services

DistributeContributionRequest

import Foundation
import ServiceStack

public class DistributeContributionRequest : PostOperationTenanted<DistributeContributionResponse>
{
    public var id:String?
    public var salaryPackages:[ContributionSalaryPackage] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case salaryPackages
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(String.self, forKey: .id)
        salaryPackages = try container.decodeIfPresent([ContributionSalaryPackage].self, forKey: .salaryPackages) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if salaryPackages.count > 0 { try container.encode(salaryPackages, forKey: .salaryPackages) }
    }
}

public class PostOperationTenanted<TResponse : Codable> : PostOperationUnTenanted<TResponse>, ITenantedRequest
{
    public var organisationId:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case organisationId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        organisationId = try container.decodeIfPresent(String.self, forKey: .organisationId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if organisationId != nil { try container.encode(organisationId, forKey: .organisationId) }
    }
}

public class PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
    required public init(){}
}

public class DistributeContributionResponse : Codable
{
    public var responseStatus:ResponseStatus?

    required public init(){}
}

public class ContributionSalaryPackage : IIdentifiableResource, Codable
{
    public var preTaxDeduction:Double?
    public var postTaxDeduction:Double?
    public var salarySacrificeBreakdown:SalarySacrificeBreakdown?
    public var id:String?

    required public init(){}
}

public class SalarySacrificeBreakdown : Codable
{
    public var leaseAmount:Double?
    public var administrationFee:Double?
    public var fuel:Double?
    public var servicing:Double?
    public var tyres:Double?
    public var insurance:Double?
    public var carWash:Double?
    public var registration:Double?
    public var roadSideAssistance:Double?
    public var anythingExtra:Double?

    required public init(){}
}

Swift DistributeContributionRequest DTOs

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

<DistributeContributionRequest 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>
  <Id>String</Id>
  <SalaryPackages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:ContributionSalaryPackage>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:PostTaxDeduction>0</d2p1:PostTaxDeduction>
      <d2p1:PreTaxDeduction>0</d2p1:PreTaxDeduction>
      <d2p1:SalarySacrificeBreakdown>
        <d2p1:AdministrationFee>0</d2p1:AdministrationFee>
        <d2p1:AnythingExtra>0</d2p1:AnythingExtra>
        <d2p1:CarWash>0</d2p1:CarWash>
        <d2p1:Fuel>0</d2p1:Fuel>
        <d2p1:Insurance>0</d2p1:Insurance>
        <d2p1:LeaseAmount>0</d2p1:LeaseAmount>
        <d2p1:Registration>0</d2p1:Registration>
        <d2p1:RoadSideAssistance>0</d2p1:RoadSideAssistance>
        <d2p1:Servicing>0</d2p1:Servicing>
        <d2p1:Tyres>0</d2p1:Tyres>
      </d2p1:SalarySacrificeBreakdown>
    </d2p1:ContributionSalaryPackage>
  </SalaryPackages>
</DistributeContributionRequest>

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

<DistributeContributionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Contributions">
  <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>
</DistributeContributionResponse>