Requires the role: | manager |
PUT | /employers/{Id} |
---|
import Foundation
import ServiceStack
public class UpdateEmployerRequest : PutOperationTenanted<UpdateEmployerResponse>
{
public var id:String?
public var name:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case id
case name
}
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)
name = try container.decodeIfPresent(String.self, forKey: .name)
}
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 name != nil { try container.encode(name, forKey: .name) }
}
}
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 UpdateEmployerResponse : 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 UpdateEmployerRequest 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} HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"id":"String","name":"String","organisationId":"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"}}