TBS Apps API

<back to all web services

HarmonyAddressRequest

The following routes are available for this service:
POST/HarmonyAddressGets a list of addresses by calling Harmony Address API.Gets a promotion specific to the currently authenticated user
HarmonyAddressRequest Parameters:
NameParameterData TypeRequiredDescription
fullAddressbodystringNo
HarmonyAddressResponse Parameters:
NameParameterData TypeRequiredDescription
statusformstringNo
messagesformList<string>No
payloadformList<HarmonyAddressAU>No
HarmonyAddressAU Parameters:
NameParameterData TypeRequiredDescription
fullAddressformstringNo
postcodeformstringNo
street2formstringNo
streetformstringNo
streetNumberformstringNo
postalformstringNo
postalTypeformstringNo
postalNumberformstringNo
buildingNameformstringNo
subdwellingformstringNo
eidformstringNo
lotNumberformstringNo
flatUnitNumberformstringNo
flatUnitTypeformstringNo
floorLevelNumberformstringNo
floorLevelTypeformstringNo
streetSuffixformstringNo
streetTypeformstringNo
streetNameformstringNo
attributesformDictionary<string, string>No
idformstringNo
stateformstringNo
localityformstringNo

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.

POST /HarmonyAddress HTTP/1.1 
Host: tstextweb20.np.bluebet.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	fullAddress: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	status: String,
	messages: 
	[
		String
	],
	payload: 
	[
		{
			fullAddress: String,
			postcode: String,
			street2: String,
			street: String,
			streetNumber: String,
			postal: String,
			postalType: String,
			postalNumber: String,
			buildingName: String,
			subdwelling: String,
			eid: String,
			lotNumber: String,
			flatUnitNumber: String,
			flatUnitType: String,
			floorLevelNumber: String,
			floorLevelType: String,
			streetSuffix: String,
			streetType: String,
			streetName: String,
			attributes: 
			{
				String: String
			},
			id: String,
			state: String,
			locality: String
		}
	]
}