待办管理模块
- 2021-08-09 13:27:56
- 曹延义
- 2971
- 最后编辑：刘若谷 于 2021-08-10 09:03:53
- 分享链接
一、获取待办列表
请求地址：GET /api.php/v1/sys/todoes
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
| mode | 否 | all |
all: 全部
assignedtoother: 指派他人
assignedtome: 指派给我 undone: 未完成 future:待定 |
| sort |
否 |
sort, 'date_desc,status,begin |
按照 "_" 字符前面的字段进行排序 desc为降序 asc 为升序 |
|
total |
否 | 0 | 总数据量 |
|
limit |
否 |
20 |
每页数量 |
|
page |
否 |
1 |
当前页数 |
请求示例：
curl --location --request GET 'https://biz.demo.zdoo.com/api.php/v1/sys/todoes/' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"status": "success",
"data": {Objects} }
|
字段 |
类型 | 描述 |
|
todos |
string | 待办列表 |
| pager | object | 分页信息 |
|
users |
object |
用户列表 |
|
title |
string |
页面标题 |
二、获取待办详情
请求地址：GET /api.php/v1/sys/todoes/:id
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求示例：
curl --location --request GET 'https://biz.demo.zdoo.com/api.php/v1/sys/todoes/1' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{ "status": "success",
"data": {Objects}
}
|
字段 |
类型 | 描述 |
|
title |
string | 页面标题 |
| todo | object | 待办信息 |
| times | object | 时间信息 |
| users | object | 用户信息 |
三、创建待办信息
请求地址：POST /api.php/v1/sys/todoes
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| type | 是 | string |
待办类型
{
"custom": "自定义",
"task": "项目任务",
"order": "订单沟通",
"customer": "客户沟通"
}
|
| name | 是 | string | 待办名称 |
| idvalue | 否 | int | 如果type != 'custom' 该字段必填 |
|
pri |
否 |
stri ng | 优先级 |
|
date |
否 | stri ng | 日期 |
| begin |
否 |
string |
开始时间 |
|
end |
否 |
string | 结束时间 |
|
amount |
否 | float |
合同金额 |
| assignedTo | 否 | array | 指派给 |
|
desc |
否 |
string |
描述 |
请求示例：
curl --location --request POST 'https://biz.demo.zdoo.com/api.php/v1/sys/todoes' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json' \
--data-raw '{"type":"custom","name":"测试待办","pri":3,"date":"","begin":"","end":"","assignedTo":"","desc":""}'
返回结果(200)：
{
"result": "success",
"message": "保存成功"
}
返回结果(400)：
{
"error": errorMessage
}
四、修改待办信息
请求地址：PUT /api.php/v1/sys/todoes/:id
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| type | 是 | string |
待办类型（不可修改） |
| name | 是 | string | 待办名称 |
| idvalue | 否 | int | 如果type != 'custom' 该字段必填 |
|
pri |
否 |
stri ng | 优先级 |
|
date |
否 | string | 日期 |
| begin |
否 |
string |
开始时间 |
|
end |
否 |
string | 结束时间 |
|
amount |
否 | float |
合同金额 |
| assignedTo | 否 | array | 指派给 |
|
desc |
否 |
string |
描述 |
请求示例：
curl --location --request PUT 'https://biz.demo.zdoo.com/api.php/v1/sys/todoes/1' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"type":"custom","name":"测试待办","pri":3,"date":"","begin":"","end":"","assignedTo":"","desc":""}'
返回结果(200)：
{
"result": "success",
"message": "保存成功"
}
返回结果(400): {
"error": errorMessage
}
五、完成/激活待办
请求地址：PUT /api.php/v1/sys/todoes/:id/:type
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
| 字段 | 必填 | 类型 | 描述 |
| type | 是 | string |
类型 finish 完成 activate 激活
|
请求示例：
curl --location --request PUT 'https://biz.demo.zdoo.com/api.php/v1/sys/todoes/1/finish' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"result": "success",
"message": "保存成功"
}
返回结果(400):
{
"error": errorMessage
}