云朵后台接口文档

最新推荐文章于 2024-07-17 15:38:20 发布
最新推荐文章于 2024-07-17 15:38:20 发布
阅读量2.9k 收藏
点赞数
分类专栏： 项目文档 文章标签： 文档
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_26453171/article/details/78030221
版权

云朵后台接口文档

概述

云朵是一款专注于学生的教育app,立足于学生每次考试的大数据容量,依托特色的知识点体系分析,着力于为广大学生提供更针对,更具体的教育资源,为学生更好的提高自己提供科学化的方案

开发指南

简介

系统后台采用spring+springMVC+JDBC构建,为前端Android及ios提供接口支持.系统架构轻量,当前系统主要包含以下几个模块

  • 基础接口 commom 包含登录,注册,用户相关操作等
  • 学生成绩 stuScore

通用方法 commom

jhmm库用户登录 commom/jhmmLogin.do （同步sso）
传入参数 
    loginName  登录名
    password   密码（已加密）
返回参数
{
    "userUid":5530121,                  //  用户Uid
    "userName":"肖祖逸",           //  用户名
    "userType":"10",            //  用户类型：10-学生  20-教师  30-家长
    "sex":"0",              //  性别：0-未知  1-男  2-女
    "headPortrait":"http://192.168.0.30:8083/jhapp/images/road_from_default_pic/10181.png"  //头像图片url
    classesInfo:[
    {
    "schoolName":"汉口辅仁小学",       
    "classesName":"小学五年级07班",   //用来获取群组消息建socket，classesUid即为groupId
    "schoolUid":10086,
    "classesUid":4140385,
    "unReadNum:10
    }
    ],
    "flag":1,                 // 通用标示：flag=0 则表示失败，应不再进行下面的操作，直接读"msg"
    "msg":"登录成功！"   //服务端返回错误原因  flag时读取
}
jhmm库用户登录 commom/loginByUserUid.do （通过userUid登录，不同步sso）
传入参数 
    userUid 用户Uid
返回参数
{
    "userUid":5530121,                  //  用户Uid
    "userName":"肖祖逸",           //  用户名
    "userType":"10",            //  用户类型：10-学生  20-教师  30-家长
    "sex":"0",              //  性别：0-未知  1-男  2-女
    "headPortrait":"http://192.168.0.30:8083/jhapp/images/road_from_default_pic/10181.png"  //头像图片url
    classesInfo:[
    {
    "schoolName":"汉口辅仁小学",       
    "classesName":"小学五年级07班",   //用来获取群组消息建socket，classesUid即为groupId
    "schoolUid":10086,
    "classesUid":4140385,
    "unReadNum:10
    }
    ],
    "flag":1,                 // 通用标示：flag=0 则表示失败，提示登录过期，否则不管
    "msg":"登录成功！"   //服务端返回错误原因  flag时读取
}
修改用户密码 systemUsers/modifyPwd.do （同步sso）
传入参数 
    userUid  用户Uid
    oldPassword   旧密码（已加密）
    newPassword   新密码（已加密）
返回参数
{
    flag   //通用标示
    msg    //返回的文本提示 包含各种文本 修改成功，失败，旧密码不对，密码为空，用户不存在等等
}
上传用户头像 systemUsers/JhmmUploadHeadPortrait.do
传入参数 
    userUid  用户Uid 
    attachments     图片文件    file类型
返回参数
{
    headPortrait //新头像绝对地址
    flag   //通用标示
    msg    //返回的文本提示 包含各种文本 修改成功，失败，旧密码不对，密码为空，用户不存在等等
}
发送手机验证码 smssApp/appSendPhoneCode.do
传入参数 
    loginName  登录名
    password   密码（已加密）
    phone 手机号（传此项为绑定手机号发送验证码，登录发验证码不传此项）
返回参数
{
    "code":553012,                  //  验证码
    "flag":1,           //  状态标识 1-发送成功  0-发送失败,请直接显示msg 201-未绑定手机号,跳转到绑定手机号页面
    "msg":"获取成功",           //  提示语
}
绑定手机号 smssApp/bindPhone.do
传入参数 
    loginName  登录名
    password   密码（已加密）
    phone 手机号（要绑定的）
返回参数
{
    "flag":1,           //  状态标识 1-发送成功  0-绑定失败,请直接显示msg 
    "msg":"获取成功",     //  错误提示语
}

yunduoApp首页 homePage

获取首页数据接口 homePage/getHomePage.do
传入参数 
    userUid 用户Uid
    noticePageNum 通知的页数 从1开始
    noticePageSize  每页的数量 默认15
