Requires the role: | manager |
GET | /employers/{Id} |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class GetEmployerRequest : GetOperationTenanted<GetEmployerResponse>()
{
var id:String? = null
}
open class GetOperationTenanted<TResponse> : GetOperationUnTenanted<TResponse>(), ITenantedRequest
{
var organisationId:String? = null
}
open class GetOperationUnTenanted<TResponse> : IHasGetOptions, IGet
{
var embed:String? = null
}
open class GetEmployerResponse
{
var responseStatus:ResponseStatus? = null
var employer:Employer? = null
}
open class Employer : IIdentifiableResource
{
var name:String? = null
var businessDetails:BusinessDetails? = null
var contact:Contact? = null
var postalAddress:Address? = null
var physicalAddress:Address? = null
var id:String? = null
}
open class BusinessDetails
{
var tradingName:String? = null
var australianBusinessNumber:String? = null
var australianCompanyNumber:String? = null
}
open class Contact
{
var contactName:String? = null
var email:String? = null
var phoneNumber:String? = null
var preferredContactMethod:String? = null
}
open class Address
{
var addressLine1:String? = null
var addressLine2:String? = null
var suburb:String? = null
var stateTerritory:String? = null
var postcode:String? = null
}
Kotlin GetEmployerRequest 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.
GET /employers/{Id} HTTP/1.1 Host: staging-api.billiecart.com.au Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetEmployerResponse 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> </GetEmployerResponse>