《开发接口文档PI文档.doc》由会员分享,可在线阅读,更多相关《开发接口文档PI文档.doc(6页珍藏版)》请在三一文库上搜索。
1、XXX项目接口文档版本控制信息版本日期描述作者V1.02018-8-13创建XXX1 获取所有字段1.1获取所有字段请求地址:/session/field/findAII请求参数参数名必填字段类型描述name是String根据名称筛选响应code10000成功,-1系统错误,10001必填参数为空message响应描述result如响应例子响应例子:"code":"10000","exception":null,"isSuccess":true,"message":"成功,系统处理正常
2、!","page":0,"pageSize":0,"returnObject":null,"returnValue":"types":null,"villages":null,"companys":"iconColour":"","iconSize":0,"iconStyle":"","id":4,"name"
3、;:"XX","iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX", "iconColour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX&qu
4、ot;,"totals":02 文件上传2.1文件上传(ajax )codemessageresult10000成功,-1系统错误,10001必填参数为空响应描述如响应例子请求地址:/session/file/upload请求参数参数名必填字段类型描述file是FormDataFormData 对象包含的文件响应请求例子:var formData = new FormData();formData.append("file", this.files0);$.ajax(url : routePath + "/session/file/upload
5、".type : 'P OST', data : formData, processData : false,contentType : false,success : function(result) result = JSON.parse(result);if(result.code = "10000")layer.msg('上传成功!'););响应例子:returnValue 里包含了 fileName 和 filePath3 字段管理-所属类型3.1新增所属类型请求地址:/session/fieldType/save请求参数
6、参数名必填字段类型描述name是String所属类型名称响应code10000成功,-1系统错误,10001必填参数为空message响应描述result如响应例子响应例子:"code":"10000","exception":null,"isSuccess":true,"message":"成功,系统处理正常!","page":0,"pageSize":0,"returnListSize":0,"retu
7、rnObject":null,"returnValue":null,"totals":03.2修改所属类型请求地址:/session/fieldType/update请求参数参数名必填字段类型描述id是Long所属类型idname是String所属类型名称messageresult响应描述如响应例子响应例子:"code":"10000","exception":null,"isSuccess":true,"message":"成功,系统
8、处理正常!","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":03.3根据id获取所属类型请求地址:/session/fieldType/getByldcodemessageresult10000成功,-1系统错误,10001必填参数为空响应描述如响应例子请求参数参数名必填字段类型描述id是Long所属类型id响应成功,系统处理正常!响应
9、例子:"code":"10000","exception":null,"isSuccess":true,"message":"","page":0,"pageSize":0,"returnListSize":0,"return0bject":null,"returnValue":"id":2,"name":"re",&
10、quot;totals":03.4获取所属类型列表请求地址:/session/fieldType/selectAll请求参数参数名必填字段类型描述name否String根据类型名称筛选messageresult响应描述如响应例子成功,系统处理正常!响应例子:"code":"10000","exception":null,"isSuccess":true,"message":"","page":0,"pageSize":0,&q
11、uot;returnObject":null,"returnValue":"id":1,"name":"123","id":6,"name":"145555","total s":23.5删除所属类型(批量)请求地址:/session/fieldType/deleteBylds请求参数参数名必填字段类型描述ids是List所属类型id集合响应codemessageresult10000成功,-1系统错误,10001必填参数为空响应描述如响应例子成功,系统处理正常!响应例子:"code":"10000","exception":null,"isSuccess":true,"message":"