返回参数
{
    "userUid":5530121,                  //  用户Uid
    "userName":"肖祖逸",           //  用户名
    "userType":"10",            //  用户类型：10-学生  20-教师  30-家长
    "sex":"0",              //  性别：0-未知  1-男  2-女
    "headPortrait":"http://192.168.0.30:8083/jhapp/images/road_from_default_pic/10181.png" , //头像图片url
    "carouselFigure":[    //首页轮播图List
        "http://59.175.213.78:30164/jhapp/images/carouselFigure/1.png",
        "http://59.175.213.78:30164/jhapp/images/carouselFigure/1.png",
        "http://59.175.213.78:30164/jhapp/images/carouselFigure/1.png"
    ],
    "noticeMap":{ //下方区级通知的消息
        "notices":[  //通知列表  list
            {
            "noticeTitle":"你好", //标题
            "noticeNote":"今天下午没课" //正文
            "noticeDatetime":"2017-10-30 17:11:20", //时间
            "creatorUid":11, //创建人
            "noticeDept":10180, //通知发行的机构
            "noticeUid":6,  //通知Uid
            "noticeUrl":"http://www.daluob.com", //网址链接,暂时不管            
            "enableId":"1",
            "contentDetailUrl":
        "http://192.168.0.73:30164/jhapp/homePage/getNoticeDetail.do?noticeUid=3&userUid=5457051"//点击直接进入详情页
            }
        ],
        "pageTotalCount":27,
        "pageTotalPage":2//总页数
        "pageSize":15,
        "pageNum":1
    }
    "flag":1,                 // 通用标示：flag=0 则表示失败，提示登录过期，否则不管
    "msg":"获取首页成功！"   //服务端返回错误原因  flag为0时读取
}

yunduoApp demo相关

获取折线图/知识地图/体育三个Div yunduoApp/getAllDiv.do 的链接接口
传入参数
    userUid  用户Uid
返回参数
{
    "scoreUrl":"http://192.168.0.30:8083/jhapp/yunduoApp/getScore.do?userUid=5530121",//折线图接口
    "knowitemMapUrl":"http://192.168.0.30:8083/jhapp/yunduoApp/getKnowiteMap.do?userUid=5530121",//知识地图接口
    "physicalUrl":"http://192.168.0.30:8083/jhapp/yunduoApp/getPhysical.do?userUid=5530121&gradeType=11",//体育接口
    "msg":"获取路径成功",
    "flag":1
}

注：折线图已实现；知识地图已实现，体育已实现

返回体育成绩数据 yunduoApp/getPhysical.do
传入参数
    userUid  用户Uid
    gradeTypeId  年级Id
返回参数
    {"myHealth":[     //一般项成绩 如肺活量，一分钟跳绳等  可能为空
            {"health_level_name":null,         //等级  如及格，优秀
            "health_item_name":"体重身高指数", //项目名  如肺活量，一分钟跳绳
            "health_item_unit":"",         //单位  没有为空
            "user_name":"黄数",          //用户名  无意义项
            "my_health_score":60,              //得分
            "user_uid":3928084,        //
            "my_health_data":"25.3         //数据  如120
            }
            ,{"health_level_name":"及格","health_item_name":"总分","health_item_unit":"","user_name":"黄数","my_health_score":76.4,"user_uid":3928084,"my_health_data":null}
           ],
    "myHealthST":[  //身高体重数据
            {"health_level_name":null,
            "health_item_name":"身高",
            "health_item_unit":"厘米",
            "user_name":"黄数",
            "my_health_score":null,
            "user_uid":3928084,
            "my_health_data":"167.2"
            },
            {"health_level_name":null,"health_item_name":"体重","health_item_unit":"公斤","user_name":"黄数","my_health_score":null,"user_uid":3928084,"my_health_data":"70.6"}],
    "myHealthScore":76.4,  //体育得分
    "flag":1,              //通用标示
    "msg":"获取学生体育成绩成功"    //
}
返还三个demodiv
  • yunduoApp/getScore.do 返回成绩折线图Div
传入参数
    userUid 用户Uid
    type   查询类型  1-外面小图   其它或不传-详细图
    width  div宽度
    height div高度
返回参数
    html页面


  • yunduoApp/getKnowiteMap.do 返回知识点Div 

传入参数
    userUid 用户Uid
    type   查询类型  1-外面小图   其它或不传-详细图
    width  div宽度
    height div高度
