- 获取个人通讯录信息
获取个人通讯录信息:http://[customer-site]/WebApi/Handler/1.0/OA/Contact/GetList.ashx
功能:
获取个人通讯录信息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Contact/GetList.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考个人通讯录List(Contact)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
user_id | True | Int32 | 用户id |
- 更新个人通讯录信息
更新个人通讯录信息:http://[customer-site]/WebApi/Handler/1.0/OA/Contact/Update.ashx
功能:
更新个人通讯录信息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Contact/Update.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (行数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | Int32 | |
user_id | True | Int32 | 用户id |
group_id | True | Int32 | 分组id(1:默认分组,106:客户,107:供应商) |
name | True | String | 姓名 |
sex | True | Int32 | 性别(0:女,1:男) |
office_tel | True | String | 办公电话 |
mobile | True | String | 手机 |
fax | True | String | 传真 |
True | String | 邮件 | |
home_address | True | String | 家庭住址 |
home_tel | True | String | 家庭电话 |
post_code | True | String | 邮编 |
signature | True | String | 签名 |
remark | True | String | 备注 |
- 删除个人通讯录信息
删除个人通讯录信息:http://[customer-site]/WebApi/Handler/1.0/OA/Contact/Delete.ashx
功能:
删除个人通讯录信息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Contact/Delete.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (行数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | Int32 | 通讯录主键id |
- 增加个人通讯录信息
增加个人通讯录信息:http://[customer-site]/WebApi/Handler/1.0/OA/Contact/Insert.ashx
功能:
增加个人通讯录信息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Contact/Insert.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (行数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
user_id | True | Int32 | 用户id |
group_id | True | Int32 | 分组id(1:默认分组,106:客户,107:供应商) |
name | True | String | 姓名 |
sex | True | Int32 | 性别(0:女,1:男) |
office_tel | True | String | 办公电话 |
mobile | True | String | 手机 |
fax | True | String | 传真 |
True | String | 邮件 | |
home_address | True | String | 家庭住址 |
home_tel | True | String | 家庭电话 |
post_code | True | String | 邮编 |
signature | True | String | 签名 |
remark | True | String | 备注 |
- 更新个人通讯录单字段信息
更新个人通讯录单字段信息:http://[customer-site]/WebApi/Handler/1.0/OA/Contact/UpdateField.ashx
功能:
更新个人通讯录单字段信息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Contact/UpdateField.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (行数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | Int32 | 主键 |
fieldName | True | String | 字段名(OfficePhone、MobilePhone、Email 等) |
fieldValue | True | String | 字段值(办公电话、手机、邮箱 等) |
- 保存自定义表单数据
保存自定义表单数据:http://[customer-site]/WebApi/Handler/1.0/OA/CustomerForm/SaveData.ashx
功能:
保存自定义表单数据
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/CustomerForm/SaveData.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
data | True | String | 表单数据json字符串 |
table_name | True | String | 表名 |
- 获得当前用户邮件列表
获得当前用户邮件列表:http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetCurrentUserEmailList.ashx
功能:
获得当前用户邮件列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetCurrentUserEmailList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考邮件List(InternalMail)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
pageSize | True | Int32 | 指定要返回的记录条数 |
readType | True | String | Read:已读Unread:未读 |
posKey | True | String | 若指定此参数,则只返回比posKey大的行数邮件列表,默认"-1"表示从1开始 |
- 根据id获取邮件
根据id获取邮件:http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/Get.ashx
功能:
根据id获取邮件
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/Get.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考邮件InternalMail对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | Int32 | 邮件id |
- 根据id获取邮件回复列表
根据id获取邮件回复列表:http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetReplyList.ashx
功能:
根据id获取邮件回复列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetReplyList.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考邮件回复List(InternalEmailReply)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
mailId | True | Int32 | 邮件Id |
- 根据id回复邮件
根据id回复邮件:http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/Reply.ashx
功能:
根据id回复邮件
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/Reply.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
mailId | True | Int32 | 邮件id |
content | True | String | 回复内容 |
- 获得当前用户未读邮件列表
获得当前用户未读邮件列表:http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetCurrentUserUnReadEmailList.ashx
功能:
获得当前用户未读邮件列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetCurrentUserUnReadEmailList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考邮件List(InternalMail)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
pageSize | True | Int32 | 指定要返回的记录条数 |
- 获得未读邮件数量
获得未读邮件数量:http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetUnReadCount.ashx
功能:
获得未读邮件数量
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetUnReadCount.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (数量)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 更新未读邮件状态
更新未读邮件状态:http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/UpdateStatus.ashx
功能:
更新未读邮件状态
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/UpdateStatus.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (受影响的行数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | Int32 | 邮件id |
table | True | String | 类型InBox:收件箱Draftbox:发件箱 |
- 根据mailid获取邮件
根据mailid获取邮件:http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetByMailId.ashx
功能:
根据mailid获取邮件
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetByMailId.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考邮件InternalMail_Email对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
mailId | True | Int32 | 邮件id |
- 发送邮件
发送邮件:http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/SendMail.ashx
功能:
发送邮件
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/SendMail.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (受影响的行数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
data | True | String | 邮件json字符串 |
- 根据当前用户获取发件箱或草稿箱数据
根据当前用户获取发件箱或草稿箱数据: http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetCurHapieboxOrDraftbox.ashx
功能:
根据当前用户获取发件箱或草稿箱数据
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetCurHapieboxOrDraftbox.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考邮件List(InternalMail_Email)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
range | True | String | Hairpiecesbox:发件箱Draftbox:草稿箱 |
pageSize | True | Int32 | 指定要返回的记录条数 |
readType | True | String | Read:已读Unread:未读 |
posKey | True | String | 若指定此参数,则只返回比posKey大的行数邮件列表,默认"-1"表示从1开始 |
- 存为草稿
存为草稿: http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/SaveMail.ashx
功能:
存为草稿
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/SaveMail.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (受影响的行数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
data | True | String | 邮件json字符串 |
- 根据id获取发件箱邮件
根据id获取发件箱邮件: http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetHairpiecesbox.ashx
功能:
根据id获取发件箱邮件
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/GetHairpiecesbox.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考邮件InternalMail_Email对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | Int32 | 邮件id |
- 根据id删除邮件
根据id删除邮件: http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/DeleteMailById.ashx
功能:
根据id删除邮件
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/InternalMail/DeleteMailById.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | String | 邮件id |
mailType | True | String | 邮件类型 1、收件箱 2、发件箱 3、草稿箱 |
- 根据用户id收取邮件(电子邮件收件箱)
根据用户id收取邮件(电子邮件收件箱): http://[customer-site]/WebApi/Handler/1.0/OA/MailHelper/ReceiveMailApp.ashx
功能:
根据用户id收取邮件(电子邮件收件箱)
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/MailHelper/ReceiveMailApp.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 删除收件箱或者发件箱消息
删除收件箱或者发件箱消息: http://[customer-site]/WebApi/Handler/1.0/OA/Message/DeleteMessageContent.ashx
功能:
删除收件箱或者发件箱消息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/DeleteMessageContent.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": 无返回值}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
strID | True | String | 短讯ID, 可以多个 格式为 1,2,3,4,5 |
isSend | True | Boolean | true为删除发信箱 false 删除收信箱 |
- 获取指定id发给当前用户的未读消息,并且将状态改为已读
获取指定id发给当前用户的未读消息,并且将状态改为已读: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetUnreadMsgList.ashx
功能:
获取指定id发给当前用户的未读消息,并且将状态改为已读
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetUnreadMsgList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考消息List(Dialog)对象}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
recv_id | True | Int32 | 发送人id |
- 根据id返回指定的在线用户信息
根据id返回指定的在线用户信息: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetChatorUser.ashx
功能:
根据id返回指定的在线用户信息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetChatorUser.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考在线用户Online对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
userId | True | Int32 | 用户id |
- 获得用户所有未读系统消息列表
获得用户所有未读系统消息列表: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetAllUnReadSystemMessageList.ashx
功能:
获得用户所有未读系统消息列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetAllUnReadSystemMessageList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考系统消息List(SystemMessage)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 获得聊天列表
获得聊天列表: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetChatorList.ashx
功能:
获得聊天列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetChatorList.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考聊天List(Chator)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
org | True | String | 机构 |
dept | True | String | 部门 |
online | True | String | 0-所有,1-在线 |
- 获得和用户未读即时消息列表
获得和用户未读即时消息列表: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetUnReadMessageList.ashx
功能:
获得和用户未读即时消息列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetUnReadMessageList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考消息List(Dialog)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
recv_id | True | Int32 | 发送人id |
pageIndex | True | Int32 | 指定当前的页码 |
pageSize | True | Int32 | 指定要返回的记录条数 |
guest | True | String |
- 发送消息
发送消息: http://[customer-site]/WebApi/Handler/1.0/OA/Message/Send.ashx
功能:
发送消息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/Send.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
recv_id | True | Int32 | 接收人id |
content | True | String | 消息内容 |
guest | True | String | |
attValue | True | String |
- 获取历史记录
获取历史记录: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetHistory.ashx
功能:
获取历史记录
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetHistory.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考消息List(Dialog)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
recv_id | True | Int32 | 用户id |
pageIndex | True | Int32 | 指定当前的页码 |
pageSize | True | Int32 | 指定要返回的记录条数 |
guest | True | String |
- 获得用户所有未读消息列表
获得用户所有未读消息列表: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetAllUnReadMessageList.ashx
功能:
获得用户所有未读消息列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetAllUnReadMessageList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考消息List(Dialog)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 获取历史记录数
获取历史记录数: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetHistoryRowsCount.ashx
功能:
获取历史记录数
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetHistoryRowsCount.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (数量)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
recv_id | True | Int32 | 用户id |
guest | True | String |
- 根据id界定获取历史记录
根据id界定获取历史记录: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetMessageList.ashx
功能:
根据id界定获取历史记录
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetMessageList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考消息List(Dialog)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
recv_id | True | Int32 | 用户id |
posId | True | Int32 | 若指定此参数,则只返回ID比posId大的消息 |
pageSize | True | Int32 | 指定要返回的记录条数 |
guest | True | String |
- 获得所有未读消息数量
获得所有未读消息数量: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetAllUnReadCount.ashx
功能:
获得所有未读消息数量
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetAllUnReadCount.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (数量)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 获得单用户未读消息数量
获得单用户未读消息数量: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetUnReadCount.ashx
功能:
获得单用户未读消息数量
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetUnReadCount.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (数量)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
sender_id | True | Int32 | 发送人id |
guest | True | String |
- 获得所有未读消息数量
获得所有未读消息数量: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetAllUnReadCountList.ashx
功能:
获得所有未读消息数量
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetAllUnReadCountList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考消息数量List(MessageCount)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 获得在线用户列表
获得在线用户列表: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetOnlineList.ashx
功能:
获得在线用户列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetOnlineList.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考在线用户List(Online)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 根据id界定获取未读消息
根据id界定获取未读消息: http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetUnReadList.ashx
功能:
根据id界定获取未读消息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/GetUnReadList.ashx测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考消息List(Dialog)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
recv_id | True | Int32 | 发送人id |
posId | True | Int32 | 若指定此参数,则只返回ID比posId大的消息 |
pageSize | True | Int32 | 指定要返回的记录条数 |
guest | True | String |
- 向多人发送短信
向多人发送短信: http://[customer-site]/WebApi/Handler/1.0/OA/Message/SendSMS.ashx
功能:
向多人发送短信
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Message/SendSMS.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
user_ids | True | String | 用户id组例如:758,759 |
content | True | String | 短信内容 |
- 新增便签
新增便签: http://[customer-site]/WebApi/Handler/1.0/OA/Note/Add.ashx
功能:
新增便签
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Note/Add.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (受影响的行数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
content | True | String | 便签内容 |
- 更新便签
更新便签: http://[customer-site]/WebApi/Handler/1.0/OA/Note/Update.ashx
功能:
更新便签
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Note/Update.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | String | 便签id |
content | True | String | 便签内容 |
- 删除便签
删除便签: http://[customer-site]/WebApi/Handler/1.0/OA/Note/Delete.ashx
功能:
删除便签
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Note/Delete.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | String | 便签id |
- 删除所有便签
删除所有便签: http://[customer-site]/WebApi/Handler/1.0/OA/Note/DeleteAll.ashx
功能:
删除所有便签
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Note/DeleteAll.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 获取便签列表
获取便签列表: http://[customer-site]/WebApi/Handler/1.0/OA/Note/GetList.ashx
功能:
获取便签列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Note/GetList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考便签List(OA_Note_T_Note)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 清空便签本
清空便签本: http://[customer-site]/WebApi/Handler/1.0/OA/Note/DeleteAllItem.ashx
功能:
清空便签本
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Note/DeleteAllItem.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (受影响的行数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
Msg | True | String& | 输出参数 |
- 根据pkid审核外出登记
根据pkid审核外出登记: http://[customer-site]/WebApi/Handler/1.0/OA/OutDirCore/OutDirCheck.ashx
功能:
根据pkid审核外出登记
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/OutDirCore/OutDirCheck.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": null}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
pkId | True | String | |
checkNoMsg | True | String | |
YesOrNo | True | Boolean |
- 获取待办事务列表
获取待办事务列表: http://[customer-site]/WebApi/Handler/1.0/OA/PendingFlow/GetList.ashx
功能:
获取待办事务列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/PendingFlow/GetList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考待办事务List(PendingFlow)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
pageSize | True | Int32 | 指定要返回的记录条数 |
posId | True | Int32 | 若指定此参数,则只返回docid比posId小的待办事务列表 |
readType | True | String | Unread:未读Read:已读 |
searchKey | True | String | 关键词模糊搜索,当为空时则返回所有的待办事务列表(标题、流程名称、待处理人) |
- 获取待办事务数量
获取待办事务数量: http://[customer-site]/WebApi/Handler/1.0/OA/PendingFlow/GetCount.ashx
功能:
获取待办事务数量
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/PendingFlow/GetCount.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (数量)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 获取新的待办事务列表
获取新的待办事务列表: http://[customer-site]/WebApi/Handler/1.0/OA/PendingFlow/GetNewList.ashx
功能:
获取新的待办事务列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/PendingFlow/GetNewList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考待办事务List(PendingFlow)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
posId | True | Int32 | 若指定此参数,则只返回docid比posId大的待办事务列表 |
pageSize | True | Int32 | 指定要返回的记录条数 |
readType | True | String | Unread:未读Read:已读 |
searchKey | True | String | 关键词模糊搜索,当为空时则返回所有的待办事务列表(标题、流程名称、待处理人) |
- 获取个人信息
获取个人信息: http://[customer-site]/WebApi/Handler/1.0/OA/PersonalInfo/Get.ashx
功能:
获取个人信息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/PersonalInfo/Get.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考用户信息Contact对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
user_id | True | Int32 | 用户id |
- 更新个人信息
更新个人信息: http://[customer-site]/WebApi/Handler/1.0/OA/PersonalInfo/Update.ashx
功能:
更新个人信息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/PersonalInfo/Update.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (函数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
user_id | True | Int32 | 用户Id |
name | True | String | 姓名 |
sex | True | Int32 | 性别(0:女,1:男) |
office_tel | True | String | 办公室电话 |
mobile | True | String | 手机 |
fax | True | String | 传真 |
True | String | 邮箱 | |
home_address | True | String | 家庭住址 |
home_tel | True | String | 家里电话 |
post_code | True | String | 邮编 |
signature | True | String | 个人签名 |
remark | True | String | 备注 |
- 删除个人信息
删除个人信息: http://[customer-site]/WebApi/Handler/1.0/OA/PersonalInfo/Delete.ashx
功能:
删除个人信息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/PersonalInfo/Delete.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (行数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
user_id | True | Int32 | 用户id |
- 更新个人签名
更新个人签名: http://[customer-site]/WebApi/Handler/1.0/OA/PersonalInfo/UpdateSignature.ashx
功能:
更新个人签名
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/PersonalInfo/UpdateSignature.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (行数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
user_id | True | Int32 | 用户Id |
signature | True | String | 个人签名 |
- 按登录账号获取用户信息
按登录账号获取用户信息: http://[customer-site]/WebApi/Handler/1.0/OA/PersonalInfo/GetByAccount.ashx
功能:
按登录账号获取用户信息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/PersonalInfo/GetByAccount.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考用户信息Contact对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
login_name | True | String | 登录帐号 |
- 获取当前用户公告新增列表
获取当前用户公告新增列表: http://[customer-site]/WebApi/Handler/1.0/OA/Placard/GetCurrentUserPlacardNewList.ashx
功能:
获取当前用户公告新增列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Placard/GetCurrentUserPlacardNewList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考公告List(Placard)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
pageSize | True | Int32 | 指定要返回的记录条数 |
state | True | Int32 | 状态1:新增0:旧的 |
Time | True | String | 公告时间,精确到秒。如:2013-05-05 10:25:30 |
- 获取当前用户公告列表
获取当前用户公告列表: http://[customer-site]/WebApi/Handler/1.0/OA/Placard/GetCurrentUserPlacardList.ashx
功能:
获取当前用户公告列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Placard/GetCurrentUserPlacardList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考公告List(Placard)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
pageSize | True | Int32 | 指定要返回的记录条数 |
state | True | Int32 | 状态1:新增0:旧的 |
Time | True | String | 公告时间,精确到秒。如:2013-05-05 10:25:30 |
- 根据id获取公告内容
根据id获取公告内容: http://[customer-site]/WebApi/Handler/1.0/OA/Placard/Get.ashx
功能:
根据id获取公告内容
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Placard/Get.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考公告Placard对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | Int32 | 公告id |
- 获取未读公告数量
获取未读公告数量: http://[customer-site]/WebApi/Handler/1.0/OA/Placard/GetUnReadCount.ashx
功能:
获取未读公告数量
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Placard/GetUnReadCount.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (数量)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 回复或标识已读
回复或标识已读: http://[customer-site]/WebApi/Handler/1.0/OA/Placard/Reply.ashx
功能:
回复或标识已读
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Placard/Reply.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | Int32 | 公告id |
content | True | String | 回复内容 |
- 标识已读
标识已读: http://[customer-site]/WebApi/Handler/1.0/OA/Placard/MarkReaded.ashx
功能:
标识已读
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Placard/MarkReaded.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | Int32 | 公告id |
- 获得当前用户事务
获得当前用户事务: http://[customer-site]/WebApi/Handler/1.0/OA/Schedule/GetCurrentUserScheduleList.ashx
功能:
获得当前用户事务
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Schedule/GetCurrentUserScheduleList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考日程事务List(Schedule)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
pageSize | True | Int32 | 指定要返回的记录条数 |
posId | True | Int32 | 若指定此参数,则只返回ID比posId小的用户事务(即比posId发表时间早的用户事务) |
- 根据id获取日程事务
根据id获取日程事务: http://[customer-site]/WebApi/Handler/1.0/OA/Schedule/GetScheduleByID.ashx
功能:
根据id获取日程事务
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Schedule/GetScheduleByID.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考日程事务Schedule对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | Int32 | 日程事物id |
- 根据id删除日程事务
根据id删除日程事务: http://[customer-site]/WebApi/Handler/1.0/OA/Schedule/Delete.ashx
功能:
根据id删除日程事务
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Schedule/Delete.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (受影响的行数)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | Int32 | 日程事物id |
- 获取日程事务类型列表
获取日程事务类型列表: http://[customer-site]/WebApi/Handler/1.0/OA/Schedule/GetScheduleTypeList.ashx
功能:
获取日程事务类型列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Schedule/GetScheduleTypeList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考日程事务类型List(ScheduleType)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 增加日程事
增加日程事: http://[customer-site]/WebApi/Handler/1.0/OA/Schedule/Add.ashx
功能:
增加日程事
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Schedule/Add.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
title | True | String | 主题 |
recv_type | True | Int32 | 执行人类型(1:人员,2:部门,3:机构,4:职位) |
recv_ids | True | String | 执行人id,多个以逗号相隔 |
recv_names | True | String | 执行人名称,多个以逗号相隔 |
start_date | True | DateTime | 开始时间 |
stop_date | True | DateTime | 结束时间 |
content | True | String | 正文 |
type_name | True | String | 类型(4:工作安排,8:客户资源分派,10:事务提醒,14:重要提醒,17:培训通知) |
- 获取日程事数量
获取日程事数量: http://[customer-site]/WebApi/Handler/1.0/OA/Schedule/GetCount.ashx
功能:
获取日程事数量
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/Schedule/GetCount.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": count (数量)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 创建流程
创建流程: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/Create.ashx
功能:
创建流程
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/Create.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": docid (文档id)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
flow_id | True | Int32 | 文档id |
mod_code | True | String | 表单编码 |
title | True | String | 标题 |
sub_title | True | String | 副 标 题 |
content | True | String | 内容 |
status | True | Int32 | 状态(0,流程开始或未处理状态;1、处理中状态;2、处理完成状态;4、撤销) |
url | True | String | 表单编辑页面地址 |
doc_value | True | String | 表单主键id |
- 删除流程
删除流程: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/Delete.ashx
功能:
删除流程
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/Delete.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
doc_id | True | Int32 | 文档id |
- 获取常用处理意见列表
获取常用处理意见列表: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/GetAttitudeList.ashx
功能:
获取常用处理意见列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/GetAttitudeList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考处理意见List(Attitude)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
- 获取流程实例信息
获取流程实例信息: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/GetDoc.ashx
功能:
获取流程实例信息
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/GetDoc.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考流程实例Doc对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
id | True | Int32 | 流程文档ID |
- 获取流程实例步骤
获取流程实例步骤: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/GetDocStep.ashx
功能:
获取流程实例步骤
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/GetDocStep.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考流程步骤DocStep对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
doc_step_id | True | Int32 | 步骤id |
- 获取流程实例下一步骤
获取流程实例下一步骤: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/GetNextDocStep.ashx
功能:
获取流程实例下一步骤
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/GetNextDocStep.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考流程步骤DocStep对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
doc_step_id | True | Int32 | 流程id |
agree | True | Int32 | 路由条件0-无条件,1-通过,2-不通过 |
- 获取流程实例下一步骤列表
获取流程实例下一步骤列表: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/GetNextDocStepList.ashx
功能:
获取流程实例下一步骤列表
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/GetNextDocStepList.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": value_content(参考流程步骤List(DocStep)对象)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
doc_step_id | True | Int32 | 步骤id |
- 判断步骤是否已经处理
判断步骤是否已经处理: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/CheckDocStepIsFinished.ashx
功能:
判断步骤是否已经处理
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/CheckDocStepIsFinished.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
doc_step_id | True | Int32 | 步骤id |
- 判断是否知会的处理流程人都处理完毕
判断是否知会的处理流程人都处理完毕: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/NotifyTreatCheck.ashx
功能:
判断是否知会的处理流程人都处理完毕
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/NotifyTreatCheck.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
docId | True | Int32 | 流程文档id |
docStepId | True | Int32 | 步骤Id |
- 判断当前审核是否可流转到下一步
判断当前审核是否可流转到下一步: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/CanToNextStep.ashx
功能:
判断当前审核是否可流转到下一步
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/CanToNextStep.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
docId | True | Int32 | 流程文档id |
docStepId | True | Int32 | 步骤id |
agree | True | Boolean | 路由条件0-无条件,1-通过,2-不通过 |
- 流程处理-流转
流程处理-流转: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/Next.ashx
功能:
流程处理-流转
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/Next.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": message (success:成功,错误消息)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
doc_id | True | Int32 | 流程文档ID |
current_step_id | True | Int32 | 步骤ID |
check | True | Boolean | 是否同意 |
next_step_sign_name | True | String | 下一步处理人 |
content | True | String | 处理意见 |
- 流程处理-审核
流程处理-审核: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/Audit.ashx
功能:
流程处理-审核
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/Audit.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": message (success:成功,错误消息)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
doc_id | True | Int32 | 流程文档ID |
current_step_id | True | Int32 | 步骤ID |
check | True | Boolean | 是否同意 |
next_step_sign_name | True | String | 下一步处理人 |
content | True | String | 处理意见 |
- 流程处理-多选
流程处理-多选: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/Mult.ashx
功能:
流程处理-多选
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/Mult.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": message (success:成功,错误消息)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
doc_id | True | Int32 | 流程文档ID |
current_step_id | True | Int32 | 步骤ID |
next_step_name | True | String | 下一步骤名称 |
next_doc_step_id | True | Int32 | 下一步步骤id |
next_step_sign_name | True | String | 下一步处理人 |
content | True | String | 处理意见 |
- 增加流程审核人
增加流程审核人: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/AddStepExecutor.ashx
功能:
增加流程审核人
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/AddStepExecutor.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": message (success:成功,错误消息)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
doc_id | True | Int32 | 流程文档ID |
step_id | True | Int32 | 步骤ID |
orgs | True | String | 机构id组,机构id以逗号相隔 |
depts | True | String | 部门id组,部门id以逗号相隔 |
poss | True | String | 职位id组,职位id以逗号相隔 |
roles | True | String | 角色id组,角色id以逗号相隔 |
users | True | String | 用户id组,用户id以逗号相隔 |
- 设置待办为已读
设置待办为已读: http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/SetActiveStepReaded.ashx
功能:
设置待办为已读
接口地址:
http://[customer-site]/WebApi/Handler/1.0/OA/WorkFlow/SetActiveStepReaded.ashx 测试
返回格式:
JSON
HTTP请求方式:
GET/POST
请求参数:
Json返回结果:
{"value": true (true:成功,false:失败)}
关于错误返回值与错误代码,参见错误代码说明
参数名 | 是否必须 | 类型 | 说明 |
token | True | string | 当前登录用户访问令牌 |
format | 否 | string | 返回数据的格式(json或xml),默认为json格式 |
iDocStepID | True | Int32 | 流程步骤id |