OVERVIEW

Below is a quick overview of the Organisation Group APIs, more details can be found in the child pages.

API Functionality	HTTP Request Type	HTTP Request URL	URL Parameters	HTTP Request content	HTTP Response
Get Organisation Group	GET	/api/2/organisationgroups/:org	:org = Organisation group ID		Organisation Group Object of requested organisation group
Get Organisation Group list	GET	/api/2/organisationgroups?{params}	{params} = filters, sort, search, fields to return		List of Organisation Group summary Objects
Add Organisation Group	POST	/api/2/organisationgroups		Organisation group object for new organisation group	Organisation Group summary Object
Update Organisation Group	PUT	/api/2/organisationgroups/:org	:org = Organisation group ID	Updated Organisation group object	Organisation Group summary Object
Delete Organisation Group	DELETE	/api/2/organisationgroups/:org/archive	:org = Organisation group ID
Add Organisations to Organisation Group	PUT	/api/2/organisationgroups/:org/organisations	:org = Organisation group ID	List of organisation names or ids	Organisation Group summary Object
Delete Organisations from Organisation Group	DELETE	/api/2/organisationgroups/:org/organisations/:deleteorg	:org = Organisation group ID :deleteorg = Organisations to remove from the list, separated by comma		Organisation Group summary Object

Comments

Last Updated: Nov 08,2024