Billiecart API

<back to all web services

SetPhysicalAddressRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
PUT/employers/{Id}/physical-address
import java.math.*
import java.util.*
import net.servicestack.client.*


open class SetPhysicalAddressRequest : GetOperationTenanted<SetPhysicalAddressResponse>()
{
    var id:String? = null
    var addressLine1:String? = null
    var addressLine2:String? = null
    var suburb:String? = null
    var stateTerritory:String? = null
    var postcode: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 SetPhysicalAddressResponse
{
    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 SetPhysicalAddressRequest 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}/physical-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"}}