管理规范-企业物流管理软件规范说明开发文档范本V2_第1页
管理规范-企业物流管理软件规范说明开发文档范本V2_第2页
管理规范-企业物流管理软件规范说明开发文档范本V2_第3页
管理规范-企业物流管理软件规范说明开发文档范本V2_第4页
管理规范-企业物流管理软件规范说明开发文档范本V2_第5页
已阅读5页,还剩82页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

PAGE37PAGE89管理规范企业物流管理软件规范说明开发文档范本文件编号202XQK011/BT-ZTA-QK011文件状态[]草稿[√]正式发布[]正在修改当前版本拟制日期审核日期日期版本变更内容作者1.0初稿1.1修正1.2新增新产品功能目录TOC\o"1-3"\h\u18544第一章公共接口 599661.1.验证码发送接口 551521.2.用户管理接口 6292371.2.1.用户登录验证接口 6265961.2.2.用户基本信息获取接口 951851.2.3.用户路径信息获取接口 12285151.2.4.用户电子围栏信息获取接口 15255971.3.设备管理接口 16164091.3.1.根据终端号查询设备信息接口 16230991.3.2.设备默认参数获取接口 20112411.3.3.终端修改接口 2352021.3.4.组内设备最近上报信息查询接口 25188551.3.5.单个设备历史上报信息查询接口 2823421.3.6.新建分组接口 36272991.3.7.修改分组接口 37273771.3.8.删除分组接口 39116911.3.9.组信息查询接口 40175981.3.10.组内设备信息查询接口 4290091.3.11.查询用户所有终端接口 4462781.3.12..设备搜索接口 46213541.3.13..设备能力查询接口 48110721.3.14.指定设备信息查询接口 4916039第二章任务管理接口 51221192.1.任务参数查询接口 51289842.2.新增任务接口 54129972.3.任务修改接口 57203702.4.任务删除接口 60200982.5.任务列表查询接口 6193692.6.单个任务查询接口 64288782.7.任务设备查询接口 6728702.8.任务内设备最近上报信息查询接口 69162772.9.任务开始接口 72219252.10.任务结束接口 73322.11.任务报警数据查询 75266502.12.按月统计监控账号的任务数量 75127012.13.新增任务模板接口 77270572.14.修改任务模板接口 78309302.15.删除模板接口 7914792.16.查询任务模板列表接口 81201122.17.查询单个任务模板信息接口 822347第三章消息相关接口 84119403.1.消息查询接口 84168443.2.消息设置已读接口 87131343.3.消息检索接口 88PAGE59PAGE89公共接口验证码发送接口接口功能发送短信验证码。接口定义命令名称/wlx/valicode/02/sendHttp方法Post/Get提交参数参数名类型长度可空标志说明phoneString11非空手机号typeString1非空1注册短信2绑定短信3解绑短信4找回密码返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.solidminuteString有效分钟返回值类型含义String(JSON)返回验证码发送结果返回值说明<样例:发送失败{"result":"01","description":"发送失败"}发送成功{"result":"00","description":"发送成功","data":{"solidminute":"30"}}用户管理接口用户登录验证接口接口功能用户登录验证接口。接口定义命令名称/wlx/user/02/loginHttp方法Post/Get提交参数参数名类型长度可空标志说明accountString非空登录帐号(兼容管理主账户和监控账户)passwdString可空密码返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idString非空用户IDdata.accountString非空登录帐号data.phoneString非空绑定手机data.regTimeString非空注册时间data.photoUrlString非空头像地址data.statusString非空状态1有效0注销data.userTypeString非空用户类型1管理账户0监控账号data.atString非空会话tokendata.wechatOpenIdString可空微信公众号data.alarmTypeString非空监控账号登陆时有此报警类型SMS通知微信通知SMS&微信通知返回值类型含义String(JSON)返回验证的结果返回值说明样例:登录成功{ "data":{ "userType":"1", "id":"43DB07BF7E984F9B8563B4CBE9", "status":"1", "phone":"1234566", "account":"zung", "compAddr":"上海市浦东新区蔡伦路1690号", "compName":"座头鲸(上海)信息技术有限公司", "compTel":"189d", "regTime":null, "at":"bb5d91804a702e7e7d0b3341", "photoUrl":"", "compId":"", "lastLoginTime":"2016-08-3116:14:30", "compLinkerName":"****", "compLinkerEmail":"x***ge@", "wechatOpenId":"", "compLinkerPhone":"***", "compLinkerTel":"" }, "description":"用户验证成功", "result":"00"}登录失败:{"result":"01","description":"用户名或密码错误"}用户基本信息获取接口接口功能用户信息获取接口。接口定义命令名称/wlx/user/02/viewHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空用户idatString非空用户登录token返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.accountString非空登录帐号data.userTypeString非空用户类型1管理账户0监控账号data.phoneString非空绑定手机data.regTimeString非空注册时间data.photoUrlString非空头像地址data.statusString非空状态1有效0注销data.lastLoginTimeString非空最后登录时间pNameString可空组织名称pAddrString可空组织地址pTelString可空组织联系电话pLinkerNameString可空负责人姓名pLinkerTelString可空负责人电话pLinkerPhoneString可空负责人手机pLinkerEmailString可空负责人邮箱data.wechatOpenIdString可空微信公众号data.alarmTypeString非空监控账号信息查询时有此报警类型1.SMS通知2.微信通知3.SMS&微信通知返回值类型含义String(JSON)返回结果返回值说明<样例:查询成功{ "data":{ "userType":"1", "id":"43DB07BF7E984F9B8563B4CBE9", "status":"1", "phone":"1234566", "account":"zung", "compAddr":"上海市浦东新区蔡伦路1690号", "compName":"座头鲸(上海)信息技术有限公司", "compTel":"189d", "regTime":null, "at":"bb5d91804a702e7e7d0b3341", "photoUrl":"", "compId":"", "lastLoginTime":"2016-08-3116:14:30", "compLinkerName":"****", "compLinkerEmail":"x***ge@", "wechatOpenId":"", "compLinkerPhone":"***", "compLinkerTel":"" }, "description":"用户查询成功", "result":"00"}查询用户信息不存在{"result":"01","description":"用户信息不存在"}用户路径信息获取接口接口功能用户路径信息获取接口。接口定义命令名称/wlx/user/02/viewpathsHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空用户idatString非空用户登录token返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idString非空路径iddata.beginAddrString非空路径开始地址data.destAddrString非空路径目标地址String非空路径名称data.routeAddrString非空路径地址data.distanceString非空路径距离返回值类型含义String(JSON)返回验证的结果返回值说明<样例:查询成功{ "data":[ { "name":"复旦一日游", "id":92, "routeDetail":"", "route":"121.60093,31.192188;121.503654,31.296594", "userAcc":"zuotoujing", "beginAddr":"上海市浦东新区张江高科技园区蔡伦路复旦大学张江校区", "destAddr":"上海市杨浦区五角场街道复旦大学复旦大学邯郸校区", "x1":"121.60093", "y1":"31.192188", "x2":"121.503654", "y2":"31.296594","routeAddr":"江苏省常州市武进区高新区定安中路433号;江苏省无锡市宜兴市徐舍镇巢庄圩;江苏省苏州市相城区元和街道中创路;浙江省湖州市长兴县小浦镇小槐线;浙江省嘉兴市秀洲区新塍镇小姚弄","distance":"0;55142;112332;131172;95139" }], "description":"用户路径查询成功", "result":"00"}查询失败{"result":"01","description":"用户路径查询失败"}用户电子围栏信息获取接口接口功能用户电子围栏信息信息获取接口。接口定义命令名称/wlx/user/02/viewpoisHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空用户idatString非空用户登录token返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idString非空路径iddata.addrString非空围栏名称data.xString非空xdata.yString非空y返回值类型含义String(JSON)返回验证的结果返回值说明<样例:查询成功{ "data":[{ "id":453, "x":"121.15404", "addr":"上海市青浦区夏阳街道南丰路184号", "y":"31.127138", "userAcc":"zuotoujing" }], "description":"用户围栏查询成功", "result":"00"}查询失败{"result":"01","description":"用户围栏查询失败"}设备管理接口根据终端号查询设备信息接口A.接口功能根据终端号查询设备信息接口。B.接口定义命令名称/wlx/dev/02/viewHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokendevidString非空设备终端号info.curparamString可空1:同时返回监控参数0或空:不返回监控参数info.abilityString可空1:同时返回能力0或空:不返回能力info.curtaskString可空1:同时返回当前任务与监控者0或空:不返回当前任务与监控者info.collectorString可空1:同时返回采集设备信息0或空:不返回采集设备信息返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idString32非空终端号data.adminIdString32非空用户账号data.phoneString可空绑定手机data.firmVersionString非空固件版本data.termVersionString非空终端版本data.devAliasString可空设备别名data.groupidString可空组Iddata.restRptCycint非空静止上报周期data.workRptCycint非空运行上报周期data.adminFlagString可空管理标识data.simpleAbility可空终端能力data.task可空终端当前任务data.monUser可空终端当前监控人data.param可空终端监控信息data.collector可空终端采集设备返回值类型含义String(JSON)返回查询的结果返回值说明<样例:查询成功{ "data":{ "id":"00A100000B468CB3", "adminFlag":"", "style":"1", "termVersion":"WLX-G-5000D-TEST", "remoteShutdown":-1, "powerStatus":"9", "enableHardShutdown":"1", "simpleAbility":["P001", "P002", "P003", "P004", "P005", "P006", "P007", "P008"], "firmVersion":"011", "adminId":"43DB07BF7E984F9B857FD00A63B4CBE9", "phone":, "devAlias":"TUOPAN3", "restRptCyc":30, "workRptCyc":5, "groupid":148, "powerUpdateTime":null }, "description":"查询成功", "result":"00"}查询失败:{"result":"01","description":"设备信息不存在"}设备默认参数获取接口A.接口功能设备默认参数获取接口。B.接口定义命令名称/wlx/dev/02/defaultparamHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话token返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.typeString非空参数类型代码P001围栏参数P002预设路径参数P003温度参数P004湿度参数P005电量参数P006光敏参数P007三轴撞击参数P008三轴倾斜参数P009三轴颠簸参数data.startvString非空起始值若为单值参数则无结束值data.endvString可空结束值data.extvString可空扩展值data.extv2String可空扩展值2data.effctypeString非空报警类型1范围内2范围外3大于4小于5等于6进出围栏data.rptflagString非空是否报警(0不报警1报警2预警)data.typecnString非空参数中文名data.unitString可空单位data.idint非空参数Id返回值类型含义String(JSON)返回查询的结果返回值说明<样例:查询成功{ "data":[{ "id":1, "type":"P001", "typecn":"围栏", "unit":"", "effctype":"6", "endv":"", "extv":"1000", "extv2":"", "rptflag":"0", "startv":"" }], "description":"查询成功", "result":"00"}终端修改接口A.接口功能终端修改接口。B.接口定义命令名称/wlx/dev/02/updateHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokendata.idString32非空终端号data.groupidint非空组编号data.restRptCycint非空静止上报周期data.workRptCycint非空运行上报周期data.devAliasString非空设备别名data.adminFlagString可空管理标识data.taskidint可空设备分配的任务iddata.enableShutdownInt非空可硬关机(0:不可,1:可,9:无此能力)data.monUser.idString可空监控账号iddata.param.typeString可空参数类型代码P001围栏参数P002预设路径参数P003温度参数P004湿度参数P005电量参数P006光敏参数P007三轴撞击参数P008三轴倾斜参数P009三轴颠簸参数P010压力参数data.param.startvString可空起始值若为单值参数则无结束值data.param.endvString可空结束值data.param.extvString可空扩展值data.param.extv2String可空扩展值2data.param.effctypeString可空报警类型1范围内2范围外3大于4小于5等于6进出围栏data.param.rptflagString可空是否报警(0不报警1报警2预警)data.param.idint可空参数Iddata.collector返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述返回值类型含义String(JSON)返回修改的结果返回值说明<样例:修改成功{"result":"00","description":"修改成功"}组内设备最近上报信息查询接口A.接口功能查询组内设备最新上报信息接口。B.接口定义命令名称/wlx/report/02/viewlastbygrpHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokengroupidint非空组id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idString非空数据iddata.devidString非空设备iddata.typeString可空报告类型(0普通2预警1报警)data.timeString可空报告时间(yyyy-MM-ddHH:mm:ss)data.locxString可空经度data.locyString可空纬度data.locnameString可空地点名称data.rpts.typeString可空上报类型代码P001围栏参数P002预设路径参数P003温度参数P004湿度参数P005电量参数P006光敏参数P007三轴撞击参数P008三轴倾斜参数P009三轴颠簸参数P010压力参数String可空名称(如:温度)data.rpts.valueString可空值(如:23.5摄氏度)data.rpts.descString可空描述(如:正常)data.simpleAbilityList可空设备能力返回值类型含义String(JSON)返回查询的结果返回值说明<样例:查询成功{"result":"00","description":"查询成功","data":[{"id":"2342GHJGYHWGG776789HGYHGTR5T4","type":"0","time":"1.0","locx":"123.3434340","locy":"31.343423423","locname":"上海陆家嘴","rpts":[{"type":"P003","name":"温度","value":"23.5","desc":"正常"},{"type":"P005","name":"电量","value":"40","desc":"正常"}],“simpleAbility“:[”P001”,”P002”]}]}单个设备历史上报信息查询接口A.接口功能单个设备历史上报信息查询接口,参数:设备Id,时间,天数,时间戳。B.接口定义命令名称/wlx/report/02/viewhisHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokendevidString32非空设备iddateString非空时间:格式yyyyMMdddaynumint可空天数,默认为1taskidString可空任务idtimestampeString可空格式yyyy-MM-ddHH:mm:sstermtypeString非空1:分体式返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述datajson数组,每个成员有如下格式:devString非空设备idlocxdouble可空火星坐标xloxydouble可空火星坐标ylnameString可空坐标逆地址编码rlocxString可空地球坐标xrlocyString可空地球坐标yloctint可空定位类型:1:GPS3\4:其它tidString可空任务IDspdint可空GPS速度timeString可空采集时间mListjson数组,每个元素包含一个5个长度的数组,每一个单元有以下定义:0int可空ID号(安装位置标识,0代表网关)1String可空参数类型代码:P003温度参数P004湿度参数P005电量参数P006光敏参数2String可空报警标志:0不报警1报警3String可空参数值4String可空参数说明返回值类型含义String(JSON)返回查询的结果返回值说明<样例:查询成功{"data":[{"dev":"000000008087F49A","locx":0,"locy":0,"lname":"上海市闵行区浦江镇上海成高机械有限公司","rlocx":0,"rlocy":0,"loct":0,"rtime":"2017-01-0919:27:25","mList":[[0,"P005","0","100","充电中"],[0,"P001","0","",""],[0,"P002","0","",""],[1,"P006","0","4","无曝光"],[1,"P004","0","71","湿度过高"],[1,"P003","0","-15.36","温度正常"],[2,"P006","0","4","无曝光"],[2,"P004","0","71","湿度过高"],[2,"P003","0","-14.69","温度正常"],[3,"P006","0","1","无曝光"],[3,"P004","0","67","湿度正常"],[3,"P003","0","-16.33","温度正常"],[4,"P006","0","12","无曝光"],[4,"P004","0","77","湿度过高"],[4,"P003","0","2.82","温度正常"],[0,"P001","0","",""]],"tid":"","spd":0,"time":"2017-01-0900:01:40"}],"description":"查询成功","result":"00"}新建分组接口A.接口功能新建分组接口。B.接口定义命令名称/wlx/group/02/addHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokennameString非空组名称groupDescString可空组备注isDivisionString不可空0:便携版1:分体版返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idint可空组id返回值类型含义String(JSON)返回执行的结果返回值说明<样例:增加成功{"result":"00","description":"增加成功","data":{"id":2344}}修改分组接口A.接口功能修改分组接口。B.接口定义命令名称/wlx/group/02/updateHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokengroupidint非空组idnameString非空组名称groupDescString可空组备注isDivisionString不可空0:便携版1:分体版返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述返回值类型含义String(JSON)返回执行的结果返回值说明<样例:修改成功{"result":"00","description":"修改成功"}删除分组接口A.接口功能删除分组接口。B.接口定义命令名称/wlx/group/02/delHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokengroupidint非空组id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idString非空设备Iddata.devAliasString非空设备别名data.groupidString非空设备组号(新)data.adminFlagString可空管理标识返回值类型含义String(JSON)返回执行的结果返回值说明<样例:删除成功{"result":"00","description":"删除成功"}组信息查询接口A.接口功能组信息查询接口。B.接口定义命令名称/wlx/group/02/listHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokenisdivisionString非空0:便携版1:分体版返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idint非空组String非空组名data.groupDescString可空组描述data.devNumint设备数量data.typeString1默认,0返回值类型含义String(JSON)返回执行的结果返回值说明<样例:查询成功{ "data":[{ "name":"默认分组", "id":253, "type":"1", "isDivision":"1", "groupDesc":"默认分组", "devNum":1 }], "result":"00", "description":"查询成功"}组内设备信息查询接口A.接口功能组内设备信息查询接口。B.接口定义命令名称/wlx/group/02/listdevHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokengroupidint非空组id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idString非空设备iddata.devAliasString非空设备别名data.adminFlagString可空管理标识data.remoteShutdownInt非空远程电源关闭权限

