Get org address

Overview

This API call is used to get an address to an organisation object in the system.

HTTP Request

GET /api/5/orgaddresses/<ADDRESSID>

URL Parameters

HTTP Response

Success

HTTP response 200

Error

See API Error messages

Example

GET http://example.com/context/api/5/orgaddresses/3

XML format

<address>
	<addressid>12</addressid>
	<orgid>12</orgid>
	<street1>55 King willian street</street1>
	<additional>2nd floor</additional>
	<state>blank</state>
	<postcode>EC4R 9AD</postcode>
	<countryname>United Kingdom</countryname>
	<city>London</city>
	<status>ACTIVE</status>
	<order>1</order>
	<defaultaddress>1</defaultaddress>
	<externalid>ext_123</externalid>
	<phone></phone>
	<knownas>HighQ</knownas>
</address>

JSON format

{
		"addressid": "12",
		"orgid": "12",
		"street1": "55 King willian street",
		"additional": "2nd floor",
		"state": "blank",
		"postcode": "EC4R 9AD",
		"countryname": "United Kingdom",
		"city": "London",
		"status": "ACTIVE",
		"order": "1",
		"defaultaddress": "1",
		"externalid": "ext_123",
		"phone": "",
		"knownas": "HighQ"
}

Error messages