One Central Place API reference - ocp.search.organisation.name

About

Returns a list of organisations which have a title which matches the search terms.

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.

query (Required): The text to use for query. For example, 'zion'.

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.

limit: Limit the number of returned organisations to the integer value of this parameter. Eg. '5'.

offest: Offset the result set to begin the response after a given number of organisations. Eg. '5'.

Example Response

<?xml version="1.0" encoding="utf-8"?>
<rsp stat="ok">
	<object uid="13363">
		<field name="name">Zion Arts Centre</field>
		<field name="description">&lt;br /&gt;Zion Arts Centre is a multi-artform venue providing creative activity to inspire and enable young people across Manchester</field>
	</object>
	<object uid="13364">
		<field name="name">Zion Community Resource Centre</field>
		<field name="description">At the Zion Community Resource local people can access a range of services and projects including the Zion Garden Project, Zion Art Paintbox and Self Help Services.&lt;br /&gt;</field>
	</object>
	<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>
	<object uid="13366">
		<field name="name">Zion Gay Men's Group</field>
		<field name="description">Group for gay men- experiencing mental/ emotional issues. Hate crime surgery also available. The group runs on Tuesdays from 6-8pm. &lt;br /&gt;</field>
	</object>
</rsp>

Error Codes

400: Quota exceeded.

403: Invalid API key.

404: Not data was returned.