配置项枚举接口用于枚举出系统支持的所有配置项和状态项,具体接口如下:
请求地址:
http://127.0.0.1:xxxx/apiListAllConfig?SessionKey={SessionKey}
请求方式: GET
参数说明:
参数 | 是否必须 | 说明 |
---|---|---|
SessionKey | 是 | 通过认证接口获取的会话密钥,如果没有Bangwo8APIServer.conf或者Bangwo8APIServer.conf中ServerSecureKey为空,则表明访问无需秘钥保护,此时不需要此字段 |
返回值说明:
正常情况下,本接口会返回类似下述JSON数据包给开发者:
{ "errorcode" : "0", "message" : "success" "data" : [ { "ConfName" : "CallerCallBackWin", "Description" : "Handle of callback window in API caller program to receive inform message, in decimal numbers", "MaxValueLength" : "24", "Readonly" : "false", "ValidValueRegex" : "" }, { "ConfName" : "LocalUserClientID", "Description" : "The 9 digitals ID of local UserClient", "MaxValueLength" : "16", "Readonly" : "true", "ValidValueRegex" : "" }, { "ConfName" : "RemoteModule", "Description" : "Use which modules", "MaxValueLength" : "64", "Readonly" : "false", "ValidValueRegex" : "" }, { "ConfName" : "RemotePassword", "Description" : "Password to protect local remote access, max length: 32", "MaxValueLength" : "40", "Readonly" : "false", "ValidValueRegex" : "" }, { "ConfName" : "SupportClientCallBackWin", "Description" : "Handle of callback window in SupportClient.exe to receive inform message, in decimal numbers", "MaxValueLength" : "24", "Readonly" : "false", "ValidValueRegex" : "" }, { "ConfName" : "UserClientCallBackWin", "Description" : "Handle of callback window in UserClient.exe to receive inform message, in decimal numbers", "MaxValueLength" : "24", "Readonly" : "false", "ValidValueRegex" : "" } ], }
JSON字段 | 说明 |
---|---|
errorcode | 应答结果码: 0: 成功 3: 提供的SessionKey非法 |
message | 出错消息,可以用于获取进一步的出错原因(该字段在所有应答消息中都有) |
data | 一个JSON数组,包含所有支持的配置项和状态项,每个项目包含如下字段: * ConfName: 配置项/状态项名称 * Description: 该项目的说明 * MaxValueLength: 该项目取值的最大长度 * Readonly: 对配置项,该字段为false,对状态项,取值为true * ValidValueRegex: 该项目合法取值检查的正则表达式 |