Enable or disable window grouping

Request method and path

Enable window grouping

POST http://localhost:[Port]/openapi/window/group/enable?ticket=[OpenApiTicket]

Deactivate window grouping

POST http://localhost:[Port]/openapi/window/group/disable?ticket=[OpenApiTicket]

Interface Description

Enable or disable grouping of operation windows.

Request parameter

Tip

1. A single operation passes the index keyword, with a value that uniquely identifies the window group.
2. Batch operation passes the indexes keyword, with a value of an array that uniquely identifies the window group.
3. iChoose either indexes or indexes according to the operation method.
4. The required parameters for enabling and disabling operations are consistent, with the difference being that the requested path is different.

Parameter Name	Required	Example	type	Explanation
indexes	Y	[1,2,9]	array	Unique identifier array for window grouping.
index	Y	9	number	The unique identifier for window grouping can be obtained in Get Window Grouping.

Request parameter example

Single

{
  "index":9
}

Batch

{
  "indexes":[1,2,9]
}

Return data

Successful Response Example

{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "success",
    "errorCode": "",
    "errorMsg": "",
    "result": {}
  }
}

Example of failed response

Failed to call interface

When the interface response status code is not 00000, the interface call fails. The specific reasons for interface call errors can be found in the Interface Response Status Code Information Comparison Table for querying.

{
  "code": "00001",
  "message": "Unknown error occurred, please provide feedback to official customer service!",
  "data": {}
}

This operation failed

{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "failed",
    "errorCode": "E00",
    "errorMsg": "The format of parameter (xxx) is incorrect!",
    "result": {}
  }
}

Operation failure errorCode error code information comparison table

Error code	Reason for error
E00	The format of parameter (xxx) is incorrect!
E01	Parameter missing window grouping unique identifier index or indexes
E02	The unique identifier index value for window grouping is illegal!
E03	The index must be a positive integer between 1 and 1000.