Org department list

Overview

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

HTTP Request

GET /api/5/organisations/departments?orgid=<ORGID>&ordertype={ordertype}&orderby={orderby}&search={departmentname}

URL Parameters

HTTP Response

Success

HTTP response 200

Error

See API Error messages

Example

GET http://example.com/context/api/5/organisations/departments?orgid=123&ordertype=departmentname&orderby=desc&search=abc

XML format

<departments>
	<department>
		<id>1</id>
		<name>IT</name>
		<status>active</status>
		<link>https://jigneshkd.local.com/jigneshd_4_live/api/4/organisations/departments/15</link>
	</department>
	<department>
		<id>2</id>
		<name>SALES</name>
		<status>active</status>
		<link>https://jigneshkd.local.com/jigneshd_4_live/api/4/organisations/departments/16</link>  
	</department>
</departments>

JSON format

{
		"department": [
			{
				"id": "1",
				"name": "IT",
				"status": "active",
				"link": "https://jigneshkd.local.com/jigneshd_4_live/api/4/organisations/departments/15"

			},
			{
				"id": "2",
				"name": "SALES",
				"status": "active",
				"link": "https://jigneshkd.local.com/jigneshd_4_live/api/4/organisations/departments/16"

			}
		]
}

Error messages