Groups resouce

Get group list

OVERVIEW

This API call is used to get list of system groups.

Note:

The following changes have been made to this API endpoint

  • Introduced sorting
  • Added following additional items to the return object createddate, totalcount, total, nooforganisation

HTTP Request

GET   /api/3/groups? {parameters}

 

Parameters Description
type org (Organisation Auto created groups)
synced (Groups imported from an external system like Active directory) 
system (System groups)
sort

Allow ascending and descending sorting of a single field.

GET /api/3/groups?ordertype=createddate

This returns a list of groups sorted by createddate in ascending order.

possible fields: createddate
order by

Allow ascending and descending sorting of a single field.

GET /api/3/groups?orderby=desc

possible fields: asc,desc

 

Example

GET  http://example.com/context/api/3/groups?ordertype=createddate&orderby=desc&type=org

 

HTTP Response

Success

HTTP response 200

Error

See  API Error messages 

XML response

 

<groups>
    <total>46</total>
    <totalcount>11</totalcount>
    <group>
        <id>12</id>
        <name>aabbcWc</name>
        <description></description>
        <type>org</type>
        <numberofusers>0</numberofusers>
        <createddate>15 Mar 2018 14:26</createddate>
        <nooforganisation>0</nooforganisation>
    </group>
</groups>

 

JSON response

 

{
	"total": "46",
	"totalcount": "11",
	"group": {
		"id": "12",
		"name": "aabbcWc",
		"description": "",
		"type": "org",
		"numberofusers": "0",
		"createddate": "15 Mar 2018 14:26",
		"nooforganisation": "0"
	}
}

Where

"total" is the total number of system groups in the instance

"totalcount" is the total no of groups returned in this API response based on the specific filter. 

 

Comments


0 Comments

Last Updated: Nov 08,2024