One Central Place API reference - ocp.list.organisation

About

Returns details of a given organisation.

Authentication

This method requires a valid API key. Requests to this method count toward your daily request quota.

Arguments

key (Required): Your API application key.

id (Required): The ID number of the organisation you wish to query. ID numbers can be retrieved by the ocp.search.organisation.name, ocp.search.organisation.category, ocp.search.organisation.location methods.

detail: The amount of detail in the response. The value 'all' can be used to increase the information included in the response. If omitted, this method defaults to a brief response.

Example Response

<?xml version="1.0" encoding="utf-8"?>
<rsp stat="ok">
	<object uid="13365">
		<field name="name">Zion Depression Group</field>
		<field name="description">For anyone living with depression and/or manic depression. The group runs on a Wednesday from 3-5pm. &lt;br /&gt;</field>
	</object>
</rsp>

Error Codes

400: Quota exceeded.

403: Invalid API key.

404: Not data was returned.