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
SetPhysicalAddressRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
AddressLine1bodystringNo
AddressLine2bodystringNo
SuburbbodystringNo
StateTerritorybodystringNo
PostcodebodystringNo
GetOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
SetPhysicalAddressResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
EmployerformEmployerNo
Employer Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
BusinessDetailsformBusinessDetailsNo
ContactformContactNo
PostalAddressformAddressNo
PhysicalAddressformAddressNo
IdformstringNo
BusinessDetails Parameters:
NameParameterData TypeRequiredDescription
TradingNameformstringNo
AustralianBusinessNumberformstringNo
AustralianCompanyNumberformstringNo
Contact Parameters:
NameParameterData TypeRequiredDescription
ContactNameformstringNo
EmailformstringNo
PhoneNumberformstringNo
PreferredContactMethodformstringNo
Address Parameters:
NameParameterData TypeRequiredDescription
AddressLine1formstringNo
AddressLine2formstringNo
SuburbformstringNo
StateTerritoryformstringNo
PostcodeformstringNo
SetPhysicalAddressResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
EmployerformEmployerNo

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.

PUT /employers/{Id}/physical-address HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
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: 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
	}
}