Org address list

Overview

This API call is used to get list of a addresses in an organisation object in the system.

HTTP Request

GET /api/5/orgaddresses?orgid=<ORGID>

HTTP Response

Success

HTTP response 200

Error

See API Error messages

Example

GET http://example.com/context/api/5/orgaddresses?orgid=101

XML format

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

JSON format

{
	"address": [
        {
    		"addressid": "12",
    		"orgid": "11",
    		"street1": "55 King willian street",
    		"additional": "2nd floor",
    		"state": "blank",
    		"postcode": "EC4R 9AD",
    		"countryname": "India",
    		"city": "London",
    		"status": "1",
    		"order": "1",
    		"defaultaddress": "1",
    		"externalid": "ext_123",
    		"phone": "",
    		"knownas": "HighQ"
    	},
        {
            "addressid": "3",
            "street1": "Level 29, 20 Bond Street",
            "additional": "",
            "state": "",
            "postcode": "NSW 2000",
            "countryname": "Australia",
            "city": "Sydney",
            "status": "Active",
            "order": "3",
            "defaultaddress": "0",
            "externalid": "",
            "phone": "+61 (0) 2 9188 5045",
            "knownas": "HighQ"
        }
    ]
	
}

Error messages