GroupsResponse Data Type

Response for the request to get the groups

Properties
name data type constraints description
groups array of Group   the groups
perms map of array of Permission   User permissions on the returned items, if requested
messages array of Message   Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo  
inBackground boolean required boolean Whether the job was pushed into the background.

Example

{
  "groups" : [ {
    "id" : 12345,
    "name" : "...",
    "description" : "...",
    "children" : [ { }, { } ]
  }, {
    "id" : 12345,
    "name" : "...",
    "description" : "...",
    "children" : [ { }, { } ]
  } ],
  "perms" : {
    "property1" : [ "channelsync", "linkoverview" ],
    "property2" : [ "createoverview", "delete" ]
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  },
  "inBackground" : true
}