主页 > API > 新建日程


新建日程

/v1/event
  • URL

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

  • HTTP请求方式

    POST

  • 支持格式

    JSON

    Header参数

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

    示例

    curl -d 'name=开会&location=办公室&start_date=2015-03-25&start_time=10:20&end_date=2015-03-25&end_time=11:30&summary=summary&recurrence=0&attendees=['xxxaa']' 'https://api.worktile.com/v1/event?pid=xxx&access_token=xxx' 
    
  • HTTP请求参数

    参数 必选 类型 说明
    pid true string 项目pid
    access_token true string OAuth授权后获得,请求时可放在header中
    name true string 日程名称
    summary false string 日程描述
    location false string 位置或地点
    start_date true string 开始日期
    start_time true string 开始时间
    end_date true string 结束日期
    end_time true string 结束时间
    recurrence true number 是否重复:0:不重复,1:每日循环,2:每周,3:每月,4:每年
    attendees false Array 参与日程的成员uid的集合
  • 返回数据

    示例

    HTTP/1.1 200 ok

    { "event_id":"67f8351b955c4d91a3b18c867ae7166c", "name":"开会", "summary":"", "location":"会议室", "start":"2015-03-25T02:20:00.000Z", "end":"2015-03-25T03: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 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":700003, "error_message":"日程名称为空", "request":"/v1/event" }


    错误码(error_code) 错误信息(error_message) http状态码(statusCode)
    100005 没授权,请授权后再操作 401
    100006 access_token不正确 400
    700003 日程名称为空 400
    600004 日程开始日期和时间不能为空 400
    600005 日程结束日期和时间不能为空 400
    700006 日程的重复类型不正确 400
    700007 创建日程失败 500