Billiecart API

<back to all web services

SetCustomerBankAccountRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
PUT/customers/{Id}/bank-account
import Foundation
import ServiceStack

public class SetCustomerBankAccountRequest : PutOperationTenanted<SetCustomerBankAccountResponse>
{
    public var id:String?
    public var bankAccountNumber:String?
    public var bankAccountBsbNumber:String?

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

    private enum CodingKeys : String, CodingKey {
        case id
        case bankAccountNumber
        case bankAccountBsbNumber
    }

    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)
        bankAccountNumber = try container.decodeIfPresent(String.self, forKey: .bankAccountNumber)
        bankAccountBsbNumber = try container.decodeIfPresent(String.self, forKey: .bankAccountBsbNumber)
    }

    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 bankAccountNumber != nil { try container.encode(bankAccountNumber, forKey: .bankAccountNumber) }
        if bankAccountBsbNumber != nil { try container.encode(bankAccountBsbNumber, forKey: .bankAccountBsbNumber) }
    }
}

public class PutOperationTenanted<TResponse : Codable> : PutOperationUnTenanted<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 PutOperationUnTenanted<TResponse : Codable> : IPut, Codable
{
    required public init(){}
}

public class SetCustomerBankAccountResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var customer:Customer?

    required public init(){}
}

public class Customer : IIdentifiableResource, Codable
{
    public var id:String?
    public var firstName:String?
    public var lastName:String?
    public var dateOfBirth:Date?
    public var driversLicenceNo:String?
    public var email:String?
    public var phone:String?
    public var preferredContactMethod:String?
    public var addressLine1:String?
    public var addressLine2:String?
    public var suburb:String?
    public var stateTerritory:String?
    public var postcode:String?
    public var bankAccount:BankAccount?
    public var userAccountId:String?

    required public init(){}
}

public class BankAccount : Codable
{
    public var bsbNumber:String?
    public var accountNumber:String?

    required public init(){}
}


Swift SetCustomerBankAccountRequest 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.

PUT /customers/{Id}/bank-account HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SetCustomerBankAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Customers">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <BankAccountBsbNumber>String</BankAccountBsbNumber>
  <BankAccountNumber>String</BankAccountNumber>
  <Id>String</Id>
</SetCustomerBankAccountRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SetCustomerBankAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Customers">
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:AddressLine1>String</d2p1:AddressLine1>
    <d2p1:AddressLine2>String</d2p1:AddressLine2>
    <d2p1:BankAccount>
      <d2p1:AccountNumber>String</d2p1:AccountNumber>
      <d2p1:BsbNumber>String</d2p1:BsbNumber>
    </d2p1:BankAccount>
    <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
    <d2p1:DriversLicenceNo>String</d2p1:DriversLicenceNo>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:Phone>String</d2p1:Phone>
    <d2p1:Postcode>String</d2p1:Postcode>
    <d2p1:PreferredContactMethod>String</d2p1:PreferredContactMethod>
    <d2p1:StateTerritory>String</d2p1:StateTerritory>
    <d2p1:Suburb>String</d2p1:Suburb>
    <d2p1:UserAccountId>String</d2p1:UserAccountId>
  </Customer>
  <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>
</SetCustomerBankAccountResponse>