返回参数
    html页面


  • yunduoApp/getPhysicalDiv.do 返回体育成绩Div 


 

传入参数 

userUid 用户Uid 

type   查询类型  1-外面小图   其它或不传-详细图  

返回参数 

html页面

注：pony做了自适应，不需要传width和height

appMessage app消息系统

获取用户发送与接受的消息 appMessage/myNews.do
传入参数
    userUid     用户Uid  5693563
    pageSize    接受的信息分页数量  //不传默认为30 传0为返回所有
    pageNum     接受的信息当前页码（从1开始）//不传默认为1

    pageSizeS   发出的的信息分页数量  //不传默认为30 传0为返回所有
    pageNumS    发出的的信息当前页码（从1开始）//不传默认为1
返回参数
{
    "getMessage":{   //收到的消息
        "result":[                      //具体收到的消息list
            {
                "messageUid":3,         //消息Uid
                "messageMemberUid":2,           //分消息uid
                "editTime":"2016-12-15 14:13", //消息创建的时间
                "userUid":3736049,      //发送人uid
                "userName":"summer",        //发送人账号
                "messageRead":"0",      //0-未读   1-已读
                "messageNote":"这是我收到的 --- summer to herb",  //消息文本
                "messageTitle":"我是标题"   //消息标题
            }
            ],
        "pageSize":30,   //分页行数
        "pageTotalCount":1,  总数据量
        "pageNum":1 //当前页码
        },
    "unReadMessagenum":1,  //未读的数目,所有数目在上面的pageTotalCount
    "sendMessage":{ //发出的信息
        "result":[   //发出的信息的list
            {
                "messageUid":3,         //消息Uid
                "messageMemberUid":1,       //分信息uid
                "editTime":"2016-12-15 14:12",  //信息创建的时间
                "userUid":3736049,      //接收人uid
                "loginName":"summer",       //接收人登录名
                "userName":"y111",      //接收者姓名
                "messageNote":"这是我发出的--herb to summer",   //文本
                "messageTitle":"我是标题"   //消息标题
            }
            ],
        "pageSize":30,
        "pageTotalCount":1,
        "pageNum":1
        },
    "flag":1,
    "msg":"获取成功！"
}

注：page（pageSize，pageNum，pageTotalCount）以后不再赘述

发送消息 appMessage/newMessage.do （接受者登录名应先校验，校验用下一个方法）
传入参数
    userUid  当前用户Uid
    messageTitle   消息标题
    messageNotes 消息文本
    userLoginName 接受人loginName（多个用@隔开）
返回参数
{
    flag
    msg
}
校验登录名是否存在 appMessage/checkUserLoginName.do

传入参数
    userUid  当前用户Uid
    userLoginName 接受人loginName（多个用@隔开）
返回参数
{
    flag,
    msg   //最后一个校验失败的人的loginName
}

注：暂未使用

#### 删除信息 appMessage/delMessage.do ####


传入参数
    userUid  当前用户Uid
    selectedUids  消息Uid（多个用,隔开） 参见消息列表的messageMemberUid
返回参数
{
    flag,
    msg,   
    count  //删除的信息的数目
}
标记为已读 appMessage/messageRead.do

传入参数
    userUid  当前用户Uid
    selectedUids  消息Uid（多个用,隔开） 参见消息列表的messageMemberUid
返回参数
{
    flag,
    msg,   
    count  //标记为已读的信息的数目
}
读取消息 appMessage/lookMessage.do

传入参数
    userUid  当前用户Uid
    messageUid  消息Uid（多个用,隔开） 参见消息列表的messageUid
    type  消息类型  get--得到的消息  send--发出的消息
返回参数
    {
    "iMessage":{        //消息参数
            "messageUid":2,  //消息Uid
            "editTime":"2016-12-15 00:00",
            "userUid":3736049,  //发送人
            "messageNote":"这是我收到的 --- summer to herb",  //文本信息
            "messageTitle":"我是标题"   //消息标题

        },
    "type":"send",   //消息类型
    "userLoginNames":"herb", //接受人或的发送人loginName 依据上面的type  get-发送人  send-接收人
    "userNames"  //接受人或的发送人userName 依据上面的type  get-发送人  send-接收人
    "msg":"获取成功！",
    "flag":1
}

appExamEvaluate app考试评价系统（及历史考试）

注：暂未使用

获取我的考试列表 appExamEvaluate/myExamList.do

传入参数
    userUid     用户Uid  5457051
    pageSize    接受的信息分页数量  //不传默认为30  传0为返回所有 
    pageNum     接受的信息当前页码（从1开始）//不传默认为1

