Resource type: groups
Action Type: Get
Returns a list of groups with information about id
, name
, abr
, userIds
and groupType
. With no parameters specified a list of all groups is returned.
Parameters:
groupfilter
STRING. Group filter. Possible values:officeGroups
ornoRegionGroups
.officeGroups
returns office groups (Bürogruppen) only.
noRegionGroups
returns only office groups and general groups (Gruppen ohne Angaben / ohne Art)
Example:
... { "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get", "resourceid": "", "identifier": "", "resourcetype": "groups", "parameters": { "groupfilter": "officeGroups" } } ...
Response:
Parameters:
id
INTEGER. Group IDname
STRING. Group nameabr
STRING. Group abbreviationuserIds
ARRAY. user IDs of the user in the groupgroupType
STRING. Group type. Possible values:GroupOffice
(Bürogruppe),GroupRegion
(Regionengruppe) orGroupGeneral
(Gruppe ohne Art / ohne Angaben)
{ "status": { "code": 200, "errorcode": 0, "message": "OK" }, "response": { "results": [ { "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get", "resourceid": "", "resourcetype": "groups", "cacheable": true, "identifier": "", "data": { "meta": { "cntabsolute": null }, "records": [ { "id": 225, "type": null, "elements": { "id": 225, "name": "B\u00fcro1", "abr": "tt", "userIds": [ 25 ], "groupType": "GroupOffice" } }, { "id": 231, "type": null, "elements": { "id": 231, "name": "B\u00fcro2", "abr": "", "userIds": [ 27, 37 ], "groupType": "GroupOffice" } }, { "id": 251, "type": null, "elements": { "id": 251, "name": "Omega", "abr": "", "userIds": [ 17 ], "groupType": "GroupOffice" } } ] }, "status": { "errorcode": 0, "message": "OK" } } ] } }