CIEP API接口文档

Chrome快速搜索定位:Ctrl+F

//前提
公共返回结果,假如参数为空,格式为:
{
    "code": "500",
    "msg": "参数为空",
    "data": null
}

可视化大屏接口-更新中 

(1)获取员工人数+管理员人数

/view/getCount

{
    "code": "200",
    "msg": "执行成功",
    "data": {
        "userCount": 17,
        "adminCount": 8
    }
}

(2)管理员根据角色划分的扇形图

/view/getList

{
    "code": "200",
    "msg": "执行成功",
    "data": {
        "count": 9,
        "list": [
            {
                "role_name": "超级管理员",
                "role_id": 1,
                "count": 4
            },
            {
                "role_name": "园区管理员",
                "role_id": 2,
                "count": 1
            },
            {
                "role_name": "企业管理员",
                "role_id": 3,
                "count": 1
            },
            {
                "role_name": "部门管理员",
                "role_id": 4,
                "count": 1
            },
            {
                "role_name": "普通员工",
                "role_id": 5,
                "count": 2
            }
        ]
    }
}

(3)获取过去其他的打点统计个数,员工总数

/view/getPathList

{
    "code": "200",
    "msg": "执行成功",
    "data": {
        "count": 17,
        "list": [
            {
                "count": 1,
                "time": "1615910400000"
            },
            {
                "count": 0,
                "time": "1615824000000"
            },
            {
                "count": 1,
                "time": "1615737600000"
            },
            {
                "count": 1,
                "time": "1615651200000"
            },
            {
                "count": 0,
                "time": "1615564800000"
            },
            {
                "count": 0,
                "time": "1615478400000"
            },
            {
                "count": 0,
                "time": "1615392000000"
            }
        ]
    }
}

(4)获取最新的(获取最新的(top 10)新闻动态)新闻动态

/view/getTodayInfo

{
    "code": "200",
    "msg": "执行成功",
    "data": {
        "newsList": [
            {
                "newsId": null,
                "title": "0317",
                "createdId": null,
                "mainImg": null,
                "content": null,
                "dateTime": "2021-03-17 11:56:10",
                "isNew": 1,
                "isShow": null
            }
        ],
        "noticeList": []
    }
}

 

 

 

 


用户组[后台管理系统]:

/group/addGroup
新增用户组
JSON格式

前端入参:
{
    "name" : "测试A组",     //必选
    "content" : "测试A组",  //可选
    "list" : [             //可选
        1,
        2,
        3
    ]
}

{
    "code": "200",
    "msg": "执行成功",
    "data": "创建用户组成功"
}

失败则code == 501,空指针code == 500
/group/deleteByGroupValueId
删除用户组中的一个成员
POST请求

入参:
id   Integer  主键id

code==200成功,code==501失败

/group/addByGroupValueId
某用户组增加一个成员
/group/deleteGroupById
删除某个用户组
POST请求

入参:
id  用户组id   必选

返回值同上
/group/selectGroupList
查找所有用户组

无参数

{
    "code": "200",
    "msg": "执行成功",
    "data": [
        {
            "groupId": 1,
            "groupName": "团支书一部",
            "groupContent": "团支书一部"
        }
    ]
}
/group/selectListByGroupId
根据用户组id查找所有成员
GET请求
id     用户组id    必选


{
    "code": "200",
    "msg": "执行成功",
    "data": [
        {
            "employName": "001",
            "employId": 1,
            "employNumber": "001"
        },
        {
            "employName": "2号园区",
            "employId": 2,
            "employNumber": "012"
        }
    ]
}
/notice/addNotice
添加通知和公告 
POST请求
JSON格式

入参: 
title      标题                 String      必选
sendRange  通知为1,公告为0       Integer     可选,默认为1
content    内容                 String      必选
receivers  发送对象-用户组       Integer     可选,默认为0:表示未设置具体用户组,大家都能看到!
status     状态                 Integer     可选 默认为1
add_user   通知发放人,可通过自己输入提供  String   可选

分页查询通知和公告 [有改动,未对接]:

/notice/selectPage
分页查询通知和公告
GET请求
Integer employId , String type , Integer pageNum, Integer pageSize

employId  必选                 员工id(注意注意,因为需要判断用户组!必选!)
type      可选,默认为notice    通知:notice;公告:announce
pageNum   可选,默认为1         第几页(1,2,3...)
pageSize  可选,默认为10        页大小