返回参数
{
    "bannerData":[   //banner数据项
        ["调考","校考","能力测试","共有"],
        ["6次","27次","4次","37次"]
    ]
    "examList":[    //考试信息list
        {
        "exam_name":"回民201504综合练习一",  //考试名
        "exam_uid":7234827,//考试uid
        "exam_type_name":"一般考试",         //考试类型  1一般考试 2调考 3能力测试
        "exam_time":"2015-04-15",        //考试日期
        "user_name":"吴琪",            //用户名
        "school_name":"回民小学",        //所属学校
        "class_name":"小学一年级01班",         //班级
        "exam_score_uid":6978274, //成绩uid
        "exam_score_status_id":"9,//分数状态id" 0:未完成登分 7:健康状况 8:缺考 9:正常成绩
        "course_id":14 ,//考试科目id
        "course_name":"数学",  //考试科目名称
        "exam_score":"88.0",     //实际分数 可能字段:"缺考","未发布分数"
        "exam_standard_score":"92.8", //标准分
        "level":1//分数等级  1:A+ 2:A 3:B+ 4:B 5:C+ 6:C
        "exam_stu_no":"03011017",            //考号
        "exam_paper_total":100 ,             //试卷总分
        "exam_room_no":1,            //考场号  此代表第1考场
        "exam_stu_no_uid":5679934,       //考场安排Uid，无意义
        "classes_uid":305068, //考试时所属的班级uid
        "grade_type_id":15,//年级类型uid
        "school_uid":10154,//学校Uid
        "statInfo:{  //统计信息(map)
            "avg_score":80 //平均分
            "max_score":98,//最高分
            "ranking":"暂无",//排名
            "riseRanking":"暂无",//上升排名
            "all_num":145,//人数(有效分数)
            }
        },
    "pageNum":1,
    "pageSize":30,
    "pageTotalCount":39,
    "pageTotalPage":2, //总页数
    "flag":1,
    "msg":"获取考试信息成功！ "
}
获取单次考试的评价appExamEvaluate/getExamEvaluateByScoreUid.do

传入参数
    userUid     用户Uid  5457051
    examScoreUid 分数Uid(参见上个接口返回的exam_score_uid) 6457976

