JSON模块设计和接口设计_vms.doc

JSON接口设计（VMS） V 0.1 赛特斯网络科技有限公司 2011年06月 版本控制 版本号 日期 修改人 说明 V1.0 Jun 25, 2011 朱广文 文档建立、初始化 Jun 25, 2011 王小黎 增加部分事件格式 Dec 2 ,2011 蒋兴杰 文档更新 目 录 目 录 1 一、 JSON中的基本数据类型 3 1. 对象Object： 3 2. 数组Array 3 3. 值value 4 4. 字符串string 5 5. 数值number 5 二、 JSON数据通讯接口 6 1. 事件类型和返回结果： 6 2. BOOT消息： 6 3. KEEPALIVE消息： 8 4. ALARM消息： 10 5. Config消息： 14 6. Query消息： 15 三、 JSON接口设计补充说明 22 JSON中的基本数据类型 对象Object： 例子： { "EventCOde":1 } object中必须是piar对或者空组成。 数组Array 例子： [ "X_CERTUS_IPTV.STBINFO.PollInfo.mosstatus", "", "", "" ] array中必须是value，或者多个value组成。 值value 值可以是string，number，object，array，true，false，null中的任意一个，用来与key配对成pair形式，key必须是string，pair的一个例子： "SerialNumber":"EB100100000000400000001E73AB5038" 或者 "DeviceId":{ "ServiceUser":"nocqiuhao02", "MAC":"00:1e:73:ab:50:38", "Manufacturer":"ZTE", "OUI":"00D0D0", "ProductClass":"STB", "SerialNumber":"EB100100000000400000001E73AB5038" } 这是一个key:object的pair。 字符串string 例子： "SerialNumber" 注意转义符的用法。 数值number JSON数据通讯接口 JSON数据通讯共有4个通讯接口，分别为BOOT、KEEPALIVE、ALARM和POLL信令，其采用一次交互流程进行交互。 以下为根据《QCS和VMS通讯协议》制定的通讯数据样例。 事件类型和返回结果： 基本事件类型定义如下，可扩展: JSON_UNKNOW_TYPE = 0, // 未知类型 JSON_BOOT_EVENT_TYPE = 1, // 开机消息类型 JSON_KEEPALIVE_EVENT_TYPE = 2, // 定期上报类型 JSON_ALARM_EVENT_TYPE = 3, // 报警类型 JSON_GETCHANNEL_EVENT_TYPE = 4, // 获取频道列表类型 JSON_CAQUAL_EVENT_TYPE = 5, // 内容层告警类型 JSON_CONFIG_EVENT_TYPE = 6, // 配置下发类型 JSON_QUERY_EVENT_TYPE = 7 // 主动查询类型 eventCode = JSON_?_EVENT_TYPE, subEvent:0代表请求，subEvent:1代表响应。 基本返回结果定义如下，可扩展: JSON_OK = 0, // OK JSON_UNKNOW_ERROR = -1, // 未知错误 JSON_FORMAT_ERROR = -2, // 数据格式错误 JSON_DATABASE_ERROR = -3, // 数据库访问错误 JSON_PARAMETER_ERROR = -4, // 参数格式错误 JSON_SYSTEM_ERROR = -5, // 系统错误 JSON_EVENT_TYPE_ERROR = -6, // 事件类型错误 JSON_MEMORY_ERROR = -7, // 系统内存错误 JSON_SERVICE_ERROR=-8, //程序错误 JSON_BUF_TOO_SMALL_ERROR=-9,//设置的JSON缓存太小 JSON_NO_STREAM_ALARM=-10//获取断流的数据不可得 BOOT消息： VMS->QCS的消息例子：:8080/QCS/boot