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

About

Returns a list of organisations which are in the cetegories which match 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, 'bme'.

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="12698">
		<field name="name">42nd Street</field>
		<field name="description">&lt;br /&gt;42nd Street offers services to young people under stress living in Manchester, Salford and Trafford. Most of our services are for 14-25 year olds but some projects can work with young people aged 11+. &lt;br /&gt;We offer Counselling, Informal support and run many groups and drop-ins. We also have specific projects that work with LGBQ young people, Disabled young people and refugees, plus a helpline that all young people can use.&lt;br /&gt;</field>
	</object>
	<object uid="12702">
		<field name="name">Aatish Social and Cultural Events</field>
		<field name="description">Aatish news produced from bldg.</field>
	</object>

	...

	<object uid="13359">
		<field name="name">Youth Champion Scheme</field>
		<field name="description">&lt;br /&gt;We aim to help people aged between 12 to 25 with any support needs they may have from jobs, training, education and skills.</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>
</rsp>

Error Codes

400: Quota exceeded.

403: Invalid API key.

404: Not data was returned.