Billiecart API

SetPostalAddressRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT	/employers/{Id}/postal-address

import Foundation
import ServiceStack

public class SetPostalAddressRequest : GetOperationTenanted<SetPostalAddressResponse>
{
    public var id:String?
    public var addressLine1:String?
    public var addressLine2:String?
    public var suburb:String?
    public var stateTerritory:String?
    public var postcode:String?

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

    private enum CodingKeys : String, CodingKey {
        case id
        case addressLine1
        case addressLine2
        case suburb
        case stateTerritory
        case postcode
    }

    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)
        addressLine1 = try container.decodeIfPresent(String.self, forKey: .addressLine1)
        addressLine2 = try container.decodeIfPresent(String.self, forKey: .addressLine2)
        suburb = try container.decodeIfPresent(String.self, forKey: .suburb)
        stateTerritory = try container.decodeIfPresent(String.self, forKey: .stateTerritory)
        postcode = try container.decodeIfPresent(String.self, forKey: .postcode)
    }

    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 addressLine1 != nil { try container.encode(addressLine1, forKey: .addressLine1) }
        if addressLine2 != nil { try container.encode(addressLine2, forKey: .addressLine2) }
        if suburb != nil { try container.encode(suburb, forKey: .suburb) }
        if stateTerritory != nil { try container.encode(stateTerritory, forKey: .stateTerritory) }
        if postcode != nil { try container.encode(postcode, forKey: .postcode) }
    }
}

public class GetOperationTenanted<TResponse : Codable> : GetOperationUnTenanted<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 GetOperationUnTenanted<TResponse : Codable> : IHasGetOptions, IGet, Codable
{
    public var embed:String?

    required public init(){}
}

public class SetPostalAddressResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var employer:Employer?

    required public init(){}
}

public class Employer : IIdentifiableResource, Codable
{
    public var name:String?
    public var businessDetails:BusinessDetails?
    public var contact:Contact?
    public var postalAddress:Address?
    public var physicalAddress:Address?
    public var id:String?

    required public init(){}
}

public class BusinessDetails : Codable
{
    public var tradingName:String?
    public var australianBusinessNumber:String?
    public var australianCompanyNumber:String?

    required public init(){}
}

public class Contact : Codable
{
    public var contactName:String?
    public var email:String?
    public var phoneNumber:String?
    public var preferredContactMethod:String?

    required public init(){}
}

public class Address : Codable
{
    public var addressLine1:String?
    public var addressLine2:String?
    public var suburb:String?
    public var stateTerritory:String?
    public var postcode:String?

    required public init(){}
}

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

PUT /employers/{Id}/postal-address HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","addressLine1":"String","addressLine2":"String","suburb":"String","stateTerritory":"String","postcode":"String","organisationId":"String","embed":"String"}

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"}},"employer":{"name":"String","businessDetails":{"tradingName":"String","australianBusinessNumber":"String","australianCompanyNumber":"String"},"contact":{"contactName":"String","email":"String","phoneNumber":"String","preferredContactMethod":"String"},"postalAddress":{"addressLine1":"String","addressLine2":"String","suburb":"String","stateTerritory":"String","postcode":"String"},"physicalAddress":{"addressLine1":"String","addressLine2":"String","suburb":"String","stateTerritory":"String","postcode":"String"},"id":"String"}}