关于使用规则,请注意:


关于接口文档,请注意:

第三方用户根据提供的帐号和密码获取Token值,然后根据获取的Token值查询帐号拥有的单位权限,进一步查询单位组织架构、人员数据、学期数据、年级数据、班级数据、学生数据。

目录

获取Token

根据提供的帐号、密码获取Token,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/BaseData/GetToken

参数说明

参数 是否必须 说明
Account 帐号
passwork 密码

POST数据说明

POST数据示例如下:

      {
              "Account":"13566593701",
              "Password":"123456"
           }

返回值说明

在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:

 
        {
          "error":0,
          "Token":"H5/DP6N0fye1dSEUuREenFjCevluympOsUxjiUjyOKQ="
        }
               

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
Token string 返回的Token值

获取学校

根据提供的帐号,获取帐号有哪些学校的权限,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/BaseData/SearchUnitList

参数说明

参数 是否必须 说明
Token Token值

POST数据说明

POST数据示例如下:

      {
                  "Token":"H5/DP6N0fye1dSEUuREenFjCevluympOsUxjiUjyOKQ="
           }

返回值说明

在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:

 
        {
          "error":0,
          "UnitList":
              {
                  "UnitID":"10000006",
                  "UnitName":"高新区新明中心学校"
              },
              {
                  "UnitID":"10000012",
                  "UnitName":"铜陵市春晓小学"
              }
        }
               

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
UnitList UnitID string 学校ID
UnitName string 学校名称

获取学校组织

根据学校ID,获取学校的组织机构,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/BaseData/SearchUnitDeptList

参数说明

参数 是否必须 说明
Token Token值
UnitID 学校ID
LastGetDate 最后获取日期。为空时获取全部数据;不为空时为更新数据

POST数据说明

POST数据示例如下:

      {
              "Token":"H5/DP6N0fye1dSEUuREenFjCevluympOsUxjiUjyOKQ=",
              "UnitID":"10000006",
              "LastGetDate":"2016-11-01"
           }

返回值说明

在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:

 
        {
          "error":0,
          "DeptList":
              {
                  "ID":"10000036",    
                  "UnitID":"10000006", 
                  "ParentID":"0",    
                  "Code":"161024004",    
                  "Name":"校长处",
                  "ShortName":"",    
                  "DepartType":"1",    
                  "Manager":"",    
                  "DepartAdress":"",    
                  "Tel":"",    
                  "Fax":"",    
                  "Email":""
              }
        }
               

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
DeptList ID string 部门ID
UnitID string 学校ID
ParentID string 上级部门ID
Code string 部门编号
Name string 部门名称
ShortName string 部门简称
DepartType int 部门类型
Manager string 部门负责人
DepartAdress string 部门地址
Tel string 部门电话
Fax string 部门传真
Email string 部门邮箱

获取学校人员

根据学校ID,获取学校的人员信息,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/BaseData/SearchUnitEmpList

参数说明

参数 是否必须 说明
Token Token值
UnitID 学校ID
LastGetDate 最后获取日期。为空时获取全部数据;不为空时为更新数据

POST数据说明

POST数据示例如下:

      {    
              "Token":"H5/DP6N0fye1dSEUuREenFjCevluympOsUxjiUjyOKQ=",
              "UnitID":"10000006",
              "LastGetDate":"2016-11-01"
           }

返回值说明

在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:

 
        {
          "error":0,
          "EmpList":
              {
                  "ID":"10000360",
                  "UnitID":"10000006",    
                  "EmpName":"鲁瑞佳",    
                  "LoginName":"13008972734",    
                  "DepartmentID":"10000057",    
                  "DeptName":"校长处",    
                  "EmpCode":"xmzxxx001",    
                  "Gender":"1",    
                  "GenderName":"男",    
                  
              }
        }
               

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
EmpList ID string 人员ID
UnitID string 学校ID
EmpName string 人员名字
LoginName string 用户名
DepartmentID string 部门ID
DeptName string 部门名称
EmpCode string 人员编号
Gender int 性别(保密 = 0, 男 = 1, 女 = 2 )
GenderName string 性别

