URI
<groups_uri>/status[.<format>]
Supported methods
Parent resource
Introduction
groupsStatus resource is the status of batch updates group, including enable and disable the group. Only the administrator has the right to enable and disable the group.
Supported Methods:
- PUT: Batch update the group status, including enable and disable the group.
Supported output formats: rjson, json, html, xml.
Resource hierarchy
HTTP request methods
Implement the HTTP request on the following URI, where supermapiportal is the server name, with rjson being the output format.
http://supermapiportal:8090/iportal/web/groups/status.rjson
PUT request
Batch update the group status, including enable and disable the group.
Request parameter
Implement the PUT request for the groupsStatus resource. Batch enable or disable the group. Consist of the following fields:
| Name | Type | Description |
| groupIds | Integer[] | The unique identifier of the group. |
| isEnabled | Boolean | Whether the goup enables. |
Response structure
The returned resource representation structure is as follows:
| Field | Type | Description |
| succeed | boolean | Batch update whether the group status is successful. |
| error | Httperror | Error. If the batch update the group successfully, it would not have this field. |
Response example
1. Batch enable the group
Perform the PUT request for the groupsStatus resource: http://localhost:8090/iportal/web/groups/status.rjson. Batch enable the group. The request is as follows:
{
"groupIds": [
1,
2
],
"isEnabled": true
}
The returned resource representation in rjson firmat is as follows:
{"succeed": true}
Bathc disable the group
Perform the PUT request for the groupsStatus resource: http://localhost:8090/iportal/web/groups/status.rjson. Batch disable the group. The request is as follows:
{
"groupIds": [
1,
2
],
"isEnabled": false
}
The returned resource representation in rjson firmat is as follows:
{"succeed": true}