魔力魔力哟接口文档

组织架构管理系统接口使用说明

接口规范说明

接口服务地址：http://192.168.4.155:8182/v2/api-docs
接口响应码表
响应码	说明	描述
0000	成功
1111	失败
1101	登录失败	账号或密码错误
1102	登录失败	非管理员账号
1103	登录失败	账号未激活或未授权
1104	前先登录	未登录时，操作其它接口

1. 用户模块
   1. 用户登录
      1. 
         
         请求协议
      2. 
         
         返回协议

字段名称	变量名	数据类型	默认值	值域	说明
接口编码
/api/tcar/add
输入参数
tcar
登录账号	Id	Int		M	必填
登录密码	Number	String		M
用户账号	Userid	String
用户名	Username	String			必填
请求方式
POST
请求地址（测试环境）
http://192.168.4.155:8182/api/tcar/add
请求示例
{ "account":"admin", "password":"123456" }

字段名称	变量名	数据类型	默认值	值域	说明
输出参数
返回编码	Code	Int		M	正确返回200
返回数据	Data	Object		O	返回前端所需要
返回信息	msg	String		0	返回的信息
业务参数
业务参数字符串，详见：各业务接口定义。
返回示例
{   "code": 200,   "msg": "success",   "data": [     {       "id": 3,       "number": "三号车位3423",       "username": "",       "userid": ""     },     {       "id": 4,       "number": "车位编号",       "username": "",       "userid": ""     },     {       "id": 5,       "number": "4534",       "username": "",       "userid": ""     }   ]}

1. 1. 用户添加
      1. 请求协议
      2. 返回协议

字段名称	变量名	数据类型	默认值	值域	说明
接口编码
/api/tcar/add
输入参数
tcar
登录账号	Id	Int		M	必填
登录密码	Number	String		M
用户账号	Userid	String
用户名	Username	String			必填
请求方式
POST
请求地址（测试环境）
http://192.168.4.155:8182/api/tcar/add
请求示例

字段名称	变量名	数据类型	默认值	值域	说明
输出参数
返回编码	Code	Int		M	正确返回200
返回数据	Data	Object		O	返回前端所需要
返回信息	msg	String		0	返回的信息
业务参数
业务参数字符串，详见：各业务接口定义。
返回示例
{   "code": 200,   "msg": "success",   "data": [     {       "fruit": "梨子",       "num": 121     },     {       "fruit": "苹果",       "num": 110     },     {       "fruit": "香蕉",       "num": 90     },     {       "fruit": "火龙果",       "num": 400     },     {       "fruit": "葡萄",       "num": 230     }   ]}

1. 1. 用户修改
      1. 请求协议
      2. 返回协议

字段名称	变量名	数据类型	默认值	值域	说明
接口编码
/api/tcar/add
输入参数
tcar
登录账号	Id	Int		M	必填
登录密码	Number	String		M
用户账号	Userid	String
用户名	Username	String			必填
请求方式
POST
请求地址（测试环境）
http://192.168.4.155:8182/api/tcar/add
请求示例
{ "id":2, "remark":"超级管理员" }

字段名称	变量名	数据类型	默认值	值域	说明
输出参数
返回编码	Code	Int		M	正确返回200
返回数据	Data	Object		O	返回前端所需要
返回信息	msg	String		0	返回的信息
业务参数
业务参数字符串，详见：各业务接口定义。
返回示例
{   "code": 200,   "msg": "success",   "data": [     {       "id": 3,       "number": "三号车位3423",       "username": "",       "userid": ""     },     {       "id": 4,       "number": "车位编号",       "username": "",       "userid": ""     },     {       "id": 5,       "number": "4534",       "username": "",       "userid": ""     }   ]}

1. 1. 用户删除
      1. 请求协议
      2. 返回协议