获取学校学期

根据学校ID,获取学校的学期数据,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/BaseData/SearchUnitSemesterList

参数说明

参数 是否必须 说明
Token Token值
UnitID 学校ID
LastGetDate 最后获取日期。为空时获取全部数据;不为空时为更新数据

POST数据说明

POST数据示例如下:

      {    
                  "Token":"H5/DP6N0fye1dSEUuREenFjCevluympOsUxjiUjyOKQ=",
                  "UnitID":"10000006",
                  "LastGetDate":"2016-11-01"
           }

返回值说明

在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:

 
        {
          "error":0,
          "SemesterList":
              {
                  "ID":"10000008",
                  "UnitID":"10000006",    
                  "Annual":"2016",    
                  "AnnualName":"2016-2017学年",    
                  "Semester":"1",    
                  "StartDate":"2016-09-01",    
                  "EndDate":"2017-01-31",    
                  "Weeks":"0",    
                  "IsArchive":"0"
              }
        }
               

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
SemesterList ID string 学期ID
UnitID string 学校ID
Annual string 学年ID
AnnualName string 学年名称
Semester string 学期(1:第一学期;2:第二学期)
StartDate string 学期开始日期
EndDate string 学期结束日期
Weeks string 周次
IsArchive int 是否归档(0:未归档;1:已归档)

获取学校年级

根据学校ID、学期ID,获取学校的年级数据,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/BaseData/SearchUnitGradeList

参数说明

参数 是否必须 说明
Token Token值
UnitID 学校ID
SemesterID 学期ID
LastGetDate 最后获取日期。为空时获取全部数据;不为空时为更新数据

POST数据说明

POST数据示例如下:

      {    
                 "Token":"H5/DP6N0fye1dSEUuREenFjCevluympOsUxjiUjyOKQ=",
                 "UnitID":"10000006",
                 "SemesterID":"10000005",
                 "LastGetDate":"2016-11-01"
           }

返回值说明

在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:

 
        {
          "error":0,
          "GradeList":
              {
                  "ID":"10000037",
                  "GradeCode":"1",    
                  "GradeName":"一年级",    
                      
                  "AnnualSemesterID":"10000008",    
                      
                  "SectionName":"小学",    
                  "SectionGradeName":"小学一年级"
              }
        }
               

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
GradeList ID string 年级ID
GradeCode string 年级编号
GradeName string 年级名称
AnnualSemesterID string 学期ID
SectionName string 学段名称
SectionGradeName string 学段年级名称

获取学校班级

根据学校ID、学期ID、年级ID,获取学校的班级数据,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/BaseData/SearchUnitClassList

参数说明

参数 是否必须 说明
Token Token值
UnitID 学校ID
SemesterID 学期ID
GradeID 年级ID
LastGetDate 最后获取日期。为空时获取全部数据;不为空时为更新数据

POST数据说明

POST数据示例如下:

      {    
                 "Token":"H5/DP6N0fye1dSEUuREenFjCevluympOsUxjiUjyOKQ=",
                 "UnitID":"10000006",
                 "SemesterID":"10000005",   
                 "GradeID":"10000016",
                 "LastGetDate":"2016-11-01"
           }

返回值说明

在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:

 
        {
          "error":0,
          "ClassList":
              {
                  "ID":"10000094",
                  "ClassCode":"16102701",    
                  "ClassName":"小学一年级(01)班",    
                  "GradeBaseID":"10000037",    
                  "GradeName":"一年级",    
                      
                  "TeacherName":"",    
                  "MonitorName":"",    
                  "ImageUrl":""
              }
        }
               

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
ClassList ID string 班级ID
ClassCode string 班级编号
ClassName string 班级名称
GradeBaseID string 年级ID
GradeName string 年级名称
TeacherName string 班主任
MonitorName string 班长
ImageUrl string 班级图片路近

获取学校学生

