创建窗口分组

请求方法以及路径

POST http://localhost:[端口号]/openapi/window/group/create?ticket=[OpenApi票据]

接口功能描述

用于创建窗口分组。

请求参数

Header 请求参数

参数名	参数值	必填	类型	描述
Content-Type	application/json	是	String	application/json

Body 请求参数

参数名	是否必须	类型	说明
windowGroupBasicInfo	是	object	窗口分组的基本信息配置对象 查看配置对象详解

请求参数示例

{
  "windowGroupBasicInfo": {
    "windowGroupName": "124",
    "isDefault": true,
    "enable": true
  }
}

参数详解

windowGroupBasicInfo 配置参数对象键值详解

参数名	是否必须	类型	说明
windowGroupName	是	string	分组名称
isDefault	是	bool	是否是设置为系统的 默认分组
enable	是	bool	分组使能

接口响应结果示例

成功响应示例

返回参数

newWindowGroupKey: 新创建的分组的唯一标识。

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

失败响应示例

调用接口失败

接口响应状态码，不为00000时，接口调用失败。
具体接口调用错误原因可查看接口响应状态码信息对照表进行查询。

{
  "code": "00001",
  "message": "产生未知错误，请反馈给官方客服！",
  "data": {}
}

本次修改操作失败

{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "failed",
    "errorCode": "E01",
    "errorMsg": "缺少参数(xxx)",
    "result": {}
  }
}

操作失败 errorCode 错误码信息对照表

错误码	错误原因
E00	参数(xxx)格式有误！
E01	缺少参数 (xxx)。
E02	参数存在多余 。
E03	缺少参数 windowGroupBasicInfo.(xxx)。
E04	windowGroupBasicInfo 中的参数存在多余 。
E05	马上就要超过分组最大容量 50 个 了，请删除部分分组列表(即：模板列表)，然后重试！
E06	窗口分组唯一编号 index 的值已经超过最大允许值 200 了，请删除部分靠后的分组列表(即：模板列表)，然后重试！