{
    "code": "200",
    "msg": "执行成功",
    "data": [
        {
            "id": 1,
            "title": "213",    //标题
            "sendRange": 1,
            "noticeType": "123",  
            "content": "123",    //内容
            "receivers": "1",
            "status": 1,
            "addUser": "园区A管理员",   //通知发放人
            "addTime": "2021-01-21 17:07:08",   //时间
            "editUser": "",
            "editTime": null
        }
    ]
}

静态资源获取:

获取启动图:http://localhost:7000/static/getById?id=1
获取首页顶部图:http://localhost:7000/static/getById?id=2
获得首页图表列表:localhost:7000/static/getListByType?type=HomeIcon

 

注:返回值data 等于 空字符串的时候,前端设置一张默认图片;


根据通知/公告id查看详情[未对接]: 

根据通知/公告id查看详情:
GET请求

http://localhost:7000/notice/selectNoticeDetailById?id=2


{
    "code": "200",
    "msg": "执行成功",
    "data": {
        "id": 2,
        "title": "大赛",
        "sendRange": 0,
        "noticeType": "114",
        "content": "大赛# 大赛",
        "receivers": "",
        "status": 1,
        "addUser": "admin",
        "addTime": "2020-11-23 11:59:23",
        "editUser": "admin",
        "editTime": "2021-01-07 05:21:09"
    }
}

 


修改头像headImg图片[未对接]

/emp/updateHeadImg
POST请求
FormData格式

参数:
file    文件类型    
employNumber  员工编号

返回值:
{
    "code": "200",
    "msg": "执行成功",
    "data": "修改头像成功"
}

 


修改密码[未对接]:

/emp/updatePass
POST请求

入参[JSON格式]:
{
    "employNumber": "001",
    "employPass": "123456",
    "newPass":"123456"
}


返回:
{
    "code": "200",
    "msg": "更新密码成功",
    "data": "更新密码成功"
}

{
    "code": "501",
    "msg": "旧密码输入错误",
    "data": "旧密码输入错误"
}

根据员工编号修改员工信息[仅限:姓名/年龄/头像地址] [未对接]:

/emp/updateEmploy
POST请求

入参:JSON格式: 
private String employNumber;  员工编号   必填 
private String employName;    姓名       可选
private Integer employSex;    性别       可选
private Integer employAge;    年龄       可选 
private String headImg;       头像       可选

{
    "code": "200",
    "msg": "修改成功->Employee(employId=null, employNumber=001, employPass=null, employName=null, employIdCard=null, employTel=null, employSex=null, employAge=123, companyId=null, status=null, deleted=null, roleId=null, departId=null, headImg=null)",
    "data": "修改成功->Employee(employId=null, employNumber=001, employPass=null, employName=null, employIdCard=null, employTel=null, employSex=null, employAge=123, companyId=null, status=null, deleted=null, roleId=null, departId=null, headImg=null)"
}

根据法律ID查询详情: 

http://localhost:7000/law/selectLawDetailById?id=1

GET请求

{
    "code": "200",
    "msg": "执行成功",
    "data": [
        {
            "lawType": 115,
            "lawContent": "1989年12月26日第七届全国人民代表大会常务委员会第十一次会议通过 ",
            "lawDes": "国家法规",
            "id": 1,
            "lawTitle": "中华人民共和国环境保护法(2014修订)"
        }
    ]
}

 

 


查询园区-企业-部门层级树:

/park/selectTree
GET请求
[
    {
        "parkName": "贵州赤水工业园区",
        "companyList": [
            {
                "companyId": 1,
                "companyName": "京东",
                "departList": [
                    {
                        "companyId": 1,
                        "departId": 1,
                        "departName": "研发3部"
                    }
                ],
                "parkId": 1
            }
        ],
        "parkId": 1
    },
    {
        "parkName": "自贡板仓工业园区",
        "companyList": [
            {
                "companyId": 2,
                "companyName": "淘宝",
                "departList": [],
                "parkId": 2
            }
        ],
        "parkId": 2
    },
    {
        "parkName": "3号园区",
        "companyList": [
            {
                "companyId": 3,
                "companyName": "天猫",
                "departList": [],
                "parkId": 3
            },
            {
                "companyId": 4,
                "companyName": "拼多多",
                "departList": [],
                "parkId": 3
            }
        ],
        "parkId": 3
    }
]

 


法律法规分页查询(未对接): 

/law/selectPage
分页查询法律法规,与查询通知/公告类似。
Get请求
pageNum   可选,默认为1         第几页(1,2,3...)
pageSize  可选,默认为10        页大小

{
    "code": "200",
    "msg": "执行成功",
    "data": [
        {
            "lawType": 115,
            "lawContent": "123",
            "lawDes": "国家法规",
            "id": 1,
            "lawTitle": "123"
        }
    ]
}

 


查询园区列表(待定): 

/park/selectParkList
GET请求
获取园区列表

[
    {
        "parkId": 1,
        "parkName": "贵州赤水工业园区",
        "parkInfo": "贵州赤水工业园区介绍",
        "parkAddress": "贵州赤水工业园区1号园区",
        "deleted": 0,
        "status": 1
    },
    {
        "parkId": 2,
        "parkName": "自贡板仓工业园区",
        "parkInfo": "自贡板仓工业园区介绍",
        "parkAddress": "自贡板仓工业园区",
        "deleted": 0,
        "status": 1
    },
    {
        "parkId": 3,
        "parkName": "3号园区",
        "parkInfo": "3号园区",
        "parkAddress": "3号园区",
        "deleted": 0,
        "status": 1
    }
]

 查询企业列表(待定): 

/park/selectCompanyList
GET请求
获取企业列表

{
    "code": "200",
    "msg": "执行成功",
    "data": [
        {
            "companyId": 2,
            "parkName": "自贡板仓工业园区",
            "companyInfo": "淘宝",
            "companyName": "淘宝",
            "parkId": "2"
        },
        {
            "companyId": 3,
            "parkName": "3号园区",
            "companyInfo": "天猫",
            "companyName": "天猫",
            "parkId": "3"
        },
        {
            "companyId": 4,
            "parkName": "3号园区",
            "companyInfo": "拼多多",
            "companyName": "拼多多",
            "parkId": "3"
        }
    ]
}

查询部门列表(待定):  

/park/selectDepartList
GET请求
获取部门列表


{
    "code": "200",
    "msg": "执行成功",
    "data": [
        {
            "companyId": 1,
            "companyName": "京东",
            "departId": 1,
            "departContent": "架构研发部",
            "departName": "研发3部"
        }
    ]
}

 


获取个人信息 

获取个人信息
/emp/myInfo

入参:
employNumber    String   员工编号 

 

{
    "code": "200",
    "msg": "执行成功",
    "data": {
        "employName": "1号园区",
        "companyId": "1",
        "roleId": 5,
        "companyName": "京东",
        "roleName": "普通员工",
        "departId": 1,
        "employId": 1,
        "employNumber": "001",
        "departName": "研发3部"
    }
}

 


 

轨迹接口新增:

轨迹新增
/path/addPath
POST
pathId  
employId           Integer  必选!                  员工id
time               String   自动后台生成,不选        打点时间
location           String   可选                    位置
power              String   可选                    电量
gpsOpen            String   可选
wifiOpen           String   可选
wifiConnect        String   可选 
lng                String   必选!                   经度 
lat                String   必选!                   纬度
trajectoryStatus   Integer  默认为1,后台设置,不选   
//执行成功
{
    "code": "200",
    "msg": "执行成功",
    "data": "新增轨迹点成功;1米"
}

//执行失败
{
    "code": "501",
    "msg": "执行失败",
    "data": "相距 = 0;距离上一点太短,不记录!最低临界值:1"
}

{
    "code": "501",
    "msg": "执行失败",
    "data": "相距 = 10883;距离上一点太长,不记录!最大临界值10000"
}

 


轨迹接口查询(按员工ID,开始时间和结束时间): 

/path/queryPathListByEmployId
根据员工id+起始时间戳+终止时间戳,查询轨迹点列表
GET请求
employId   Integer   员工id       必选
timeFrom   String    起始时间戳    必选
timeEnd    String    终止时间戳    必选
{
    "code": "200",
    "msg": "执行成功",
    "data": [
        {
            "pathId": 41,
            "employId": 1,
            "time": "1609640277660",
            "location": null,
            "power": null,
            "gpsOpen": null,
            "wifiOpen": null,
            "wifiConnect": null,
            "lng": "12.23",
            "lat": "12.12",
            "trajectoryStatus": "1"
        },
        {
            "pathId": 42,
            "employId": 1,
            "time": "1609640361288",
            "location": null,
            "power": null,
            "gpsOpen": null,
            "wifiOpen": null,
            "wifiConnect": null,
            "lng": "12.23",
            "lat": "12.12",
            "trajectoryStatus": "1"
        }
    ]
}

