主页 > API > 获取日程列表


获取日程列表

/v1/events
  • URL

    https://api.worktile.com/v1/events

  • HTTP请求方式

    GET

  • 支持格式

    JSON

    Header参数

    {
       "Content-Type":"application/json",
       "access_token":"xxx"
    }
    

    示例

    curl -l https://api.worktile.com/v1/events?pid=xxx&start=1412355660000&end=1412221344000&access_token=xxx
    
  • HTTP请求参数

    参数 必选 类型 说明
    pid true string 项目pid
    start true number 开始时间的时间戳(13位)
    end true number 结束时间的时间戳(13位)
    access_token true string OAuth授权后获得,请求时可放在header中
  • 返回数据

    示例

    HTTP/1.1 200 ok

    [ { "event_id":"18325d01a1164007a5181bbc4b82bda4", "name":"每周例会", "summary":"", "location":"", "start":"2015-03-17T23:30:00.000Z", "end":"2015-03-17T23:30:00.000Z", "recurrence":0, "attendees":[ { "uid":"679efdf3960d45a0b8679693098135ff", "name":"gonglinjie", "display_name":"龚林杰", "avatar":"default_avatar.png", "desc":"", "status":3, "online":0 } ], "project":{ "pid":"eda54f766b7f457ea7cdb5a93c6d892e", "name":"Worktile 开发", "pic":"icon-qrcode", "bg":"#4761b5" } }, { "event_id":"06259cd0abd64636a0756a65037b76a8", "name":"Open API", "summary":"", "start":"2015-03-08T23:10:00.000Z", "end":"2015-03-09T02:30:00.000Z", "recurrence":0, "attendees":[ ], "project":{ "pid":"eda54f766b7f457ea7cdb5a93c6d892e", "name":"Worktile 开发", "pic":"icon-qrcode", "bg":"#4761b5" } } ]


    返回值字段 类型 说明
    event_id string 日程id
    name string 日程内容
    summary string 日程描述
    location string 位置或地点
    email string 用户邮箱
    desc string 用户描述
    start string 日程开始时间
    end string 日程结束时间
    recurrence number 循环日程类型:0:不是循环日程,1:每日循环,2:每周循环,3:每月循环,4:每年循环
    attendees array 日程参与成员的集合 详情 收起
        uid string 参与日程成员的uid
        name string 参与日程成员的用户名
        display_name string 参与日程成员的昵称
        avatar string 参与日程成员的头像
        desc string 参与日程成员说明
        status number 参与日程成员状态:1:正常,2:邀请,3:需要邮件确认
        online number 参与日程成员的在线状态,0:离线,1:在线,2:忙碌,3:离开
    project object 项目 详情 收起
        pid string 项目pid
        name string 项目名称
        pic string 项目图标
        bg string 项目背景颜色
  • 异常结果

    示例

    HTTP/1.1 400 Bad Request

    { "error_code":700001, "error_message":"开始时间和结束时间不正确", "request":"/v1/events" }


    错误码(error_code) 错误信息(error_message) http状态码(statusCode)
    100005 未授权,请授权后再操作 401
    100006 access_token不正确 400
    700001 开始时间和结束时间不正确 400
    700002 获取日程失败 500