GroupsResponse Data Type

Response for the request to get the groups

Properties
name data type description
groups array of Group the groups
perms map of array of Permission User permissions on the returned items, if requested
Properties inherited from GenericResponse
messages array of Message Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo

Example

{
  "groups" : [ {
    "id" : 12345,
    "name" : "...",
    "description" : "...",
    "children" : [ { }, { } ]
  }, {
    "id" : 12345,
    "name" : "...",
    "description" : "...",
    "children" : [ { }, { } ]
  } ],
  "perms" : {
    "property1" : [ "createfolder", "readitems" ],
    "property2" : [ "deleteitems", "inheritance" ]
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}