根据学校ID、学期ID、年级ID、班级ID,获取学校的学生数据,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/BaseData/SearchUnitStuList

参数说明

参数 是否必须 说明
Token Token值
UnitID 学校ID
SemesterID 学期ID
GradeID 年级ID
ClassID 班级ID
LastGetDate 最后获取日期。为空时获取全部数据;不为空时为更新数据

POST数据说明

POST数据示例如下:

      {    
                 "Token":"H5/DP6N0fye1dSEUuREenFjCevluympOsUxjiUjyOKQ=",
                 "UnitID":"10000006",
                 "SemesterID":"10000008",   
                 "GradeID":"10000016",   
                 "ClassID":"10000108",
                 "LastGetDate":"2016-11-01"
           }

返回值说明

在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:

 
        {
          "error":0,
          "StuList":
              {
                  "ID":"10005473",
                  "GradeName":"一年级",    
                  "ClassName":"小学一年级(01)班",    
                  "StudentName":"夏果悦",    
                  "UnitiveCode":"42011520100820792X",    
                  "StudentCode":"001",    
                  "Gender":"2",    
                  "GenderName":"保密",    
                  "BirthDay":"2010-08-20",    
                  "ChangeState":"10000102",    
                  "StateName":"统一招生",    
                  "Guardian":"夏桂林",    
                  "GuardianRelation":"父亲",    
                  "GuardianMobile":"13957472146",    
                  "GuardianState":"夏桂林(父亲)"
              }
        }
               

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
StuList ID string 学生ID
GradeName string 年级名称
ClassName string 班级名称
StudentName string 学生名称
UnitiveCode string 学籍主号
StudentCode string 学生班号
Gender int 性别(保密 = 0, 男 = 1, 女 = 2 )
GenderName string 性别名称
BirthDay string 出生日期
ChangeState string 学生状态
StateName string 学生状态名称
Guardian string 监护人
GuardianRelation string 监护关系
GuardianMobile string 监护手机号码
GuardianState string 监护人(监护关系)

获取课程表

根据学校ID、学期ID、年级ID、班级ID,获取学校的课程表数据,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/BaseData/SearchScheduleList

参数说明

参数 是否必须 说明
Token Token值
UnitID 学校ID
SemesterID 学期ID
GradeID 年级ID
ClassAdjustID 班级ClassAdjustID

POST数据说明

POST数据示例如下:

      {    
                 "Token":"H5/DP6N0fye1dSEUuREenFjCevluympOsUxjiUjyOKQ=",
                 "UnitID":"10000014",
                 "GradeID":"10000084",   
                 "ClassAdjustID":"10000171"
           }

返回值说明

在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:

 
         if(ClassAdjustID.length>0)//班级课程表返回数据
         {
            "error":0,
            "schedule":{
                  "ID":"10003240",
                  "CourseID":"10002507",    
                  "CourseName":"数学",    
                  "FreeLesson":"",    
                  "Category":"0",    
                  "WeekDay":"1",    
                  "CourseIndex":"1"
              }
            "teach":{    
                  "CourseID":"10002313",    
                  "CourseName":"语文",    
                  "EmpName":"郑老师",
             }
         }
        else{
          "error":0,
          "data":
              {
                  "ID":"10000171",
                  "GradeName":"七年级",    
                  "ClassName":"701班",    
                  "EmpName":"顾晨晨",    
                  "CourseList":[{
                    "ID":"10003240",    
                    "ClassCourseID":"10002507",     
                    "CourseName":"数学",     
                    "Weekday":"1",     
                    "CourseIndex":"1",     
                    "Category":"0",
                    }]
              }
        }
               

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
schedule ID string 课程表ID
CourseID string 课程ID
CourseName string 课程名称
FreeLesson string 免任课程
Category int 类别
WeekDay int 星期
CourseIndex int 课节
teach CourseID string 课程ID
CourseName string 课程名称
EmpName string 任课教师

错误列表

错误编号 错误说明
001 参数错误
002 IP不是指定的IP
003 系统错误