返回参数
{
    //---------------------------------------------------------
    "examInfo":{   //考试信息Map        
        "exam_name":"回民201504综合练习一",  //考试名
        "exam_uid":7234827,//考试uid
        "exam_type_name":"一般考试",           //考试类型  1一般考试 2调考 3能力测试
        "exam_time":"2015-04-15",        //考试日期
        "user_name":"吴琪",            //用户名
        "school_name":"回民小学",        //所属学校
        "class_name":"小学一年级01班",         //班级
        "exam_score_uid":6978274, //成绩uid
        "exam_score_status_id":"9,//分数状态id"
        "course_id":14 ,//考试科目id
        "course_name":"数学",  //考试科目名称
        "exam_score":"88.0",     //实际分数 可能字段:"缺考","未发布分数"
        "exam_standard_score":"92.8", //标准分
        "level":1//分数等级  1:A+ 2:A 3:B+ 4:B 5:C+ 6:C
        "exam_stu_no":"03011017",            //考号
        "exam_paper_total":100 ,             //试卷总分
        "exam_room_no":1,            //考场号  此代表第1考场
        "exam_stu_no_uid":5679934,       //考场安排Uid，无意义
        "classes_uid":305068, //考试时所属的班级uid
        "grade_type_id":15,//年级类型uid
        "school_uid":10154,//学校Uid
        "statInfo:{  //统计信息(map)
            "avg_score":80 //平均分
            "max_score":98,//最高分
            "ranking":"暂无",//排名
            "riseRanking":"暂无",//上升排名
            "all_num":145,//人数(有效分数)
            }
    },
    //---------------------------------------------------------
    "topicRadar":{         //小题分析雷达图
        "titleName":["我的","平均"],  //分类
        "myScore":[18,18,4,4,24,26],   //我的
        "avgScore":[17.3,15.9,3.3,3.5,20.3,23],  //平均分
        "totalScore":[18,18,4,4,26,30], //总分 (轴最大值)
        "indicatorName":["第1题","第2题","第3题","第4题","第5题","第6题"], //类目(轴名称)
        "explainName":["第1题：填空题","第2题：单项选择题","第3题：判断题","第4题：阅读材料，按要求答题","第5题：阅读短文，完成练习","第6题：习作"] //解释(轴名称)
    },
    //---------------------------------------------------------
    ""topicTable":{   //小题分析数据
        "titleName":"小题得分点",
        "topicTableList":[   //小题分数评价表格  (数据可直接按行展示)
            ["名称","得分(总分)","得分率","题目难度"],  //数据  表头
            ["填空题","18.0(18.0)","100.0%","0.04(易)"],  //题目1数据
            ["单项选择题","18.0(18.0)","100.0%","0.12(易)"],//题目2数据
            ["判断题","4.0(4.0)","100.0%","0.18(易)"],
            ["阅读材料，按要求答题","4.0(4.0)","100.0%","0.13(易)"],
            ["阅读短文，完成练习","24.0(26.0)","92.31%","0.22(易)"],
            ["习作","26.0(30.0)","86.67%","0.23(易)"]
    ],
    //---------------------------------------------------------
    "scoreSection":{  //全区一分一段图
        "titleName":"全区排名",//标题
        "min":0,  //x轴起始坐标
        "max":100,  //X轴终止坐标
        "myScore":94,  //我的分数,用于定点
        "defeat":"97.57%", //打败比例
        "Ranking":59, //排名
        "stuTotal":3757,//参加考试的有效成绩人数
        "sectionNum":  [//一分一段的人数  从0开始到最大坐标
                0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,
                0,0,0,1,0,0,0,0,1,0,0,0,1,0,0,1,0,1,0,0,
                1,2,1,1,0,0,3,1,1,2,0,1,2,0,2,1,3,1,7,6,
                12,7,10,6,5,11,15,15,17,20,21,37,42,38,54,
                71,70,82,103,129,176,194,203,247,258,293,
                275,294,217,221,160,98,71,39,26,13,2,1,0,0
                ],  
        "sectionNumAll":[//一分一段的累积人数 从0开始到最大坐标
                0,0,0,0,0,0,0,0,0,0,0,0,0,0,
                0,1,1,1,1,1,1,1,1,2,2,2,2,2,
                3,3,3,3,4,4,4,5,5,6,6,6,7,9,
                10,11,11,11,14,15,16,18,
                18,19,21,21,23,24,27,28,
                35,41,53,60,70,76,81,92,
                107,122,139,159,180,217,
                259,297,351,422,492,574,
                677,806,969,1145,1339,1542,
                1789,2047,2340,2615,2909,
                3126,3347,3507,3605,3676,
                3715,3741,3754,3756,3757,3757,3757
            ]
    },
    "scoreSection":{  //班级一分一段图(结构和上面的一样)
        "titleName":"班级排名",//标题
        "min":0,  //x轴起始坐标
        "max":100,  //X轴终止坐标
        "myScore":94,  //我的分数,用于定点
        "defeat":"97.57%", //打败比例
        "Ranking":59, //排名
        "stuTotal":35,//参加考试的有效成绩人数(班级)
        "sectionNum":  [//一分一段的人数  从0开始到最大坐标
                0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,
                0,0,0,1,0,0,0,0,1,0,0,0,1,0,0,1,0,1,0,0,
                1,2,1,1,0,0,3,1,1,2,0,1,2,0,2,1,3,1,7,6,
                12,7,10,6,5,11,15,15,17,20,21,37,42,38,54,
                71,70,82,103,129,176,194,203,247,258,293,
                275,294,217,221,160,98,71,39,26,13,2,1,0,0
                ],  
        "sectionNumAll":[//一分一段的累积人数 从0开始到最大坐标
                0,0,0,0,0,0,0,0,0,0,0,0,0,0,
                0,1,1,1,1,1,1,1,1,2,2,2,2,2,
                3,3,3,3,4,4,4,5,5,6,6,6,7,9,
                10,11,11,11,14,15,16,18,
                18,19,21,21,23,24,27,28,
                35,41,53,60,70,76,81,92,
                107,122,139,159,180,217,
                259,297,351,422,492,574,
                677,806,969,1145,1339,1542,
                1789,2047,2340,2615,2909,
                3126,3347,3507,3605,3676,
                3715,3741,3754,3756,3757,3757,3757
            ]
    },
    //---------------------------------------------------------
    "knowItemTable":{
        "titleName":"最差知识点排行", //标题
        "min":0,                                   //绘图时最小值
        "max":100,                              //绘图时最大值       
        "knowItemTableData":[ //具体数据  知识点名称-知识点标准分-打败人数(掌握情况)-等级(1:A+ 2:A 3:B+ 4:B 5:C+ 6:C)
            ["小数的加减运算",77.22,"41.38",1],
            ["图形平移的应用",77.78,"44.83",4],
            ["图形对称的应用",77.79,"44.83",4],
            ["观察物体",77.78,"44.83",5],
            ["除法的性质",78.44,"44.83",6],
            ["减法的性质",78.44,"44.83",4]
        ]
    },
    //---------------------------------------------------------
    "historyScore":{
            "titleName":"历史成绩",  //标题
            "min":0,   
            "max":100,
            "myScore":[   //我的分数  没有分数为 "-"
                    91,98,97,91,92,96,88,99,100,
                    89.5,91,93.5,96,93,92,88]
            "myStandardScore":[  //标准分
                    98.5,95.8,95.5,91.3,87.5,94,87.4,94.3,95.9,
                    92.1,96.2,92.9,90.9,97.9,95.9,92.8],
            "avgScore":[  //所有参加考试的平均分
                    66.42,76.43,76.24,73.77,80.84,79.03,79.98,77.76,
                    76.91,71.78,64.45,71.2,77.07,60.35,65.97,66.37],
            "examTime":[ //考试时间  X轴
                    "2015-11-24","2015-12-15","2016-01-21",
                    "2016-04-07","2016-05-26","2016-06-13",
                    "2016-06-28","2016-10-18","2016-11-18",
                    "2016-12-07","2017-01-12","2017-04-06",
                    "2017-04-26","2017-05-16","2017-06-06",
                    "2017-06-27"],
            "examName":[ //考试名称
                    "邬小201511","邬小201512","20160121邬家期末考试",
                    "邬小201604","邬小201605","邬小201506",
                    "20160628邬家期末考试","邬小201610",
                    "邬小201611（一、二、三、五年级）","邬小201612",
                    "20170112邬家墩小学期末考试",
                    "邬小201704（一、二、三、五年级）",
                    "2017.4.26.区期中单项测试","邬小201705（三、五年级)",
                    "邬小201706（三、四、五、六）",
                    "201706邬家墩小学全区期末考试"],
            "examType":[  //考试类型  1一般考试 2调考 3能力测试
                    "1","1","1","1","1","1","1","1",
                    "1","1","1","1","3","1","1","1"],
            "scoreStatus":[ //分数状态  7:健康问题 8缺考  9正常分数
                    "9","9","9","9","9","9","9","9",
                    "9","9","9","9","9","9","9","9"],
            "examScoreUids":[  //分数对应的examScoreUid 用于调用
                    6039272,6085038,6187695,6232225,6332797,
                    6400722,6457976,6512517,6635702,6669946,
                    6710488,6810398,6842927,6887092,6915064,7031978]
            },
    //---------------------------------------------------------
    "flag":1,
    "msg":"获取考试评价信息成功！ "
}

