Billiecart API

<back to all web services

GetEmployerRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
	}
}