关于使用规则,请注意:
关于接口文档,请注意:
第三方用户根据提供的帐号和密码获取Ticket值,然后根据获取的Ticket值查询帐号拥有的单位权限,进一步查询单位组织架构、人员数据、学期数据、年级数据、班级数据、学生数据。
            目录 | 
    
GetToekn,具体如下:
接口调用请求说明
http请求方式: POST
    {WebPath}/api/***********/GetToekn
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| LoginName | 是 | LoginName | 
| PassWord | 是 | PassWord | 
POST数据说明
POST数据示例如下:
      {    
                "LoginName": "13566593701",
                "PassWord": ""
           }
    返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
 
            {
                "error":0,   
                "token":""
          
            }  
    返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1'时错误信息有值返回 | |
| token | string | token | |
验证apikey的有效性,具体如下:
接口调用请求说明
http请求方式: POST
    {WebPath}/api/***********/CheckApiIDKeyValid
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| appid | 是 | appid | 
| appkey | 是 | appkey | 
| timestamp | 是 | timestamp | 
POST数据说明
POST数据示例如下:
      {    
                "appid": "sdj5yhgvh6876huj66h",
                "appkey": "sdj5yhgvh6876huj66h",
                "timestamp": "sdj5yhgvh6876huj66h",
           }
   
    返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
 
            {
                "error":0,
                "backUrl":"http://xzl.zjzdy.net"
            }  
    返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1'时错误信息有值返回 | |
| backUrl | string | 返回的跳转路径 | |
根据Token获取用户信息,具体如下:
接口调用请求说明
http请求方式: POST
   {WebPath}/api/***********/GetUserInfoByToken
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| token | 是 | token | 
POST数据说明
POST数据示例如下:
      {
              "Token":""
           }
  
    返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
 
            {
            "error":0,
            "user":{
                "userID":"",
                "userName":"",
                "userType":2,
                "depID":"",
                "depName":"研发中心",
                "edunitID":"",
                "edunitName":"",
                "empCode":"",
                "empID":"",
                "empName":"陈张生",
                "photoLarge":"",
                "photoPath":"",
                "photoSmall":"",
                "sex":1,
                "token":"",
             }
        }
               
    返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1'时错误信息有值返回 | |
| Ticket | string | 返回用户信息 | |
根据提供的帐号、密码获取ticket,具体如下:
接口调用请求说明
http请求方式: POST
    {WebPath}/api/***********/GetTicket
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| Account | 是 | 帐号 | 
| passwork | 是 | 密码 | 
POST数据说明
POST数据示例如下:
      {
              "AppID":"zjzdy",
              "AppKey":"123456"
           }
    
    返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
 
        {
          "error":0,
          "ticket":""
        }
               
    返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1'时错误信息有值返回 | |
| Ticket | string | 返回的ticket值 | |
根据提供的帐号,获取帐号有哪些学校的权限,具体如下:
接口调用请求说明
http请求方式: POST
    {WebPath}/api/***********/SearchUnitList
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| Ticket | 是 | Ticket值 | 
POST数据说明
POST数据示例如下:
      {
                  "Ticket":""
           }
    
    返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
 
        {
          "error":0,
          "UnitList":
              {
                  "UnitID":"",
                  "UnitName":"高新区新明中心学校"
              },
              {
                  "UnitID":"",
                  "UnitName":"春晓小学"
              }
        }
               
    返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1'时错误信息有值返回 | |
| UnitList | UnitID | string | 学校ID | 
| UnitName | string | 学校名称 | |
根据学校ID,获取学校的组织机构,具体如下:
接口调用请求说明
http请求方式: POST
   {WebPath}/api/***********/SearchUnitDeptList
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| Ticket | 是 | Ticket值 | 
| UnitID | 是 | 学校ID | 
| LastGetDate | 否 | 最后获取日期。为空时获取全部数据;不为空时为更新数据 | 
POST数据说明
POST数据示例如下:
      {    
              "Ticket": ""
              "UnitID":"",
              "LastGetDate":"2016-11-01"
           }
    
    返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
 
        {
          "error":0,
          "DeptList":
              {
                  "ID":"10000036",    
                  "UnitID":"", 
                  "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 | 部门传真 | |
| string | 部门邮箱 | ||
根据学校ID,获取学校的人员信息,具体如下:
接口调用请求说明
http请求方式: POST
    {WebPath}/api/***********/SearchUnitEmpList
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| Ticket | 是 | Ticket值 | 
| UnitID | 是 | 学校ID | 
| TranState | 是 | 在职状态(在职 = 0,非在职=1) | 
| LastGetDate | 否 | 最后获取日期。为空时获取全部数据;不为空时为更新数据 | 
POST数据说明
POST数据示例如下:
      {        
              "Ticket": "",
              "UnitID":"",
              "LastGetDate":"2016-11-01"
           }
    
    返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
 
        {
          "error":0,
          "EmpList":
              {
                  "ID":"10000360",
                  "UnitID":"",    
                  "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/***********/SearchUnitSemesterList
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| Ticket | 是 | Ticket值 | 
| UnitID | 是 | 学校ID | 
| LastGetDate | 否 | 最后获取日期。为空时获取全部数据;不为空时为更新数据 | 
POST数据说明
POST数据示例如下:
      {        
                  "Ticket": "",
                  "UnitID":"",
                  "LastGetDate":"2016-11-01"
           }
    返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
 
        {
          "error":0,
          "SemesterList":
              {
                  "ID":"10000008",
                  "UnitID":"",    
                  "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/***********/SearchUnitGradeList
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| Ticket | 是 | Ticket值 | 
| UnitID | 是 | 学校ID | 
| SemesterID | 是 | 学期ID | 
| LastGetDate | 否 | 最后获取日期。为空时获取全部数据;不为空时为更新数据 | 
POST数据说明
POST数据示例如下:
      {        
                 "Ticket": "",
                 "UnitID":"",
                 "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/***********/SearchUnitClassList
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| Ticket | 是 | Ticket值 | 
| UnitID | 是 | 学校ID | 
| SemesterID | 是 | 学期ID | 
| GradeID | 是 | 年级ID | 
| LastGetDate | 否 | 最后获取日期。为空时获取全部数据;不为空时为更新数据 | 
POST数据说明
POST数据示例如下:
      {        
                  "Ticket": "",
                 "UnitID":"",
                 "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/***********/SearchUnitStuList
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| Ticket | 是 | Ticket值 | 
| UnitID | 是 | 学校ID | 
| SemesterID | 是 | 学期ID | 
| GradeID | 是 | 年级ID | 
| ClassID | 是 | 班级ID | 
| StudentState | 是 | 学生状态(在读、非在读) | 
| LastGetDate | 否 | 最后获取日期。为空时获取全部数据;不为空时为更新数据 | 
POST数据说明
POST数据示例如下:
      {        
                 "Ticket": "",
                 "UnitID":"",
                 "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 | 
| UserID | string | 用户ID | |
| GradeName | string | 年级名称 | |
| ClassID | string | 班级ID | |
| ClassName | string | 班级名称 | |
| StudentName | string | 学生姓名 | |
| UnitiveCode | string | 学籍主号 | |
| StudentCode | string | 班内编号 | |
| Gender | int | 性别(保密 = 0, 男 = 1, 女 = 2 ) | |
| GenderName | string | 性别名称 | |
| BirthDay | string | 出生日期 | |
| StudentStatusName | string | 学生状态名称 | |
| Guardian | string | 监护人 | |
| GuardianRelation | string | 监护关系 | |
| GuardianMobile | string | 监护手机号码 | |
根据学校ID、学期ID、年级ID、班级ID,获取学校的学生家长数据,具体如下:
接口调用请求说明
http请求方式: POST
    {WebPath}/api/***********/SearchGuardianList
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| Ticket | 是 | Ticket值 | 
| UnitID | 是 | 学校ID | 
| SemesterID | 是 | 学期ID | 
| GradeID | 是 | 年级ID | 
| ClassID | 是 | 班级ID | 
| LastGetDate | 否 | 最后获取日期。为空时获取全部数据;不为空时为更新数据 | 
POST数据说明
POST数据示例如下:
      {        
                 "Ticket": "",
                 "UnitID":"",
                 "SemesterID":"10000005",   
                 "GradeID":"10000016",   
                 "ClassID":"",
                 "LastGetDate":"2016-11-01"
           }
   
    返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
 
            {
          "error":0,
          "guardianList":
              {
                  "ID":"家长ID",
                  "UserID":"用户ID",
                  "StudentID":"学生ID",
                  "GuardianName":"姓名",   
                  "Mobile":"手机号",    
                  "Relation":"亲属关系" 
                  "GenderName":"性别",      
                  "Birthday":"出生日期"   
              }
        }
               
    返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1'时错误信息有值返回 | |
| GuardianList | ID | string | 家长ID | 
| UserID | string | 用户ID | |
| StudentID | string | 学生ID | |
| GuardianName | string | 家长姓名 | |
| Mobile | string | 手机号 | |
| Relation | string | 亲属关系 | |
| GenderName | string | 性别名称 | |
| BirthDay | string | 出生日期 | |
根据学校ID、教师ID,获取学校教师的任教数据,具体如下:
接口调用请求说明
http请求方式: POST
    {WebPath}/api/***********/SearchUnitEmpSubjectList
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| Ticket | 是 | Ticket值 | 
| UnitID | 是 | 学校ID | 
| EmployeeID | 是 | 教师ID | 
POST数据说明
POST数据示例如下:
      {    
                 "Ticket":"",
                 "UnitID":"",
                 "EmployeeID":"10001227"
           }
    返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
 
              {
                "error":0,
                "empSubList":[
                    {
                        "ID":"10000001",
                        "Name":"语文"
                    },
                    {
                        "ID":"10000029",
                        " Name":"地理"
                    },
                    {
                        "ID":"10000002",
                        " Name":"数学"
                    }
                ]
            }
               
    返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1'时错误信息有值返回 | |
| empCourseList | ID | string | 课程ID | 
| Name | string | 课程名称 | |
根据学校ID、学期ID、教师ID,获取学校的教师授课数据,具体如下:
接口调用请求说明
http请求方式: POST
    {WebPath}/api/***********/SearchUnitEmpCourseList
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| Ticket | 是 | Ticket值 | 
| UnitID | 是 | 学校ID | 
| SemesterID | 否 | 学期ID | 
| EmployeeID | 否 | 教师ID | 
POST数据说明
POST数据示例如下:
      {    
                 "Ticket":"",
                 "UnitID":"",
                 "SemesterID":"10000005",   
                 "EmployeeID":"10001227"
           }
    返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
 
               {
                    "error":0,
                    " empCourseList":[
                        {
                            "EmpID" :"100120xx"  //教师ID
                            "EmpName" :"王xx"         //教师姓名
                            "ClassID":"100037xx "    //班级ID
                            "ClassName" :" 四年级5班"  //班级名称
                            "BsCourseCode":"17"      //基础课程编号
                            "BsCourseName" :"美术"   //基础课程名称
                            "CourseCode" :"17"       //课程编号
                            "CourseName" :"美术"     //课程名称
                        }
                    ]
                }    
    返回字段说明
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| message | string | 'error=1'时错误信息有值返回 | |
| EmpCourseList | EmpID | string | 教师ID | 
| EmpName | string | 教师姓名 | |
| ClassID | string | 班级ID | |
| ClassName | string | 班级名称 | |
| CourseCode | string | 课程编号 | |
| CourseName | string | 课程名称 | |
根据学校ID、学期ID、年级ID、班级ID,获取学校的课程表数据,具体如下:
接口调用请求说明
http请求方式: POST
    {WebPath}/api/***********/SearchScheduleList
    参数说明
| 参数 | 是否必须 | 说明 | 
|---|---|---|
| Ticket | 是 | Ticket值 | 
| UnitID | 是 | 学校ID | 
| SemesterID | 否 | 学期ID | 
| GradeID | 否 | 年级ID | 
| ClassAdjustID | 否 | 班级ClassAdjustID | 
POST数据说明
POST数据示例如下:
      {    
                 "Ticket":"",
                 "UnitID":"",
                 "GradeID":"10000016",   
                 "ClassAdjustID":""
           }
    返回值说明
在调用接口后,会返回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 | 系统错误 |