| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<SetBusinessDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Employers">
<Embed xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</Embed>
<OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
<AustralianBusinessNumber>String</AustralianBusinessNumber>
<AustralianCompanyNumber>String</AustralianCompanyNumber>
<ContactName>String</ContactName>
<Email>String</Email>
<Id>String</Id>
<PhoneNumber>String</PhoneNumber>
<PreferredContactMethod>String</PreferredContactMethod>
<TradingName>String</TradingName>
</SetBusinessDetailsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SetBusinessDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Employers">
<Employer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
<d2p1:BusinessDetails>
<d2p1:AustralianBusinessNumber>String</d2p1:AustralianBusinessNumber>
<d2p1:AustralianCompanyNumber>String</d2p1:AustralianCompanyNumber>
<d2p1:TradingName>String</d2p1:TradingName>
</d2p1:BusinessDetails>
<d2p1:Contact>
<d2p1:ContactName>String</d2p1:ContactName>
<d2p1:Email>String</d2p1:Email>
<d2p1:PhoneNumber>String</d2p1:PhoneNumber>
<d2p1:PreferredContactMethod>String</d2p1:PreferredContactMethod>
</d2p1:Contact>
<d2p1:Id>String</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
<d2p1:PhysicalAddress>
<d2p1:AddressLine1>String</d2p1:AddressLine1>
<d2p1:AddressLine2>String</d2p1:AddressLine2>
<d2p1:Postcode>String</d2p1:Postcode>
<d2p1:StateTerritory>String</d2p1:StateTerritory>
<d2p1:Suburb>String</d2p1:Suburb>
</d2p1:PhysicalAddress>
<d2p1:PostalAddress>
<d2p1:AddressLine1>String</d2p1:AddressLine1>
<d2p1:AddressLine2>String</d2p1:AddressLine2>
<d2p1:Postcode>String</d2p1:Postcode>
<d2p1:StateTerritory>String</d2p1:StateTerritory>
<d2p1:Suburb>String</d2p1:Suburb>
</d2p1:PostalAddress>
</Employer>
<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>
</SetBusinessDetailsResponse>