Requires the role: | manager |
PUT | /employers/{Id}/business-details |
---|
import Foundation
import ServiceStack
public class SetBusinessDetailsRequest : GetOperationTenanted<SetBusinessDetailsResponse>
{
public var id:String?
public var tradingName:String?
public var australianBusinessNumber:String?
public var australianCompanyNumber:String?
public var contactName:String?
public var email:String?
public var phoneNumber:String?
public var preferredContactMethod:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case id
case tradingName
case australianBusinessNumber
case australianCompanyNumber
case contactName
case email
case phoneNumber
case preferredContactMethod
}
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)
tradingName = try container.decodeIfPresent(String.self, forKey: .tradingName)
australianBusinessNumber = try container.decodeIfPresent(String.self, forKey: .australianBusinessNumber)
australianCompanyNumber = try container.decodeIfPresent(String.self, forKey: .australianCompanyNumber)
contactName = try container.decodeIfPresent(String.self, forKey: .contactName)
email = try container.decodeIfPresent(String.self, forKey: .email)
phoneNumber = try container.decodeIfPresent(String.self, forKey: .phoneNumber)
preferredContactMethod = try container.decodeIfPresent(String.self, forKey: .preferredContactMethod)
}
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 tradingName != nil { try container.encode(tradingName, forKey: .tradingName) }
if australianBusinessNumber != nil { try container.encode(australianBusinessNumber, forKey: .australianBusinessNumber) }
if australianCompanyNumber != nil { try container.encode(australianCompanyNumber, forKey: .australianCompanyNumber) }
if contactName != nil { try container.encode(contactName, forKey: .contactName) }
if email != nil { try container.encode(email, forKey: .email) }
if phoneNumber != nil { try container.encode(phoneNumber, forKey: .phoneNumber) }
if preferredContactMethod != nil { try container.encode(preferredContactMethod, forKey: .preferredContactMethod) }
}
}
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 SetBusinessDetailsResponse : 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 SetBusinessDetailsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /employers/{Id}/business-details HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"id":"String","tradingName":"String","australianBusinessNumber":"String","australianCompanyNumber":"String","contactName":"String","email":"String","phoneNumber":"String","preferredContactMethod":"String","organisationId":"String","embed":"String"}
HTTP/1.1 200 OK Content-Type: text/csv 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"}}