noticeMessage app聊天功能（班级）

获取某个人拥有的群组及人员 noticeMessage/getChatUserList.do

传入参数
    userUid     用户Uid  5530121
    groupIds   群组Uid(@分隔)  4140385  参见登录时返回的classesUid
返回参数
{
    "classesInfoList": [  //班级群组信息   list
        {
            "classesName": "小学五年级07班",
             "schoolName": "汉口辅仁小学",
            "classesUid": 4140385,
            "schoolUid": 10086,
            "userInfo": [   
                {
                   "sex": "0",
                    "position": "学生",//用户身份
                    "userType": "1",//用户类型  1-学生 2-老师  3-家长
                    "userName": "肖祖逸",
                    "headPortrait": "/171204/1043/182e436b-7299-40a3-a2b8-7671c2510b35.jpeg",
                    "headPortraitHD": "/171204/1043/1b297401-b90a-43b6-8c19-12133cbf682e.jpeg",
                    "userUid": 5530121
                },
                {
                    "sex": "1",
                    "position": "语文老师",
                    "userType": 2,
                    "userName": "herb",
                    "headPortrait": null,
                    "headPortraitHD": null,
                    "userUid": 5493563
                }
            ]
        }
    ],
    "flag": 1,
    "msg": "获取群组用户成功！"
}
获取聊天列表 noticeMessage/getChatList.do

传入参数
    userUid     用户Uid  5530121
    groupIds  群组Uid(@分隔)  4140385
    dateStr    时间字符串,返回之后的消息 2017-11-15 11:34:32

