麦库开果放api开发者文档_v1.2_2012年7月20日.docVIP

盛大创新院麦库记事项目组 麦库记事开放API 开发者文档 当前版本V1.0 2012/3/14 前言 3 用户信息 4 笔记分类接口 4 创建 4 更新 7 删除 8 笔记接口 9 创建 9 读取 11 读取多个 12 更新 14 删除 16 附件接口 18 创建 18 删除 19  前言 本文档为麦库记事开放API开发者文档，本文档所有内容如无特殊说明，遵循以下约定： 编码：字符集编码（如有需要）均为UTF-8；字符串的Base64编码是指将原始字符串进行UTF-8编码（得到byte数组）后再进行Base64转换（得到一个字符串）。 协议：所有接口均使用HTTP协议，请求的头信息中必须包含以下字段： Authorization： Content-Type：application/json（附件上传接口除外） 如需要启用压缩，则使用标准的Accept-Encoding头信息指定gzip或deflate 异常：每个接口都可能，除了HTTP标准Status Code之外，还可以得到服务器返回的错误信息，例如： 返回内容 401 {error: missing or invalid authorization token} 每个接口都可能会遇到的： 含义 401 缺少正确的 500 服务器错误 503 服务器忙，暂不可用 更多参考各说明。 /{version}/note-category 若当前API版本为v1.0，则实际代码中请求的URL为 /v1.0/note-category 另外数据也有“版本version”的概念，比如一条笔记的version为131897628352，version值越大，版本越新。 缺省值：代码示例中的json字段后紧随的说明文字中，中括号[ ]表示该字段为可选字段（即传入的json中可以不包含该字段），中括号中的值如[ “abc” ]表示没有提供该字段的情况下的缺省值。 用户信息 获取当前用户信息 请求（模板）： HTTP方法 GET URL /user/current 说明 获得的 正常回复示例： 200 Body { id: 1243291623, nickName: 测试帐号 } 回复： 含义 40 无效的凭证 笔记分类接口 创建 请求（模板）： HTTP方法 POST URL /{version}/note-category Body { name: category_name, // 分类名 parentId: id_of_parent_category, // 父分类ID1 accessLevel: // [“private”] 访问级别2，private或public } 备注 parentId空字符串或null，表示创建根分类。 如果指定了parentId，则会忽略accessLevel值，自动根据父分类决定该分类的访问级别。 正常回复（示例）： Status Code 200 Body { id: 27JpL~j4vsL0LX00E00005, name: 运动养生, parentId: 27JpL~j6UGCgLX00s001Al, userId: // 用户ID type: normal, // 类型default，normal或system accessLevel: private, version: // 版本号 } 说明 返回新创建的笔记分类信息，其中会包含一些额外字段并赋值，例如id及version。 异常回复： Status Code 含义 400 数据提交格式错误。 409 字段内容不合法 父分类不存在或不合法（例如超过二级分类的限制） 读取 请求： HTTP方法 GET URL /{version}/note-categories 说明 获取所有笔记分类 正常回复（示例）： Status Code 200 Body [{ id: 27JpL~j4fJwMLX00w00001, name: 默认分类, parentId: , userId: 123986, type: default, accessLevel: private version: }, { id: 27JpL~jim1OFnM01k000IC, name: 移动开发, parentId: 27JpL~j4fJwMLX00w00001, userId: 123986, type: normal, accessLevel: private version: