关于使用规则,请注意:


关于接口文档,请注意:



目录

写入系统提醒

写入系统提醒,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/ApiSystemApi/*****

POST数据说明

POST数据示例如下 数据用json提交:

      
           json:{      
                    sms: "0",
                    push: "0",         
                    unitID: "10000006",
                    userID: "workFlow",     
                    isPushContent: "1",
                    remindTitle: "校信",
                    remindContent: "你有新校信",
                    remindUserIDList: [
                      {
                          userID: "10000001",
                          empName: "王一"
                      }
                    ],
                    remindUserMobileList: [
                        {
                            mobile: "13566593784",
                            empName: "王二"
                        }
                    ],
                    url: "http://www.zjzdy.net?ID=23",
                    urlFrom: 0
            }

参数说明

参数 是否必须 说明
paramJson 提交数据将下面的字段生成json提交
Json内容 sms 短信发送 0否 1是
isPushContent 推送内容 1 remindContent 否则 remindTitle
push 推送范围 0 APP推送,1微信推送,2全部推送
userID 用户
unitID 单位ID
remindTitle 提醒标题
remindContent 提醒内容
remindUserMobileList 提醒人用户手机号码 与remindUserIDList二选一
remindUserIDList 提醒人用户ID 与remindUserMobileList二选一
url 提醒Url
urlFrom Url来源 0系统内 1 系统外

返回值说明

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

 
                     {
    "error":0
}
               

返回字段说明

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

获取上传配置

获取上传配置,具体如下:

接口调用请求说明

http请求方式: POST
   {WebPath}/api/ApiSystemApi/****

POST数据说明

POST数据示例如下 数据用json提交:

      
           json:{
                    unitID: "0",
            }

参数说明

参数 是否必须 说明
unitID 学校ID

返回值说明

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

 
{
    "error":0,
    "uploadType":2,     // 2 调用阿里云上传接口并返回oss配置参数,其他配置默认使用原先接口        
    "catalogue":"APP/20160117/",     // 目录       
    "address":"http://oss.zjzdy.net",     // 2 调用阿里云上传接口并返回oss配置参数,其他配置默认使用原先接口 
    "bucket":"xxxxx",   // 库名       
    "endpoint":"xxxxx", // 连接地址
    "uploadaddress": "http://storage-derek.oss-cn-hangzhou.aliyuncs.com" // 阿里云返回的地址域名
}

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
uploadType int 上传方式为2时调用阿里云上传接口,其他值依旧调用原先接口
address string 上传方式为2文件的替换地址,文件大小大于1M时,替换http://bucket.endpoint 为 address
uploadaddress string 阿里云返回的地址域名 直接替换成address地址

检查文件是否存在

检查文件是否存在,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/ApiSystemApi/*****

POST数据说明

POST数据示例如下 数据用json提交:

      
           json:{
                md5code: "f261dcb271e894af719cf1f6cfd74df1",
            }

参数说明

参数 是否必须 说明
md5code 文件MD5code

返回值说明

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

 
{
    "error":0,
    "isexist":0,     // 文件是否存在 0 不存在 1 存在   
    "filepath":"http://xzl.zjzdy.net/三年级英语微课/Unit5/人教PEP三年级Unit5 Let's eat!Lesson4.mp4"     // 文件存在时返回路径
}

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
isExist int 文件是否存在,0 不存在 1 存在并返回路径
filepath string 如果文件存在,返回路径

获取阿里云配置

获取上传配置,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/ApiSystemApi/****

POST数据说明

POST数据示例如下 数据用json提交:

      
            {
                    unitID: "0",
                    type:0
            }

参数说明

参数 是否必须 说明
type 类型,0上传,1下载
unitID 学校ID

返回值说明

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

 
{
    "error":0,
    "data":
        {
            [
                "uploadType":2,     // 2 调用阿里云上传接口并返回oss配置参数,其他配置默认使用原先接口        
                "catalogue":"APP/20160117/",     // 目录       
                "address":"http://oss.zjzdy.net",     // 2 调用阿里云上传接口并返回oss配置参数,其他配置默认使用原先接口 
                "bucket":"xxxxx",   // 库名       
                "endpoint":"xxxxx", // 连接地址
                "uploadaddress": "http://storage-derek.oss-cn-hangzhou.aliyuncs.com" // 阿里云返回的地址域名    
            ]
        }
}

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
data uploadType int 类型,2阿里云
catalogue string 目录
address string 地址
bucket string 库名
endpoint string 连接地址
uploadaddress string 阿里云返回的地址域名

获取发送短信配置

获取上传配置,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/ApiSystemApi/****

POST数据说明

POST数据示例如下 数据用json提交:

      
            {
                    unitID: "10000006",
                    userID: "10008817",
                    type:1
            }

参数说明

参数 是否必须 说明
userID 用户ID
unitID 学校ID
type 类型,0校信,1作业

返回值说明

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

 
{
    "error":0,
    "data":{
            isShowOption=1,
            defaultOption=1
    }
}

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
isShowOption int 是否显示选项,0不显示,1显示,不显示的情况下为发短信
defaultOption int 默认选项,0不发短信,1发短信

保存操作日志

保存操作日志,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/ApiSystemApi/*****

POST数据说明

POST数据示例如下 数据用json提交:

      
               paramJson: [
                    {
                        userID: "10008817",
                        opDevType: 1,
                        logDatas:[
                                    {
                                        btnCode:"fp001",
                                        logDate:"2017-07-10 14:32:33"
                                    }
                        ]
                    }
                ]

参数说明

参数 是否必须 说明
userID 用户ID
opDevType 操作设备类型,Web = 0,IOS = 1,IOSPad = 2,Android = 3,AndroidPad = 4,IPTV = 5
logDatas btnCode 按钮编号
logDate 时间

返回值说明

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

 
{
    "error":0
}

返回字段说明

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

检查用户是否有网盘的权限

检查用户是否有网盘的权限,具体如下:

接口调用请求说明

http请求方式: GET
    {WebPath}/api/ApiSystemApi/*****

GET数据说明

GET数据示例如下:

      {
                "userType":"2",     
                "unitID":"10000006" 
           }

参数说明

参数 是否必须 说明
userType 用户类型
unitID 学校ID

返回值说明

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

 
        {
            "error":0,
            "right":1
        }
               

返回字段说明

字段 类型 说明
error int 返回值:'0'表示token有效
message string 'error=1' token过期,返回新token
right string 0没有权限,1有权限

收藏

收藏,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/ApiSystemApi/****

POST数据说明

POST数据示例如下 数据用json提交:

      
                   
                    {
                        userID: "10008817",
                        content: "http://oss.zjzdy.net/20171214/50411bb72c6afcfcc8024a895e962693.docx",
                        title:"",
                        sourceUserID:"10008817",
                        format:".docx",
                        type:"1",
                    }

参数说明

参数 是否必须 说明
userID 用户ID
type 收藏类型,0图片,1文档,2视频,3网页链接,4IM聊天记录(预留类型,暂不处理)
title 收藏标题,type=1时传文件名称,type=3时传网页的title,其他type类型传空
content 收藏内容,type=4传聊天内容,其他类型传网络地址
format 收藏的文件格式后缀,type为0,1,2时必传
sourceUserID 收藏来源用户ID

返回值说明

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

 
{
    "error":0
}

返回字段说明

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

查询收藏列表

查询收藏列表,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/ApiSystemApi/****

POST

POST数据示例如下:

    
                {
                    userID: '10008817',
                    pageIndex:1,
                    pageSize:10
                }

参数说明

参数 是否必须 说明
userID 用户ID

返回值说明

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

 
                              

返回字段说明

字段 类型 说明
error int 返回值:'0'表示成功,'1'表示失败
message string 'error=1'时错误信息有值返回
data id string 收藏记录ID
title string 标题
content string 收藏内容,type=4为IM聊天内容,其他类型时为收藏对象原始网络地址
type string 收藏类型,0图片,1文档,2视频,3网页链接,4IM聊天记录(预留类型,暂不处理)
sourceUserID string 收藏来源用户ID
sourceEmpName string 收藏来源用户姓名
sourcePhotoPath string 收藏来源用户头像
filePreview string type=1时的文档预览地址
createDate string 日期

删除收藏记录

删除收藏记录,具体如下:

接口调用请求说明

http请求方式: POST
    {WebPath}/api/ApiSystemApi/*****

POST数据说明

POST数据示例如下 数据用json提交:

      
                   
                        {
                            userID:"10008817",
                            ids: "10000001",
                            type:0
                    }

参数说明

参数 是否必须 说明
ids type=0时必传,要删除的收藏记录ID,多个ID之间逗号分隔
type 删除类型,0删除指定ID记录,1全部删除

返回值说明

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

 
{
    "error":0
}

返回字段说明

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

获取微信参数

获取微信参数,具体如下:

接口调用请求说明

http请求方式: GET
    {WebPath}/api/ApiSystemApi/*****

GET数据说明

GET数据示例如下:

      {
                "url":"xxxxx"
           }

参数说明

参数 是否必须 说明
url 客户端请求网址

返回值说明

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

 
        {

        }
               

返回字段说明

字段 类型 说明
error int 返回值:'0'表示token有效
message string 'error=1' token过期,返回新token

将短链接转换为长链接

将短链接转换为长链接,具体如下:

接口调用请求说明

http请求方式: Get
    {WebPath}/api/ApiSchoolMsg/****

Get

Get数据示例如下:

    
                {
                    url:"www.wwww.com"
                }

参数说明

参数 是否必须 说明
url 链接

返回值说明

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

 
     {
          error=0,
          url="wwwwwww"
    }           

返回字段说明

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