返回参数
{
    "chatResultList":[ //会话列表  不分页,全部返回
        {
            "chatUid":4140385,  //会话Uid
            "unread":"1", // 未读数
            "chatName":"小学五年级07班",  //会话名
            "lastMessageEditTime":"2017-11-17 09:13:16",
            "userUid":5530121,
            "chatType":2, //1-单聊   2-群聊
            "lastMessageNotes":"herb:两瓶" //最后一条消息
        },
        {
            "chatUid":5493563,
            "unread":"2",  // 未读数
            "chatName":"肖祖逸",
            "lastMessageEditTime":"2017-11-17 09:12:25",
            "userUid":5530121,
            "chatType":1,
            "lastMessageNotes":"我们"
        }
        ],
    "pageNum":1,
    "pageSize":2,
    "pageTotalCount":2
    "flag":1,
    "msg":"获取成功"
        }
获取详细会话记录 noticeMessage/getChatRecord.do

传入参数
    userUid     用户Uid  5530121
    groupId/reciverUid  获取群聊/单聊时(参见上面返回的chatUid)  4140385
    dateStr    时间字符串,返回之后的消息 2017-11-15 11:34:32
    pageNum
    pageSize
返回参数
{
    "chatRecordList": [ //会话消息List
        {
            "chatDetailsUid": "1142",  //详情Uid
            "senderName": "肖祖逸",  //发送人姓名
            "messageType": "21",      //消息类型  21-普通  22-图片 23-语言  24-公告
            "chatUid": "5493563",
            "sender": 5530121,   //发送人Uid
            "messageNotes": "我们",
            "userUid": 5530121,
            "messageEditTime": "2017-11-17 09:12:25"
        },
        {
            "chatDetailsUid": "1139",
            "senderName": "herb",
            "messageType": "21",
            "chatUid": "5493563",
            "sender": 5493563,
            "messageNotes": "我换了",
            "userUid": 5530121,
            "messageEditTime": "2017-11-17 09:11:39"
        }
    ],
    "pageNum": 1,
    "pageSize": 30,
    "pageTotalCount": 2,
    "flag": 1,
    "msg": "获取成功"
}
发送消息 noticeMessage/sendMessageOrTask.do

传入参数
    userUid     用户Uid  5530121
    groupId/receivers  群聊/单聊(@分割发送多人)chatUid
    messageType  消息类型  21-普通  22-图片 23-语言  24-公告
    messageNotes 消息文本 
    messageAttachments  消息附件url
    messageEditTime 消息编辑的时间(2017-11-17 09:12:25)

返回参数
{
    "chatDetailUid":1192  //table2 的chatDetailUid值
    "flag": 1,
    "msg": "发送成功"
}
删除消息 noticeMessage/deleteMessages.do

传入参数
    userUid     用户Uid  5530121
    receiveMessageUids  接受的消息uids(@分隔),参见上面返回的chatDetailUid
    sendMessageUids  发送的消息uids(@分隔),参见上面返回的chatDetailUid

返回参数
{
    "deleteMessageUids": 1192@1321@1123@111,//删除的chatDetailUids   @分隔
    "flag": 1,
    "msg": "删除成功"
}
上传图片 systemUsers/uploadImageToFS.do
传入参数 
    userUid  用户Uid 
    attachments     图片文件    file类型
返回参数
{
    imageUrlList:[  //图片List
        "http://fs.tiilii.com/1.jpg",
        "http://fs.tiilii.com/2.jpg",
        "http://fs.tiilii.com/3.jpg",
   ] 
    flag   //通用标示
    msg    //返回的文本提示 包含各种文本 修改成功，失败，旧密码不对，密码为空，用户不存在等等
}

©
author:herb
time:2017-12-4