字段名称	变量名	数据类型	默认值	值域	说明
接口编码
/userInfo/delete
输入参数
ids[]
Id数组	ids	Integer		M	必填
请求方式
POST
请求地址（测试环境）
http://129.204.107.189:8888/userInfo/delete
请求示例
[1,2]

字段名称	变量名	数据类型	默认值	值域	说明
输出参数
调用是否成功	isSuccess	Boolean		M	调用服务本身是否成功，不表示业务成功失败类型
返回结果编码	code	String(8)		O	正确返回“0000”
返回信息	msg	String(128)		0
参数对象	data	*Json		0	响应参数Json格式
业务参数
业务参数字符串，详见：各业务接口定义。
返回示例
{     "data": null,     "code": "0000",     "msg": "删除成功",     "success": true }

1. 1. 用户分页查询
      1. 请求协议
      2. 返回协议

字段名称	变量名	数据类型	默认值	值域	说明
接口编码
/userInfo/queryPage
输入参数
RequestPage<T>
业务参数	params	T		M	UserInfo对象（选填）
每页数据条数	row	Integer		M	必填
页码	pageNo	Integer		M	必填
请求方式
POST
请求地址（测试环境）
http://129.204.107.189:8888/userInfo/queryPage
请求示例
{ "params":{ "id":1 }, "row":10, "pageNo":1 }

字段名称	变量名	数据类型	默认值	值域	说明
输出参数
调用是否成功	isSuccess	Boolean		M	调用服务本身是否成功，不表示业务成功失败类型
返回结果编码	code	String(8)		O	正确返回“0000”
返回信息	msg	String(128)		0
参数对象	data	*Json		0	响应参数Json格式
业务参数
业务参数字符串，详见：各业务接口定义。
返回示例
{     "data": {         "data": [             {                 "id": 1,                 "account": "12313213",                 "userName": "阿达",                 "password": "123456",                 "isAdmin": 1,                 "gender": null,                 "mobilePhone": null,                 "commpanyId": 1,                 "deptId": 2,                 "jobId": 1,                 "isAllow": null,                 "remark": null,                 "createTime": null,                 "isDelete": 0,                 "commpany": {                     "id": 1,                     "parentId": 0,                     "orgType": 1,                     "fullName": "足下科教集团",                     "enCode": "zuxiakejiaojituan",                     "manager": null,                     "mobilePhone": null,                     "email": null,                     "address": null,                     "remark": null,                     "createTime": null,                     "isDelete": 0,                     "childOrgInfo": null                 },                 "dept": {                     "id": 2,                     "parentId": 1,                     "orgType": 1,                     "fullName": "云南林业职业技术学院",                     "enCode": "yl",                     "manager": null,                     "mobilePhone": null,                     "email": null,                     "address": null,                     "remark": null,                     "createTime": null,                     "isDelete": 0,                     "childOrgInfo": null                 },                 "job": {                     "id": 1,                     "enCode": "javatcode",                     "jobName": "Java教员",                     "orgId": 2,                     "createTime": null,                     "isDelete": 0,                     "orgInfo": {                         "id": 2,                         "parentId": 1,                         "orgType": 1,                         "fullName": "云南林业职业技术学院",                         "enCode": "yl",                         "manager": null,                         "mobilePhone": null,                         "email": null,                         "address": null,                         "remark": null,                         "createTime": null,                         "isDelete": 0,                         "childOrgInfo": null                     }                 }             }         ],         "row": 10,         "pageNo": 1,         "count": 1,         "sumPage": 1     },     "code": "0000",     "msg": "查询成功",     "success": true }

1. 1. 根据ID查询用户信息
      1. 请求协议
      2. 返回协议

字段名称	变量名	数据类型	默认值	值域	说明
接口编码
/userInfo/queryById
输入参数
id
用户Id	id	int		M	必填
请求方式
POST
请求地址（测试环境）
http://129.204.107.189:8888/userInfo/queryById
请求示例
1

字段名称	变量名	数据类型	默认值	值域	说明
输出参数
调用是否成功