//该时间范围内,没有点记录,查询出来为空
{
    "code": "200",
    "msg": "执行成功",
    "data": []
}

 


//员工登录接口-已完成
/emp/empLogin
post请求
//入参:
employNumber    String  员工编号   必填
employPass      String  员工密码   必填
{
    "code": "200",
    "msg": "员工登录成功",
    "data": {
        "employName": "1号园区",
        "companyId": "1",
        "roleId": 5,
        "companyName": "京东",
        "roleName": "普通员工",
        "departId": 1,
        "employId": 1,
        "employNumber": "001",
        "departName": "研发3部"
    }
}

 


 

//查看最新版本接口-未完成
/version/getNewestVersion
get请求
入参:无
返回值:
{
    "code": "200",
    "msg": "执行成功",
    "data": {
        "versionId": 1,
        "name": "V 0.0.0",
        "content": "初版",
        "updatetime": "2020-12-30 12:12:12"
    }
}

{
    "code": "300",
    "msg": "员工编号或密码错误!",
    "data": null
}

 


新闻新增 

//新闻接口
/news/addNews
post请求

 

入参:
title    String    必选!    标题
content  String    必选!    内容
createdId Integer  必选!    创建人ID,即员工ID
isNew    Integer   可选,默认为新闻    1-新闻    0-动态
isShow   Integer   可选,默认为展示    0-不展示  1-展示

 

{
    "code": "200",
    "msg": "执行成功",
    "data": {
        "newsId": 28
    }
}


上传图片 

//上传新闻的图片-单图片上传
入参:
file   file对象     必选
newsId   新闻id     必选

 

{
    "code": "200",
    "msg": "执行成功",
    "data": "68748b0de08200eab514c6208aca4a46.png"
}


新闻查询分页 

新闻查询分页
GET请求   json格式
/news/queryNewsListByPage

 

pageNum   必选           Integer 
pageSize  必选           Integer 
isShow    可选,默认为1    Integer     0/1
isNew     可选,默认为1    Integer     0/1
{
    "code": "200",
    "msg": "执行成功",
    "data": [
        {
            "dateTime": "2020-12-22 17:22:18",
            "employName": "1号园区",
            "roleId": 5,
            "companyName": "京东",
            "createdId": "1",
            "title": "标题",
            "content": "主题",
            "newsId": 1,
            "companyId": 1,
            "roleName": "普通员工",
            "departId": 1,
            "employNumber": "001",
            "departName": "研发3部",
            "imgList": [
                {
                    "imgId": 1,
                    "newsId": 1,
                    "imgLocation": "4f11284ddd29211b6a2b921f2daa8534.jfif",
                    "imgSm": null
                },
                {
                    "imgId": 2,
                    "newsId": 1,
                    "imgLocation": "931ef2b5c19c2a460a7087fda344db2f.jpg",
                    "imgSm": null
                }
            ]
        }
    ]
}

根据ID查新闻或动态

根据 id查详情
/news/queryNewsDetailById
get请求   
ex:  http://localhost:7000/news/queryNewsDetailById?newsId=14

 

newsId   必选   新闻id    

 

{
    "code": "200",
    "msg": "执行成功",
    "data": {
        "dateTime": "2020-12-23 17:48:18",
        "employName": "1号园区",
        "mainImg": "68748b0de08200eab514c6208aca4a46.png",
        "roleId": 5,
        "companyName": "京东",
        "createdId": "1",
        "title": "标题",
        "content": "主题",
        "newsId": 14,
        "companyId": 1,
        "roleName": "普通员工",
        "departId": 1,
        "employNumber": "001",
        "departName": "研发3部",
        "imgList": [
            {
                "imgId": 25,
                "newsId": 14,
                "imgLocation": "4f11284ddd29211b6a2b921f2daa8534.jfif",
                "imgSm": null
            },
            {
                "imgId": 26,
                "newsId": 14,
                "imgLocation": "931ef2b5c19c2a460a7087fda344db2f.jpg",
                "imgSm": null
            },
            {
                "imgId": 27,
                "newsId": 14,
                "imgLocation": "68748b0de08200eab514c6208aca4a46.png",
                "imgSm": null
            }
        ]
    }
}

{
    "code": "501",
    "msg": "执行失败",
    "data": null
}

根据ID删除新闻或动态

根据新闻id删除新闻
/news/deleteNewsById
入参:
newsId 必选  新闻id
{
    "code": "200",
    "msg": "执行成功",
    "data": null
}

{
    "code": "501",
    "msg": "执行失败",
    "data": null
}

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值