晚来丿
关注
专栏目录
前后端开发接口文档
03-15
课程提供了前后端开发接口文档（采用 Swagger 语言进行编写），并与 Nginx 进行了整 合。双击 Nginx 执行文件启动后，在地址栏输入 http://localhost:801 即可访问 API 文档
后台接口文档
weixin_30311605的博客
08-15 295
用户登录 接口请求调用说名： http://www.xxx.xxx:8080/项目名/vue/userAction_login.action 参数 是否必须 说明 Name 是 用户名 Pwd 是 密码 登录成功返回json数据： ...
前后端分离项目规范——接口文档示例
最新发布
计算机程序定制、毕业项目
07-17 1324
前后端分离项目规范——接口文档示例
后端接口文档
weixin_52896512的博客
06-30 382
在项目开发中，web项目的前后端分离开发，APP开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。1、方法:新增(post) 修改(put) 删除(delete) 获取(get)1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发。2、项目维护中或者项目人员更迭，方便后期人员查看、维护。首先接口分为四部分：方法、uri、请求参数、返回参数。2、uri：以/a开头，如果需要登录才能调用的接口。一、什么是接口文档？三、接口规范是什么？
java后台接口
man632的博客
03-09 3859
一个完整项目：                     产品：需求文档，数据库设计文档，接口文档，用户使用手册                     项目： 后台管理系统，后台接口，前端页面                     测试Java后台接口：强调前端与后台之间的连接接口，通过接口文档来统一规定，不同于接口定义接口文档：设定统一格式规定前端与后台编写接口和请求接口的规范        ...
黄色卡通云朵小升初文档简历模板
01-02
【黄色卡通云朵小升初文档简历模板】是一款专为小学生升初中设计的自我介绍文档模板，采用明亮的黄色和卡通云朵元素，为小学生的简历增添趣味性和吸引力。这份简历模板适合那些即将面临小升初阶段的学生使用，旨在...
脚踩云朵的神仙flash动画
07-24
"重要建议.txt"可能是开发过程中的指导文档或注意事项，对理解动画的制作过程和注意事项有所帮助。 综合以上信息，我们可以推测这是一个以中国传统神话元素为主题的Flash动画项目，包含矢量绘制的门神和神仙角色，...
01 云朵云朵云朵云朵云朵.ai
09-07
云朵ai
HTML5 WebGL 实现逼真的云朵效果
10-24
首先，要实现云朵效果，我们需要理解云朵的物理特性。云是由水蒸气冷却后形成的水滴或冰晶组成，它们在大气中以不同的形状和大小分布。在3D建模中，云朵通常被模拟为复杂的多边形网格，通过改变网格的颜色和透明度来...
原生javascript云朵动画
12-08
在本项目中，我们将探讨如何使用原生JavaScript（简称JS）来实现一个云朵飘动的动画效果。这个效果结合了DOM操作、CSS3动画以及对JavaScript作用域的理解。下面，我们将逐步解析这个主题，深入理解相关的编程概念和...
商城后台接口（App）说明文档
01-11
这是商城App后台接口说明文档，很全，根据文档可以自己设计数据库，以有比较清晰的项目功能模块划分。。。
App商城后台接口，包含数据库文档
01-11
本系统是基于java的后台接口，包括客户端，对于开发商城后台的朋友有很好的借鉴意义；对于大学毕业设计的朋友，完全可以复制部分就可以了
接口文档示例.docx
08-13
开发文档模版，便于后台技术开发人员与前端开发人员的交流
DSOframer+接口文档+java后台及前台代码说明
10-28
网上有的最新DSOframer 接口说明文档 java后台及前台代码说明
微信支付 js api 接口文档及例子demo
07-24
开发微信使用的 微信支付的接口， 在公众帐号上跳转到的 html页面上，使用js进行支付，里面有 java php asp c# 的例子
mini项目后台接口文档
AlexP5的博客
07-21 833
说明 1. returnCode和returnMessage返回值说明 returnCode returnMessage 含义 0 OK 返回成功 1000 PARAM_ERROR 参数错误：仔细校验请求包参数是否完整，参数名称、参数类型、参数值是否正确 1001 DB_QUERY_ERROR 数据库查询异常  2000 U...
后端接口设计文档
m0_51235885的博客
07-01 101
公共参数：timestamp毫秒级时间戳1.客户端的请求时间标示 2.后端可以做请求过期验证 3.该参数参与签名算法增加签名的唯一性app_key签名公钥签名算法的公钥，后端通过公钥可以得到对应的私钥sign接口签名通过请求的参数和定义好的签名算法生成接口签名pageSize 一页几个pageNm 页码orderByColumn 排序列（数据库的字段名称）isAsc 升序asc 降序desc（最新的在前）
教你怎么写后台接口文档
热门推荐
qq_44493832的博客
08-15 2万+
文章目录用户登陆用户注册左侧树形菜单加载文章查询文章新增文章修改文章删除 用户登陆 http请求方式: POST https://xxx.xxx.xxx:8080/项目命名/vue/userAction_login.action 参数 是否必须 说明 Name 是 用户名 Pwd 是 密码 登录成功返回json数据： code: 1 msg: "登录成功" result...
微信小程序CSS3云朵特效实现与移植策略
例如，"小程序云朵特效"的实现，通常涉及到CSS3中的`transform`、`transition`和`animation`等属性，这些在小程序中可能需要转换为相应的API或通过JavaScript进行模拟。 标题“小程序云朵特效（css3移植思路）”...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值