0:不可关闭1:可关闭-1:无能力返回值类型含义String(JSON)返回查询的结果返回值说明<样例:查询成功{"result":"00","description":"查询成功","data":[{"devid":"2342GHJGYHWGG776789HGYHGTR5T4","devAlias":"Hp设备001","adminFlag":"001"}]}查询用户所有终端接口A.接口功能组内设备信息查询接口。B.接口定义命令名称/wlx/group/02/listgrpdevHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话token返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idString非空组String非空组名data.devs.idString设备Iddata.devs.devAliasString可空设备别名返回值类型含义String(JSON)返回查询的结果返回值说明<样例:查询成功{"result":"00","description":"查询成功","data":[{"devid":"2342GHJGYHWGG776789HGYHGTR5T4","devAlias":"Hp设备001"}]}.设备搜索接口接口功能设备搜索接口B.接口定义命令名称/wlx/dev/02/searchdevHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokendevAliasString非空设备别名(下个版本废弃)termtypeString可空版本类型:便携版(0)、分体版(1)、固定式(3)、标签式(4)不传默认为便携版keywordString非空查询的关键字typeString非空类型包括:1:ID、2:别名、3:ID或别名返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idString32非空终端号data.devAliasString非空设备别名data.adminFlagString可空管理标识data.groupidString非空组Iddata.termversionString非空终端版本返回值类型含义String(JSON)返回查询的结果返回值说明<样例:指令发送成功查询成功{"result":"00","description":"查询成功","data":{"id":"2342GHJGYHWGG776789HGYHGTR5T4","devAlias":"测试","adminFlag":"测试","groupid":"12}.设备能力查询接口接口功能设备搜索接口B.接口定义命令名称/wlx/ability/02/listdefaultbydevHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokenidsString非空终端设备列表,逗号相隔返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.P001.typecnString非空能力参数data.P001.typeString非空能力参数data.P001.startvString非空能力参数data.P001.endvString非空能力参数data.P001.extvString非空能力参数data.P001.extv2String非空能力参数data.P001.effectypeString非空能力参数data.P001.rptflagString非空能力参数data.P001.unitString非空能力参数….….….….….data.P010.unitString非空能力参数返回值类型含义String(JSON)返回查询的结果指定设备信息查询接口A.接口功能组内设备信息查询接口。B.接口定义命令名称/wlx/dev/02/specificlistHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokenidsString非空多设备id,逗号连接返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idString非空设备iddata.devAliasString非空设备别名data.adminFlagString可空管理标识data.remoteShutdownInt非空远程电源关闭权限

0:不可关闭1:可关闭-1:无能力返回值类型含义String(JSON)返回查询的结果返回值说明<样例:查询成功{"result":"00","description":"查询成功","data":[{"devid":"2342GHJGYHWGG776789HGYHGTR5T4","devAlias":"Hp设备001","adminFlag":"001"}]}任务管理接口任务参数查询接口A.接口功能任务参数获取接口。B.接口定义命令名称/wlx/task/02/defaultparamHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokentaskidint可空任务id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.restRptCycint非空静止上报周期data.workRptCycint非空运行上报周期data.emergencyTimeint非空紧急上送时长data.param.typeString非空参数类型代码P001围栏参数P002预设路径参数P003温度参数P004湿度参数P005电量参数P006光敏参数P007三轴撞击参数P008三轴倾斜参数P009三轴颠簸参数P010压力参数data.param.startvString非空起始值若为单值参数则无结束值data.param.endvString可空结束值data.param.extvString可空扩展值data.param.extv2String可空扩展值2data.param.effctypeString非空报警类型1范围内2范围外3大于4小于5等于6进出围栏data.param.rptflagString非空是否报警(0不报警1报警2预警)data.param.typecnString非空参数中文名data.param.idint非空参数Id返回值类型含义String(JSON)返回查询的结果返回值说明<样例:查询成功{"result":"00","description":"查询成功","data":[{"type":"P002","startv":"北京","endv":"上海","extv":"121.52,31.1881;126.52,34.1881;","effctype":"1","rptflag":"0","typecn":""预设路径","id":124},{type":"P004",startv":"5",endv":"65",extv":"",effctype":"1",rptflag":"0",typecn":"湿度","id":125}]}新增任务接口A.接口功能新增任务接口。B.接口定义命令名称/wlx/task/02/addHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话String32非空任务名称data.isDivisionString非空是否是分体版data.beginTimeString非空计划开始时间(yyyy-MM-ddHH:mm:ss)data.endTimeString非空结束时间(yyyy-MM-ddHH:mm:ss)data.taskDescString非空备注data.restRptCycint非空静止上报周期data.workRptCycint非空运行上报周期data.emergencyTimeint非空紧急上送时长data.monUser.idString可空监控账号iddata.param.typeString可空参数类型代码P001围栏参数P002预设路径参数P003温度参数P004湿度参数P005电量参数P006光敏参数P007三轴撞击参数P008三轴倾斜参数P009三轴颠簸参数P010压力参数data.param.startvString可空起始值若为单值参数则无结束值data.param.endvString可空结束值data.param.extvString可空扩展值data.param.extv2String可空扩展值2data.param.effctypeString可空报警类型1范围内2范围外3大于4小于5等于6进出围栏data.param.rptflagString可空是否报警(0不报警1报警2预警)data.param.idint可空参数Iddata.devs.idString设备Id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idint非空任务id返回值类型含义String(JSON)返回查询的结果返回值说明<样例:增加成功{"result":"00","description":"增加成功"}任务修改接口A.接口功能任务修改接口。B.接口定义命令名称/wlx/task/02/updateHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokendata.idint非空任务Iddata.isDivisionString非空是否是分体版String非空终端号data.beginTimeString非空计划开始时间(yyyy-MM-ddHH:mm:ss)data.endTimeString非空结束时间(yyyy-MM-ddHH:mm:ss)data.taskDescString非空备注data.restRptCycint非空静止上报周期data.workRptCycint非空运行上报周期data.emergencyTimeint非空紧急上送时长data.monUser.idString可空监控账号data.param.typeString可空参数类型代码P001围栏参数P002预设路径参数P003温度参数P004湿度参数P005电量参数P006光敏参数P007三轴撞击参数P008三轴倾斜参数P009三轴颠簸参数P010压力参数data.param.startvString可空起始值若为单值参数则无结束值data.param.endvString可空结束值data.param.extvString可空扩展值data.param.extv2String可空扩展值2data.param.effctypeString可空报警类型1范围内2范围外3大于4小于5等于6进出围栏data.param.rptflagString可空是否报警(0不报警1报警2预警)data.param.idint可空参数Iddata.devs.idString设备Id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述返回值类型含义String(JSON)返回查询的结果返回值说明<样例:增加成功{"result":"00","description":"增加成功"}任务删除接口A.接口功能任务删除接口。B.接口定义命令名称/wlx/task/02/delHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokentaskidint非空任务Id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述返回值类型含义String(JSON)返回查询的结果返回值说明<样例:删除成功{"result":"00","description":"删除成功"}任务列表查询接口A.接口功能任务列表查询接口。B.接口定义命令名称/wlx/task/02/listHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokenisdivisionString非空是否是分体版statusString可空任务状态(0未启动1执行中2结束3强制结束)monthString可空查询月,格式为YYYY-MM返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idint非空任务String32非空任务名称data.realBeginTimeString非空计划开始时间(yyyy-MM-ddHH:mm:ss)data.endTimeString非空结束时间(yyyy-MM-ddHH:mm:ss)data.taskDescString非空备注data.statusString非空状态data.devNumint终端数量返回值类型含义String(JSON)返回查询的结果返回值说明<样例:查询成功{"result":"00","description":"查询成功","data":[{"id":123,"name":"HP任务1","realBeginTime":"2015-09-0923:23:23","endTime":"2015-09-1923:23;23","taskDesc":"HP任务1","status":"0"}]}单个任务查询接口A.接口功能单个任务查询接口。B.接口定义命令名称/wlx/task/02/viewHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokentaskidint非空任务id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idint非空任务IString非空终端号data.beginTimeString非空计划开始时间(yyyy-MM-ddHH:mm:ss)data.realBeginTimeString非空实际开始时间(yyyy-MM-ddHH:mm:ss)data.endTimeString非空结束时间(yyyy-MM-ddHH:mm:ss)data.taskDescString非空备注data.monUser.idString可空监控账户data.monUser.wechatOpenIdString可空微信公众号data.monUser.alarmTypeString非空报警类型SMS通知微信通知SMS&微信通知data.param.endvString可空结束值data.param.extvString可空扩展值data.param.extv2String可空扩展值2data.param.effctypeString可空报警类型1范围内2范围外3大于4小于5等于6进出围栏data.param.rptflagString可空是否报警(0不报警1报警2预警)data.param.idint可空参数Iddata.groups.idString组IString组名data.groups.devs.idString设备Iddata.groups.devs.devAliasString可空设备别名data.abilityList任务终端能力返回值类型含义String(JSON)返回查询的结果返回值说明<样例:查询成功{"result":"00","description":"查询成功","data":{"id":234,"name":"HP任务1",……"param":[{"type":"P002","startv":"北京","endv":"上海","extv":"121.52,31.1881;126.52,34.1881;","effctype":"1","rptflag":"0","typecn":""预设路径","id":124},{type":"P004",startv":"5",endv":"65",extv":"",effctype":"1",rptflag":"0",typecn":"湿度","id":125}]}}任务设备查询接口A.接口功能任务设备信息查询接口。B.接口定义命令名称/wlx/task/02/listdevHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokentaskidint非空任务id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idString非空设备iddata.devAliasString非空设备别名data.adminFlagString可空管理标识返回值类型含义String(JSON)返回查询的结果返回值说明<样例:查询成功{"result":"00","description":"查询成功","data":[{"devid":"2342GHJGYHWGG776789HGYHGTR5T4","devAlias":"Hp设备001","adminFlag":"001"}]}任务内设备最近上报信息查询接口A.接口功能查询组内设备最新上报信息接口。B.接口定义命令名称/report/02/viewbytaskHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokentaskidint非空任务id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述data.idString非空设备iddata.typeString可空报告类型(0普通2预警1报警)data.timeString可空报告时间data.locxString可空经度data.locyString可空纬度data.locnameString可空地点名称data.rpts.typeString可空上报类型代码P001围栏参数P002预设路径参数P003温度参数P004湿度参数P005电量参数P006光敏参数P007三轴撞击参数P008三轴倾斜参数P009三轴颠簸参数P010压力参数String可空名称(如:温度)data.rpts.valueString可空值(如:23.5摄氏度)data.rpts.descString可空描述(如:正常)返回值类型含义String(JSON)返回查询的结果返回值说明<样例:查询成功{"result":"00","description":"查询成功","data":[{"id":"2342GHJGYHWGG776789HGYHGTR5T4","type":"0","time":"1.0","locx":"123.3434340","locy":"31.343423423","locname":"上海陆家嘴","rpts":[{"type":"P003","name":"温度","value":"23.5","desc":"正常"},{"type":"P005","name":"电量","value":"40","desc":"正常"}]}]}任务开始接口A.接口功能任务开始接口。B.接口定义命令名称/wlx/task/02/startHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokentaskidint非空任务Id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述返回值类型含义String(JSON)返回查询的结果返回值说明<样例:开启任务成功{"result":"00","description":"开启任务成功"}任务结束接口A.接口功能任务开始接口。B.接口定义命令名称/wlx/task/02/stopHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokentaskidint非空任务Id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述返回值类型含义String(JSON)返回查询的结果返回值说明<样例:开启任务成功{"result":"00","description":"任务已结束"}任务报警数据查询A.接口功能查询主账号下已完成的任务报警汇总数据B.接口定义命令名称/wlx/task/02/statalarmsHttp方法Post/Get提交参数wf参数名类型长度可空标志说明uidString32非空主账号idatString非空会话tokentaskidsString非空任务id,多个之间用逗号返回参数返回值Excel文件按月统计监控账号的任务数量A.接口功能按月统计监控账号的运单数量B.接口定义命令名称/wlx/task/02/monthlystattaskHttp方法Post/Get提交参数wf参数名类型长度可空标志说明uidString32非空主账号idatString非空会话tokenisdivisionString返回参数resultString2非空返回代码descriptionString描述data.row.monthint消息iddata.row.totalString设备编号返回值{ "data":[{ "total":1, "month":"2016-04" }], "description":"", "result":"00"}新增任务模板接口A.接口功能 新增任务模板B.接口定义命令名称/wlx/tasktpl/02/addHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokennameString非空模板名称contentString非空模板内容返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述返回值类型含义String(JSON)返回查询的结果返回值说明<样例:{"result":"00","description":"添加成功"}修改任务模板接口A.接口功能任务模板修改接口。B.接口定义命令名称/wlx/tasktpl/02/updateHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokentplidint非空模板idnameString非空模板名称contentString非空模板内容返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述返回值类型含义String(JSON)返回结果返回值说明<样例:{"result":"00","description":"更改成功"}删除模板接口A.接口功能删除模板接口。B.接口定义命令名称/wlx/tasktpl/02/deleteHttp方法Post/Get提交参数参数名类型长度可空标志说明uidString32非空操作用户idatString非空会话tokentplidint非空模板id返回参数参数名类型长度可空标志说明resultString2非空返回代码descriptionString非空描述返回值类型含义String(JSON)返回结果返回值说明<样例:开启任务成

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论