“纪律星接口开发文档”的版本间的差异

来自成绩云帮助中心
跳转至： 导航、 搜索
（创建页面，内容为“== <p style="background:#6a9ee4;padding:8px 12px;color:#ffffff;">前言</p> == 本文档针对需要对接纪律星模块的平台而编写。 接入纪律星模...”）
 
第6行： 第6行：
  
 
然后提供一个接口URL前缀'''[platformBaseUrl]'''，后面所有的接口都基于这个前缀。凡是接口URL是'''[serverBaseUrl]'''前缀的，说明这个接口由第三方向纪律星发起请求。而如果接口URL前缀是'''[platformBaseUrl]'''，说明接口是由纪律星向第三方发起请求。
 
然后提供一个接口URL前缀'''[platformBaseUrl]'''，后面所有的接口都基于这个前缀。凡是接口URL是'''[serverBaseUrl]'''前缀的，说明这个接口由第三方向纪律星发起请求。而如果接口URL前缀是'''[platformBaseUrl]'''，说明接口是由纪律星向第三方发起请求。
 +
 +
== <p style="background:#6a9ee4;padding:8px 12px;color:#ffffff;">查询用户</p> ==
 +
 +
=== <p style="background:#999a9c;padding:8px 12px;color:#ffffff;display:inline-block;">查询考勤异常记录</p> ===
 +
此接口由成绩云向第三方发起请求，获取考勤异常记录。
 +
 +
;<span style="font-size:15px;">接口说明</span>
 +
请求方式：<code>POST</code>  <br/>
 +
请求URL:'''[platformBaseUrl]'''/query<br/>
 +
请求参数:<br/>
 +
{| class="wikitable"
 +
|-
 +
| style="width:80px; text-align:center;" | 参数
 +
| style="width:150px; text-align:center;" | 类型
 +
| style="width:100px; text-align:center;" | 是否必填
 +
| style="width:250px; text-align:center;" | 描述
 +
|-
 +
|begintime
 +
|int
 +
|是
 +
|时间戳（Unixtime）
 +
|-
 +
|endtime
 +
|int
 +
|是
 +
|时间戳（Unixtime）
 +
|-
 +
|sign
 +
|string
 +
|是
 +
|签名。详见附录[https://chengjiyun.com/wiki/index.php?title=%E6%88%90%E7%BB%A9%E4%BA%91%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%96%87%E6%A1%A3#.E7.AD.BE.E5.90.8D.E5.8F.82.E6.95.B0sign.E7.94.9F.E6.88.90.E8.AF.B4.E6.98.8E 签名参数sign生成说明]
 +
|}
 +
 +
返回参数:<br/>
 +
{| class="wikitable"
 +
|-
 +
| style="width:40px; text-align:center;" | 参数
 +
| style="width:150px; text-align:center;" | 类型
 +
| style="width:200px; text-align:center;" | 描述
 +
|-
 +
|id
 +
|string
 +
|记录ID，用于确认记录是否已经导入过。
 +
|-
 +
|grade
 +
|string
 +
|年级
 +
|-
 +
|class
 +
|string
 +
|班别
 +
|-
 +
|name
 +
|string
 +
|姓名
 +
|-
 +
|time
 +
|int
 +
|记录事件发生时间戳（Unixtime），相当于打卡时间。
 +
|-
 +
|event
 +
|string
 +
|事件。例如“异常”、“晚归“、“迟到”、“未到寝“。
 +
|}
 +
 +
'''返回样例'''
 +
<pre>
 +
{
 +
    "code": 200,
 +
    "msg": "ok",
 +
    "data": [
 +
        {
 +
            "id": 100231,
 +
            "grade": "高一",
 +
            "class": "1",
 +
            "name": "张三",
 +
            "time": 1639016550,
 +
            "event": “迟到”,
 +
        },
 +
        {
 +
            "id": 100234,
 +
            "grade": "高一",
 +
            "class": "2",
 +
            "name": "李四",
 +
            "time": 1639016555,
 +
            "event": "未到寝",
 +
        },
 +
    ]
 +
}
 +
</pre>
 +
<br/>

2021年12月9日 (四) 10:25的版本

前言

本文档针对需要对接纪律星模块的平台而编写。

接入纪律星模块的平台需要先联系知未科技研发，获取2个基本参数：平台ID[platform]，平台密钥[key]。这两个参数也可以反过来向知未科技提供。

然后提供一个接口URL前缀[platformBaseUrl]，后面所有的接口都基于这个前缀。凡是接口URL是[serverBaseUrl]前缀的，说明这个接口由第三方向纪律星发起请求。而如果接口URL前缀是[platformBaseUrl]，说明接口是由纪律星向第三方发起请求。

查询用户

查询考勤异常记录

此接口由成绩云向第三方发起请求，获取考勤异常记录。

接口说明

请求方式：POST
请求URL:[platformBaseUrl]/query
请求参数:

参数 类型 是否必填 描述
begintime int 是 时间戳（Unixtime）
endtime int 是 时间戳（Unixtime）
sign string 是 签名。详见附录签名参数sign生成说明

返回参数:

参数 类型 描述
id string 记录ID，用于确认记录是否已经导入过。
grade string 年级
class string 班别
name string 姓名
time int 记录事件发生时间戳（Unixtime），相当于打卡时间。
event string 事件。例如“异常”、“晚归“、“迟到”、“未到寝“。

返回样例 

{
    "code": 200,
    "msg": "ok",
    "data": [
        {
            "id": 100231,
            "grade": "高一",
            "class": "1",
            "name": "张三",
            "time": 1639016550,
            "event": “迟到”,
        },
        {
            "id": 100234,
            "grade": "高一",
            "class": "2",
            "name": "李四",
            "time": 1639016555,
            "event": "未到寝",
        },
    ]
}


取自“https://chengjiyun.com/wiki/index.php?title=纪律星接口开发文档&oldid=1735”