MSN OAuth 2.0 API
其余的 API
15(共 47)对本文的评价是有帮助评价此主题
住连接代表性状态传输 (REST) API 使工作与生活连接到访问以编程方式对用户,他们的联系人和朋友,他们的基于 web 的活动和个人状态,它们存储在 SkyDrive,和更多的媒体信息的应用程序。
本主题包含以下各节:
- 支持的 HTTP 动词
- 支持断点续传下载
- 了解对象
- 活动对象
- 相册对象
- 应用程序对象
- 音频对象
- 日历对象
- 注释对象
- 联系人对象
- 错误对象
- 事件对象
- 文件对象
- 文件夹对象
- 朋友对象
- 权限对象
- 照片对象
- 标记对象
- 用户对象
- 视频对象
- 附加 URL 参数
支持的 HTTP 动词
住连接其它 API 支持标准的 HTTP 谓词。
- 获取— — 返回资源的表示形式。
- 职位— — 向集合中添加一个新的资源。
- 把— — 更新资源指出由 URL 的位置或创建新的资源,如果它不存在。
- 删除— 删除资源。
- 移动— — 移动资源的位置。
- 副本— — 允许重复的资源。
请求的 Url 必须引用https://apis.live.net/v5.0/,跟着您正在使用的对象,任何参数,和最后,访问令牌的路径 (表示为ACCESS_TOKEN).
https://apis.live.net/v5.0/me/albums?access_token=ACCESS_TOKEN
支持断点续传下载
实时连接的断点续传下载提供支持,通过使用HTTP 范围标头。如果下载被中断,一个应用程序可以通过请求仅文件的其余部分的字节范围继续在以后的时间下载。这是非常有用的下载较大的文件时或在网络可靠性不太理想的情况下。
了解对象
在住连接其它 API 中,每个类别的信息包含在对象。对象包含的子对象、数组和值组合。若要访问特定的对象,您需要知道的唯一路径,并在很多情况下,该对象的唯一 ID。
下表列出的对象所支持的活连接其它 API 请求,以及有效的对象的路径。
对象 | 说明 | 有效的对象路径 |
用户活动饲料和状态消息中的一个活动。 | / 我/共享 /USER_ID/share | |
用户在 SkyDrive 的相册。相册可以包含组合的照片、 视频、 音频、 文件和文件夹。 | / 我/相册 /USER_ID/albums /ALBUM_ID 专辑的对象可以作为的一部分返回 /ALBUM_ID/files、 /me/skydrive/files、 /me/skydrive/shared/files、 /me/skydrive/shared/albums、 或 /USER_ID/skydrive/文件。 | |
工作与生活连接的客户端 ID。 | / 我/应用程序 /USER_ID应用程序 — /APPLICATION_ID | |
用户的音频 SkyDrive 中。 | /AUDIO_ID 音频对象可以作为的一部分返回 /ALBUM_ID/files,/FOLDER_ID/files、 /me/skydrive/files 或USER_ID/skydrive/文件。 | |
用户的日历。 | / 我/日历 /USER_ID/calendars /CALENDAR_ID | |
一张照片或录像的 SkyDrive 上的用户所做的注释。 | /PHOTO_ID/comments /VIDEO_ID/comments /COMMENT_ID | |
用户的 Hotmail 联系人。(如果该联系人的is_friend值设置为true,联系人是还用户的朋友。 | / 我/联系人 /USER_ID/contacts /CONTACT_ID | |
有关由住连接 Api 返回的错误的信息。 | 无。 | |
对用户的日历事件。 | / 我/事件 /USER_ID/events /CALENDAR_ID/events | |
SkyDrive 中用户的文件。 | /FILE_ID 文件对象可以作为的一部分返回 /FOLDER_ID/files、 /me/skydrive/files、 /me/skydrive/shared、 /me/skydrive/shared/files、 或 /USER_ID/skydrive/文件。 | |
在 SkyDrive 的用户的文件夹。文件夹可以包含组合的照片、 视频、 音频、 文件 (例如,Microsoft Office 文档) 和子文件夹。 | /FOLDER_ID 文件夹对象可以作为的一部分返回 /FOLDER_ID/files、 /me/skydrive/files、 /me/skydrive/shared/files、 /USER_ID/skydrive/文件或 /ALBUM_ID/files。 | |
用户的朋友。朋友是用户的联系人的子集,并反映用户公开可见与有关系的人。查看用户的朋友不是需要显式权限。因为朋友返回数据少于接触,是为需要名称和 Id 的用户的朋友的方案更紧凑。 | 朋友/我 / /USER_ID/friends | |
作用域的列表。 | / 我/权限 /USER_ID/permissions | |
用户在 SkyDrive 的照片。 | /PHOTO_ID 照片对象可以作为的一部分返回 /ALBUM_ID/files,/ALBUM_ID/photos,/FOLDER_ID/files、 /me/skydrive/files、 /me/skydrive/shared/photos、 或USER_ID/skydrive/文件。 | |
与一张照片或录像的 SkyDrive 相关联的标记。 | /PHOTO_ID/tags /VIDEO_ID/tags /TAG_ID | |
用户。 | /me /USER_ID | |
用户的视频 SkyDrive 中。 | /VIDEO_ID 视频对象可以作为的一部分返回 /ALBUM_ID/files,/ALBUM_ID/videos,/FOLDER_ID/files、 /me/skydrive/files、 /me/skydrive/shared/videos、 或USER_ID/skydrive/文件。 |
在前面的表替换USER_ID、 CONTACT_ID、 ALBUM_ID、 PHOTO_ID、 VIDEO_ID、 AUDIO_ID、 FOLDER_ID或APPLICATION_ID与目标用户 ID,联系人对象 ID,专辑对象 ID,照片对象 ID、视频对象 ID,音频对象 ID,文件夹对象 ID 或应用程序的对象 ID 或住连接的客户端 ID 分别。
在前面的表中,您可以使用 /me 作为快捷方式在签署用户而不是指定的 /USER_ID。但是,不能使用 /me,除非您还提供一个访问令牌。
住连接其它 API 交换之间的应用程序、 实时连接,和 SkyDrive JavaScript 对象表示法 (JSON) 格式的信息。(此,JSON 条款结构、对象、数组和值使用在本参考。
当你的应用程序获取请求的对象,住连接其它 API 以 JSON 格式的结构返回请求的信息。同样地,当你的应用程序开机自检或提出请求,住连接其余 API 将需要向它提交作为 JSON 格式的结构信息。关于 JSON 的详细信息,请参见介绍 JSON (http://www.json.org)。
筛选查询参数
若要指定要返回请求 SkyDrive 的项目时,如下所示的项目类型,可以使用筛选器查询参数。
/FOLDER_ID/files?filter=albums
支持下列值:
- 相册
- 音频
- 文件夹
- 照片
- 视频
指定多个值时,请使用逗号分隔的列表,像这样。
/FOLDER_ID/files?filter=videos,audio
筛选查询参数支持任何返回的 SkyDrive 的项目列表,例如查询 /files,在结束的请求或 / 共享。
结构的值的选项
在下面的章节中,标记为R/W的列指示是否一个值为只读或读/写,并标记为需要对创建的列指示值是否需要创建对象。
活动对象
活动对象包含在饲料的用户的活动和状态消息的活动有关的信息。住连接其它 API 支持创建活动对象。使用wl.share范围创建活动对象。
活动对象包含以下结构。
结构 | 类型 | R/W | 所需的创建 | 说明 |
从 | 对象 | R |
| 用户的共享活动有关的信息。这种结构是仅在返回的活动对象中可见如果成功共享的活动。 |
(从对象) 的名称 | 字符串 | R |
| 共享活动的用户的名称。这种结构是仅在返回的活动对象中可见如果成功共享的活动。 |
id (从对象) | 字符串 | R |
| 共享活动的用户的 Windows Live ID。这种结构是仅在返回的活动对象中可见如果成功共享的活动。 |
消息 | 字符串 | 乌尔曼 | 是 | 消息的文本。 |
链接 | 字符串 | 乌尔曼 |
| 共享的内容的 URL。 |
说明 | 字符串 | 乌尔曼 |
| 共享内容的说明。 |
图片 | 字符串 | 乌尔曼 |
| 共享内容的缩略图图像的 URL。 |
名称 | 字符串 | 乌尔曼 |
| 共享内容的标题。 |
源 | 字符串 | 乌尔曼 |
| 视频源的文件,如果这是一个视频活动 URL。 |
一些活动所需的类型和可选的结构下, 表中所述。
活动类型 | 所需的结构 | 允许使用可选的结构 |
文本 | 消息 | 无 (说明、图片、名称和源必须不存在)。 |
文本的链接 | 消息链接 | 描述、图片、名称 如果包含图片,则它是指预览或内容的缩略图视图。 |
视频 | 消息、链接、源 | 描述、图片、名称 如果包含图片,则它是指预览或内容的缩略图视图。 |
无需指定其所需的结构共享这些活动类型之一,则将返回错误。
重要活动对象的结构的值不能超过 512 个字符,不能超过 487 字符的值源结构的例外。如果链接或源字段的值超出了各自的最大限制,调用将返回错误。所有其他结构,超过最大长度的值被截断并发送。
以下是活动对象的示例。
{
message: "Explore Windows Live Hotmail",
link: "http://explore.live.com/windows-live-hotmail",
description: "Give us 15 seconds...we'll show you the new Hotmail!",
picture: "http://res2.explore.live.com/...part of URL omitted for brevity...fd39.jpg",
name: "Windows Live Hotmail Home"
}
通过使用实时连接其它 API 创建活动对象,使共享/我 / POST请求。在请求的正文中,包括活动的属性,如下所示。
Content-Type: application/json
{
message: "Explore Windows Live Hotmail",
link: "http://explore.live.com/windows-live-hotmail",
description: "Give us 15 seconds...we'll show you the new Hotmail!",
picture: "http://res2.explore.live.com/...part of URL omitted for brevity...fd39.jpg",
name: "Windows Live Hotmail Home"
}
若要了解如何创建其他活动类型,请参阅共享用户状态.
请注意
如果调用成功在此示例中,实时连接其它 API 返回以下的 JSON 格式的对象。
{
"from": {
"name": "Roberto Tamburello",
"id": "8c8ce076ca27823f"
},
"message": ...The message value...,
"link": ...The link value, if one was provided, otherwise null...,
"description": ...The description value, if one was provided, otherwise null...,
"picture": ...The picture value, if one was provided, otherwise null...,
"name": ...The name value, if one was provided, otherwise null...,
"source": ...The source value, if one was provided, otherwise null...
}
相册对象
相册对象包含关于用户的影集 SkyDrive 中的信息。相册存储在根级别的用户的 SkyDrive 目录,并且可以包含组合的照片、 视频、 音频、 文件和文件夹。阅读专辑对象的活连接其它 API 支持。使用wl.photos范围读取用户的相册对象。使用wl.skydrive范围读取用户的文件。使用wl.contacts_photos范围读取任何专辑、 照片、 视频和音频,用户与其他用户共享。
相册对象包含以下结构。
结构 | 类型 | R/W | 所需的创建 | 说明 |
数据 | 阵列 | R |
| 相册对象时,对象的集合,则返回的数组容器。 |
id | 字符串 | R |
| 相册对象的 id。 |
从 | 对象 | R |
| 有关编写相册的用户的信息。 |
(从对象) 的名称 | 字符串 | R |
| 编写相册的用户的名称。 |
id (从对象) | 字符串 | R |
| 编写相册的用户的 Windows Live ID。 |
名称 | 字符串 | 乌尔曼 | 是 | 专辑的名称。 |
说明 | 字符串/空 | 乌尔曼 |
| 专辑,或null如果没有描述指定的说明。 |
计数 | 编号 | R |
| 在相册中项的总数。 |
链接 | 字符串 | R |
| 相册,在 SkyDrive 中承载的 URL。 |
parent_id | 字符串 | R |
| 父母的资源 ID。 |
upload_location | 字符串 | R |
| 将项目上载到相册,在 SkyDrive 中承载的 URL。需要wl.skydrive范围。 |
类型 | 字符串 | R |
| 类型的对象 ;在此案例,"相册"。 |
created_time | 字符串 | R |
| ISO 8601 格式,创建相册的时间。 |
updated_time | 字符串 | R |
| ISO 8601 格式,相册上次更新的时间。 |
shared_with | 对象 | R |
| 包含的对象的相册的权限信息。需要wl.skydrive范围。 |
访问 (shared_with 对象) | 字符串 | R |
| 包含关于谁可以访问唱片集信息的本地化的字符串。选项有: · 我选的人 · 就我自己 · 所有人 (公开) · 朋友 · 我的朋友们和他们的朋友 · 有一个链接的人 默认情况下只是我. |
以下是集合的专辑的对象的示例。(为简洁起见,只有第一个对象是显示。
{
"data": [
{
"id": "album.8c8ce076ca27823f.8C8CE076CA27823F!126",
"from": {
"name": "Roberto Tamburello",
"id": "8c8ce076ca27823f"
},
"name": "My Sample Album 1",
"description": "",
"parent_id": "folder.de57f4126ed7e411",
"upload_location": "https://apis.live.net/v5.0/folder.de57f4126ed7e411.DE57F4126ED7E411!126/files/",
"count": 4,
"link": "https://cid-8c8ce076ca27823f.skydrive.live.com/redir.aspx?page\u003dself\u0026resid\u003d8C8CE076CA27823F!126\u0026type\u003d5",
"type": "album",
"shared_with": {
"access": "Everyone (public)"
},
"created_time": "2011-04-21T23:19:47+0000",
"updated_time": "2011-04-22T19:18:12+0000"
}, {
...
}
]
}
要获取相册对象的集合,使用实时连接其它 API,进行/我/影集GET请求。
请注意要获取一张专辑封面图像,请调用 /ALBUM_ID/picture。
若要创建新的专辑资源,进行POST请求/我/影集。在请求的正文中,传递的名称和说明的属性,如下所示。
{
"name": "Vacation 2011",
"description": "Photos from our fun vacation."
}
要更新相册的属性,使提出的请求 /ALBUM_ID。通过在请求的正文中,更新的属性,如下所示。
{
"name": "Maui Vacation 2011",
"description": "Photos from our vacation on Maui."
}
要删除相册,请删除请求 /ALBUM_ID.
应用程序对象
应用程序对象包含有关客户端开发者的工作与生活连接的 Id 的信息。住连接其它 API 支持读取和创建应用程序对象。使用wl.applications范围读取应用程序对象,并使用wl.applications_create范围创建应用程序对象。
创建、 读取、 更新和删除的应用程序的能力对象可用于提供商通过第三方网站生成注释或登录小部件的使用。提供应用程序 ID 为每个使用该提供程序的构件的网站启用 OAuth 授权提供重定向 URL 并跟踪分析构件使用https://manage.dev.live.com的第三方网站.
应用程序对象包含以下结构。
结构 | 类型 | R/W | 所需的创建 | 说明 |
数据 | 阵列 | R |
| 应用程序对象,如果对象的集合,则返回的数组。 |
id | 字符串 | R |
| 应用程序对象的 id。不指定此结构时,您创建的客户端 ID,因为系统生成它会自动在创建时。 |
名称 | 字符串 | 乌尔曼 | 是 | 客户端 ID 的名称。 |
client_id | 字符串 | R |
| 客户端 id。这种结构是在创建时自动生成的。 |
client_secret | 字符串 | R |
| 客户端标识客户端的秘密。这种结构是在创建时自动生成的。 |
uri | 字符串 | 乌尔曼 | 是 | 客户端 ID 重定向的统一资源标识符 (URI)。这种结构是必需的只有当您创建一个客户端 id。当你阅读时的客户端 ID,这种结构将出现在uri (uri 阵列)结构。 |
uri | 阵列 | R |
| 一个数组,包含重定向的 URI 信息。这种结构是在创建时自动生成的。 |
uri (uri 阵列) | 字符串 | R |
| 重定向的 URI。这种结构是在创建时自动生成的。 |
类型 (uri 阵列) | 字符串 | R |
| 重定向 URI 类型。唯一有效的值是"web"。这种结构是在创建时自动生成的。 |
terms_of_service_link | 字符串 | 乌尔曼 |
| 该 URL 的客户端 ID 的网页服务的条款。 |
privacy_link | 字符串 | 乌尔曼 |
| 该 URL 的客户端 ID 隐私的网页。 |
created_time | 字符串 | R |
| 在 ISO 8601 格式中,创建的客户端 ID 的时间。这种结构是在创建时自动生成的。 |
updated_time | 字符串 | R |
| 上次更新的客户端 ID 的 ISO 8601 格式的时间。这种结构是在创建时自动生成的。 |
以下是集合的示例应用程序对象。(为简洁起见,只有第一个对象是显示。
{
"data": [
{
"id": "application.000000004c043705",
"name": "Pilot Live Connect App",
"client_id": "000000004c043705",
"client_secret": "O9L3tC4ecrCdLDaNsNC3m4mdiBm9gYi4",
"uris": [
{
"uri": "http://www.contoso.com",
"type": "web"
}
],
"terms_of_service_link": "http://www.contoso.com/terms_of_service.php",
"privacy_link": "http://www.contoso.com/privacy.php",
"created_time": "2011-04-18T19:03:59+0000",
"updated_time": "2011-04-25T18:24:26+0000"
}, {
...
}
]
}
要通过使用实时连接其它 API 获取应用程序对象,可获取请求向/我/应用程序。
使用实时连接其它 API 创建一个应用程序对象,进行POST请求/我/应用程序。在请求的正文中,包括应用程序对象的属性,如下所示。
Content-Type: application/json
{
name: "Pilot Live Connect App",
uri: "http://www.contoso.com",
terms_of_service_link: "http://www.contoso.com/terms_of_service.php",
privacy_link: "http://www.contoso.com/privacy.php"
}
请注意
如果调用成功,住连接其它 API 返回以下的 JSON 格式的对象。
{
"id": "application.000000004c043705",
"name": "Pilot Live Connect App",
"client_id": "000000004c043705",
"client_secret": "O9L3tC4ecrCdLDaNsNC3m4mdiBm9gYi4",
"uris": [
{
"uri": "http://www.contoso.com",
"type": "web"
}
],
"terms_of_service_link": "http://www.contoso.com/terms_of_service.php",
"privacy_link": "http://www.contoso.com/privacy.php",
"created_time": "2011-04-18T19:03:59+0000",
"updated_time": "2011-04-25T18:24:26+0000"
}
要获取应用程序的标识,可获得请求向APPLICATION_ID/picture,其中 APPLICATION_ID 是id结构,例如, application.000000004c043705/picture的值。重定向响应的位置标头中返回链接到应用程序的徽标的位置。如果将suppress_redirects查询字符串参数设置为true,在application.000000004c043705/picture?suppress_redirects=true,作为 JSON 对象返回响应的正文中。此对象具有一个单一位置结构,其值是一个链接,指向应用程序的徽标的位置。
音频对象
音频对象包含关于 SkyDrive 中用户的音频信息。住连接其它 API 支持创建、 读取、 更新和删除音频对象。使用wl.skydrive范围读取音频对象。使用wl.contacts_skydrive范围读取任何其他用户已与用户共享的音频。使用wl.skydrive_update范围创建、 更新或删除音频对象。
音频对象包含以下结构。
结构 | 类型 | R/W | 所需的创建 | 说明 |
数据 | 阵列 | R |
| 音频对象,如果对象的集合,则返回的数组。 |
id | 字符串 | R |
| 音频对象的 id。 |
从 | 对象 | R |
| 用户上传音频的有关信息。 |
(从对象) 的名称 | 字符串 | R |
| 上传音频的用户的名称。 |
id (从对象) | 字符串 | R |
| 上传音频的用户 ID。 |
链接 | 字符串 | R |
| SkyDrive 上查看该项目的 URL。 |
名称 | 字符串 | 乌尔曼 | 是 | 音频的名称。 |
说明 | 字符串/空 | 乌尔曼 |
| 音频、 或null如果没有描述指定的说明。 |
parent_id | 字符串 | R |
| 将当前存储音频的文件夹的 id。 |
大小 | 编号 | R |
| 大小以字节为单位) 的音频。 |
upload_location | 字符串 | R |
| 上传新的音频覆盖现有音频使用的 URL。 |
comments_count | 编号 | R |
| 音频与关联的注释的数目。 |
comments_enabled | 真/假 | R |
| 一个值,指示是否启用音频的评论。如果可以提出意见,此值为true;否则,它是假. |
is_embeddable | 真/假 | R |
| 一个值,指示是否可以嵌入此音频。如果此音频可以嵌入,此值为true;否则,它是假. |
源 | 字符串 | R |
| 要使用,从 SkyDrive 下载音频的 URL。 警告 此值不是持久的。使用后立即发出请求,并且避免缓存。 |
类型 | 字符串 | R |
| 类型的对象 ;在本例中,"音频"。 |
shared_with | 对象 | R |
| 包含的对象的权限信息。 |
访问 (shared_with 对象) | 字符串 | R |
| 谁可以访问音频的信息。选项有: · 我选的人 · 就我自己 · 所有人 (公开) · 朋友 · 我的朋友们和他们的朋友 · 有一个链接的人 默认情况下只是我. |
created_time | 字符串 | R |
| ISO 8601 格式,创建音频的时间。 |
updated_time | 字符串 | R |
| ISO 8601 格式,音频上次更新的时间。 |
以下是集合的示例音频对象。(为简洁起见,只有第一个对象是显示。
{
"data": [
{
"id": "file.a6b2a7e8f2515e5e.A6B2A7E8F2515E5E!144",
"from": {
"name": "Stig Struve-Christensen",
"id": "a6b2a7e8f2515e5e"
},
"name": "SampleAudio.mp3",
"description": null,
"parent_id": "folder.a6b2a7e8f2515e5e",
"size": 8414449,
"upload_location": "https://apis.live.net/v5.0/file.a6b2a7e8f2515e5e.A6B2A7E8F2515E5E!144/content/",
"comments_count": 0,
"comments_enabled": false,
"is_embeddable": true,
"source": "http://storage.live.com/s1p60U8Xs4UzIXTScrTioalE-ZaVFiDQBA15MS2BwcsuNjfG64Z2fw-DAjXnPuqC47YR40_xAoPD8aRGhtna9ZFZ9_oO4BTz4CWF973DTXMxc5U3TntcQ9qEA/SampleAudio.mp3:Binary",
"link": "https://skydrive-df.live.com/redir.aspx?cid\u003d22688711f5410e6c\u0026page\u003dview\u0026resid\u003d22688711F5410E6C!582\u0026parid\u003d22688711F5410E6C!581",
"type": "audio",
"shared_with": {
"access": "Just me"
},
"created_time": "2012-09-23T22:00:57+0000",
"updated_time": "2012-09-03T22:00:57+0000"
}, {
...
}
]
}
若要创建新的音频资源,您可以使到POST请求 /FOLDER_ID或使一个POST请求 /UPLOAD_LOCATION目标文件夹的文件夹。您必须为多部分/格式数据RFC 2388中所述格式请求。您必须指定内容类型为多部分/格式数据,并指定此类边界。
Content-Type: multipart/form-data; boundary=AaB03x
提供要上载多部分的一段,和音频的名称作为内容处置标头,文件名参数的值的项,如下所示。
Content-Type: multipart/form-data; boundary=AaB03x
--AaB03x
Content-Disposition: file; filename="SampleAudio.wav"
Content-Type: audio/mp3
...contents of SampleAudio.wav...
--AaB03x--
请注意
边值 (所示为"AaB03x") 可以是任意字符串的任何值。
只有一个由多部分组成的部分,每个请求的支持。对于提出的请求,将内容类型保留空白,将文件的内容放在请求正文中。
成功创建时,位置标头点到的位置,新创建的音频和响应正文包含下列属性。
{
"id": "ID of the new audio",
"source": "URL where the audio can be downloaded from"
}
任何以下的方法,可以将音频上载到现有资源中。
- 请把请求/UPLOAD_LOCATION/filename 文件夹你想要上传。
- 把要求 /FOLDER_ID/files。
- 把要求 /ALBUM_ID/files。
- 把要求 /UPLOAD_LOCATION文件来更新。
- 把要求 /AUDIO_ID/content。
若要更新音频资源的属性,使提出的请求 /AUDIO_ID,并在请求的正文中,指定所做的更改,如下所示。
{
"name": "SampleAudioChanged.wav"
"description": "Holiday Concert"
}
要删除一个音频,请删除请求 /AUDIO_ID.
要移动一个音频,请移动的请求 /AUDIO_IF或 /FOLDER_ID,并在请求的正文中,指定目标文件夹的 ID,如下所示。
{
"destination": "FOLDER_ID"
}
要复制音频,请复制的请求 /AUDIO_ID或 /FOLDER_ID,并在请求的正文中,指定目标文件夹的 ID,如下所示。
{
"destination": "FOLDER_ID"
}
为把和POST请求,可以以指示是否请求应是失败的资源已经存在,如下所示使用覆盖查询字符串参数。请注意移动和复制不支持这次改写。
overwrite=true
or
overwrite=false
如果覆盖查询字符串参数的值设置为true,并且音频存在,则将覆盖它。如果该值设置为false,音频不会被覆盖,并返回resource_already_exists错误。如果指定了没有覆盖的查询字符串参数,则默认值为true.
日历对象
日历对象包含有关用户的 Hotmail 日历信息。住连接其它 API 支持创建、 读取、 更新和删除日历。使用wl.calendars范围读取用户的日历对象。使用wl.calendars_update范围创建用户的日历对象。使用wl.contacts_calendars范围读取用户的朋友们的日历对象。
日历对象包含以下结构。
结构 | 类型 | R/W | 所需的创建 | 说明 |
id | 字符串 | R |
| 日历对象 id。 |
名称 | 字符串 | 乌尔曼 | 是 | 该日历的名称。 |
说明 | 字符串/空 | 乌尔曼 |
| 日历的说明。 |
created_time | 字符串 | R |
| ISO 8601 格式,创建日历的时间。 |
updated_time | 字符串 | R |
| ISO 8601 格式,日历上次更新时间。 |
从 | 对象 | R |
| 拥有该日历的用户的信息。 |
(从对象) 的名称 | 字符串 | R |
| 上载文件的用户的名称。 |
id (从对象) | 字符串 | R |
| 拥有该日历的用户的 ID。 |
is_default | 真/假 | R |
| 一个值,该值指示此日历是默认日历。如果此日历的默认日历,此值为true;否则,它是假. |
subscription_location | 字符串 | 乌尔曼 |
| 公共订阅 URL 的活连接将同步属性和事件定期此日历。NULL值表示这不是一个已订阅的日历。 |
权限 | 字符串 | R |
| 角色和日历向用户授予的权限。可能的值包括: · free_busy: 用户可以看到只忙/闲信息。 · limited_details: 用户可以看到所有的详细信息的一个子集。 · 阅读: 用户只能读取日历事件的内容。 · read_write: 用户可以读取和写入的日历和事件。 · co_owner: 用户是此日历的共有人。 · 所有者: 用户是此日历的所有者。 |
以下是集合的示例日历对象。(为简洁起见,只有第一个对象是显示。
{
"data": [
{
"id": "calendar.42d4dbc866f94c83849c88c6eb9985bc",
"name": "Birthday calendar",
"description": "If you have birthdays listed for your contacts, they'll appear on this calendar. You can add more birthdays, but you can't add other types of events.",
"created_time": "2011-08-05T19:41:04+0000",
"updated_time": "2011-08-05T19:41:04+0000",
"from": {
"name": null,
"id": null
},
"is_default": false,
"subscription_location": null,
"permissions": "read"
},{
...
}
]
}
要通过使用实时连接其它 API 获取日历对象的集合,可获取请求向任一/我/日历,或 /USER_ID/calendars。
为特定的日历对象获取属性,使日历的 id 的GET请求。
https://apis.live.net/v5.0/calendar.b4466224b2ca42798c3d4ea90c75aa56?access_token=ACCESS_TOKEN
创建新的日历,要么/我/日历,使POST请求或 /USER_ID/calendars。作为属性请求正文中传递的名称(必填) 和摘要(可选) 的字符串。在响应正文中,返回的属性为新的日历和位置标头包含 URI 为新创建的日历。
{
"name": "Summer Events",
"summary": "Things we are doing this summer."
}
警告
请求正文不能包含subscription_location属性。
要订阅公共日历,使POST请求到任一/我/日历或 /USER_ID/calendars。通过为请求正文中的属性的名称和subscription_location的字符串。Subscription_location的值必须是一个有效的在线 iCal 日历。这两个属性是必需的。
{
"name": "Soccer League"
"subscription_location": "ical.sharedcalendars.com/98754auv"
}
若要更新日历,使提出的请求 /CALENDAR_ID。包括要在请求的正文中,更新的属性,如下所示。
{
"name": "Fall Happenings"
}
要删除日历,请删除请求 /CALENDAR_ID.
在前面的示例中,CALENDAR_ID 替换目标日历 id。
注释对象
注释对象包含有关与一张照片,音频或视频 SkyDrive 上相关联的注释的信息。阅读评论对象的活连接其它 API 支持。使用wl.photos范围读取注释的对象。使用wl.contacts_photos范围读取与任何的专辑、 照片和视频的其他用户共享与用户相关联的注释对象。
注释对象包含以下结构。
结构 | 类型 | R/W | 所需的创建 | 说明 |
数据 | 阵列 | R |
| 注释的对象,如果对象的集合,则返回的数组。 |
id | 字符串 | R |
| 注释对象的 id。 |
从 | 对象 | R |
| 有关创建注释的用户的信息。 |
(从对象) 的名称 | 字符串 | R |
| 创建注释的用户的名称。 |
id (从对象) | 字符串 | R |
| 创建注释的用户的 ID。 |
消息 | 字符串 | 乌尔曼 | 是 | 注释的文本。注释的最大长度是 10000 个字符。 |
created_time | 字符串 | R |
| ISO 8601 格式,创建注释的时间。 |
以下是集合的示例注释对象。(为简洁起见,只有第一个对象是显示。
{
"data": [
{
"id": "comment.22688711f5410e6c.22688711f0410e6c!818.22688711F5410E6C!979",
"from": {
"name": "Roberto Tamburello",
"id": "8c8ce076ca27823f"
},
"message": "A lighthouse built on some rocks.",
"created_time": "2011-04-21T23:21:28+0000"
}, {
...
}
]
}
要获取评论对象的集合,使用实时连接其它 API,使获得的请求 /RESOURCE_ID/comments。
联系人对象
联系人对象包含有关用户的 Hotmail 联系人信息。阅读联系人对象的活连接其它 API 支持。
联系人对象包含以下结构。
结构 | 所需的范围 | 类型 | R/W | 所需的创建 | 说明 |
id | wl.basic | 字符串 | R |
| 联系人对象的 id。 |
名字 | wl.basic | 字符串/空 | 乌尔曼 | 可选 | 联系人的名字,或null如果没有首先指定名称。 |
last_name | wl.basic | 字符串/空 | 乌尔曼 | 可选 | 联系人的姓氏,或null如果没有最后指定名称。 |
名称 | wl.basic | 字符串 | R |
| 联系人的完整名称,格式化的位置。 |
性别 | wl.basic | 字符串/空 | 乌尔曼 |
| 联系人的性别。有效值为"男"、"女",或为空,如果未指定联系人的性别。 |
is_friend | wl.basic | 真/假 | R |
| 一个值,指示是否设置联系人作为朋友。如果该联系人的朋友,此值为true;否则,它是假. |
is_favorite | wl.basic | 真/假 | 乌尔曼 |
| 一个值,表示是否设置为最喜欢联系人的联系人。如果该联系人的最爱,此值为true;否则,它是假. |
user_id | wl.basic | 字符串/空 | R |
| 联系人的 ID,如果联系人具有之一。如果没有,此值为空. |
email_hashes | wl.basic | 阵列 | R |
| 该数组包含长沙 256 哈希值为每个联系人的电子邮件地址。更多的信息,请参阅查找器的朋友. |
birth_day | wl.basic和wl.contacts_birthday | 数量/空 | R |
| 联系人的出生日期,或null如果指定没有出生日期的一天。 |
birth_month | wl.basic和wl.contacts_birthday | 数量/空 | R |
| 联系人的月出生日期,则为 null ,如果没有出生日期指定。 |
updated_time | wl.basic | 字符串 | R |
| ISO 8601 格式,用户最后更新数据的时间。 |
创建新的联系人对象时,必须提供至少下列属性之一。这些都在前面的结构表标记为可选。
- 名字
- last_name
- 首选 (用户对象,电子邮件结构)
- 个人 (用户对象,电子邮件结构)
- 业务 (用户对象,电子邮件结构)
- 其他 (用户对象,电子邮件结构)
- 名称 (用户对象,阵列的工作,雇主结构)
首选、个人、企业、其他,和名称结构属于用户对象,并要求限制的作用域 (wl.emails和wl.work_profile)。因此,获取联系人对象实例时,不返回这些属性。但是,也可以创建新的联系人对象时添加这些属性。虽然不能直接返回的值,此行为是方便的情况下,当您添加新的联系人的电子邮件地址,或如果您要创建一个联系人,是一家公司。若要确保将公司名称或电子邮件地址显示联系人的名称的位置,请省略名字和 last_name 字段。您指定的电子邮件地址或公司名称将出现在返回的联系人对象实例的名称的位置。
使用以下 JSON 作为指南,用于在您的请求中定义的属性。
{
"first_name": "",
"last_name": "",
"emails": {
"preferred": "",
"personal": "",
"business": "",
"other": ""
},
"work": [
{
"employer": {
"name": ""
}
}
]
}
以下是集合的示例联系人对象。(为简洁起见,只有第一个对象是显示。
{
"data": [
{
"id": "contact.b4466224b2ca42798c3d4ea90c75aa56",
"first_name": "Henrik",
"last_name": "Jensen",
"name": "Henrik Jensen",
"gender": null,
"is_friend": false,
"is_favorite": false,
"user_id": null,
"email_hashes": [
"9ecdb19f4eb8e04304c5d1280368c42e85b6e4fe39f08b0c837ec592b905a620",
"fc05492f50da6488aa14dcf221d395bcb29a4e43b43b250d60c68df4f831cad3"
],
"birth_day": 29,
"birth_month": 3,
"updated_time": "2011-04-22T00:11:13+0000"
}, {
...
}
]
}
要通过使用实时连接其它 API 获取联系人对象的集合,可获取请求向/我/联系人。
请注意
如果联系人引用的用户,可以通过使联系人使用 user_id 值的GET请求返回用户对象.
若要重定向的是用户的联系人图片的 URL获取调用,调用 /USER_ID/picture。(用户对象的 ID 不是相同,联系人 id。)
错误对象
Error对象包含一个由住连接 Api 返回的错误的信息。
Error对象包含以下结构。
结构 | 类型 | 说明 |
错误 | 对象 | 有关错误的信息。 |
代码 (错误对象) | 字符串 | 错误代码。 |
消息 (错误对象) | 字符串 | 错误消息中。 |
下面是对象的错误的示例。
{
"error": {
"code": "request_token_expired",
"message": "The provided access token has expired."
}
}
事件对象
Hotmail 用户的日历上,事件对象包含有关事件的信息。住连接其它 API 支持创建事件对象。使用wl.events_create范围在用户的默认日历上创建事件对象。使用wl.calendars范围读取用户的日历上的事件对象。使用wl.calendars_update在任何用户的日历上创建事件对象。使用wl.contacts_calendars范围从用户的朋友的日历中读取的事件对象。
事件对象包含以下结构。
结构 | 类型 | R/W | 所需的创建 | 说明 |
id | 字符串 | R |
| 事件 ID。 |
名称 | 字符串 | 乌尔曼 | 是 | 这一事件,最大长度为 255 个字符的名称。这种结构是必需的。 |
created_time | 字符串 | R |
| ISO 8601 格式,创建事件的时间。 |
updated_time | 字符串 | R |
| ISO 8601 格式,更新该事件的时间。这种结构是仅在返回的事件对象中可见如果事件已成功创建。 |
说明 | 字符串 | 乌尔曼 |
| 事件,最大长度为 32,768 的字符的说明。这种结构是必需的。 |
calendar_id | 对象 | R |
| 日历包含事件的 ID。 |
从 | 对象 | R |
| 包含的名称和组织者的 ID 的对象。 |
(从对象) 的名称 | 字符串 | R |
| 组织者的名称。 |
id (从对象) | 字符串 | R |
| 组织者的 ID。 |
start_time | 字符串 | 乌尔曼 | 是 | 在 ISO 8601 格式中,事件的开始时间。当读取事件时,时间会在用户的本地时间,在 ISO 8601 格式。 |
end_time | 字符串 | 乌尔曼 |
| 在 ISO 8601 格式中,事件的结束时间。如果指定了没有结束时间,则默认值是 30 分钟后 start_time。创建事件时,此结构是可选的。当读取事件时,时间会在用户的本地时间,在 ISO 8601 格式。 |
位置 | 字符串 | 乌尔曼 |
| 在该事件将举行的位置的名称。最大长度为 1000 个字符。 |
is_all_day_event | 真/假 | 乌尔曼 |
| 一个值,指定事件是否全天事件。如果事件为全天事件,此值为true;否则,它是虚假的。如果缺少此结构,则默认值为false. |
is_recurrent | 真/假 | R |
| 一个值,指定是否重复事件。如果事件反复出现,此值为true;否则,它是假. |
复发 | 字符串 | R |
| 重复执行模式,例如,"每周周二发生"的文字说明。如果这不是一个经常性的事件,值为Null 。 |
reminder_time | 编号 | 乌尔曼 |
| 时间以分钟为单位,提醒报警事件之前。 |
可用性 | 字符串 | 乌尔曼 |
| 用户的可用性状态的事件。有效值包括: · "免费" · "忙" · "暂定" · ""out_of_office 默认值是免费. |
可见性 | 字符串 | 乌尔曼 |
| 一个值,指定事件是否公开可见。有效值包括: · "公共"— — 的事件是可见的任何人都可以查看日历的人。 · "私人"— — 事件的事件所有者只可见。 默认值是公共. |
以下是事件对象的示例。
{
"id": "event.611afb17fa9448f28cdb8277e8ffeb77.e9f015000d0249ce847c5306a25d7d75",
"name": "Global Project Risk Management Meeting",
"description": "Generate and assess risks for the project",
"calendar_id": "calendar.611afb17fa9448f28cdb8277e8ffeb77",
"from": {
"name": "William Flash",
"id": "de57f4126ed7e411"
},
"start_time": "2011-04-20T01:00:00+0000",
"end_time": "2011-04-20T02:00:00+0000",
"location": "Building 81, Room 9981, 123 Anywhere St., Redmond WA 19599",
"is_all_day_event": false,
"availability": "busy",
"visibility": "public",
"created_time": "2011-03-14T23:01:31+0000",
"updated_time": "2011-04-19T20:23:03+0000"
}
要通过使用实时连接其它 API 日历返回的事件的列表,请获取的请求 /CALENDAR_ID/events。默认情况下,这将返回由现在至未来 30 天内的所有事件。
要返回的事件的用户的列表,可获取请求向任一/我/事件,或 /USER_ID/events。
要检索属性的事件,使到GET请求 /EVENT_ID.
使用实时连接其它 API 用户的默认日历上创建事件对象,进行POST请求/我/事件。在请求的正文中,通过该事件的属性,如下所示。
Content-Type: application/json
{
name: "Global Project Risk Management Meeting",
description: "Generate and assess risks for the project",
start_time: "2011-04-20T01:00:00-07:00",
end_time: "2011-04-20T02:00:00-07:00",
location: "Building 81, Room 9981, 123 Anywhere St., Redmond WA 19599",
is_all_day_event: false,
availability: "busy",
visibility: "public"
}
请注意
如果调用成功,住连接其它 API 返回以下的 JSON 格式的对象。
{
"name": "Global Project Risk Management Meeting",
"description": "Generate and assess risks for the project",
"start_time": "2011-04-20T01:00:00+0000",
"end_time": "2011-04-20T02:00:00+0000",
"location": "Building 81, Room 9981, 123 Anywhere St., Redmond WA 19599",
"is_all_day_event": false,
"availability": "busy",
"visibility": "public",
"updated_time": "2011-04-19T20:23:03+0000"
}
要删除某一事件,请删除请求 /EVENT_ID.
提示
住连接其它 API 不支持创建或更新反复发生的事件 ;但是,您可以删除定期事件相同的方式,将会删除一个非经常性的事件。删除一个定期事件删除所有其出现的次数。
文件对象
文件对象包含有关 SkyDrive 中用户的文件的信息。住连接其它 API 支持创建、 读取、 更新和删除文件对象。使用wl.skydrive范围读取文件对象。使用wl.contacts_skydrive范围读取任何其他用户已与用户共享的文件。使用wl.skydrive_update范围创建、 更新或删除文件的对象。
文件对象包含以下结构。
结构 | 类型 | R/W | 所需的创建 | 说明 |
数据 | 阵列 | R |
| 文件对象,如果对象的集合,则返回的数组。 |
id | 字符串 | R |
| 文件对象的 id。 |
从 | 对象 | R |
| 上载文件的用户的信息。 |
(从对象) 的名称 | 字符串 | R |
| 上载文件的用户的名称。 |
id (从对象) | 字符串 | R |
| 上载文件的用户的 ID。 |
链接 | 字符串 | R |
| SkyDrive 上查看该项目的 URL。 |
名称 | 字符串 | 乌尔曼 | 是 | 文件的名称。 |
parent_id | 字符串 | R |
| 该文件目前存储在该文件夹的 id。 |
说明 | 字符串/空 | 乌尔曼 |
| 文件,或null如果没有描述指定的说明。 |
大小 | 编号 | R |
| 以字节为单位,文件的大小。 |
comments_count | 编号 | R |
| 与文件相关联的注释的数目。 |
comments_enabled | 真/假 | R |
| 一个值,指示是否启用注释的文件。如果可以提出意见,此值为true;否则,它是假. |
is_embeddable | 真/假 | R |
| 一个值,指示是否可以嵌入此文件。如果此文件可以嵌入,此值为true;否则,它是假. |
源 | 字符串 | R |
| 要使用从 SkyDrive 下载文件的 URL。 警告 此值不是持久的。使用后立即发出请求,并且避免缓存。 |
upload_location | 字符串 | R |
| 上传文件内容在 SkyDrive 中承载的 URL。 |
类型 | 字符串 | R |
| 类型的对象 ;在此情况下,"的文件"。 |
created_time | 字符串 | R |
| ISO 8601 格式,创建文件的时间。 |
updated_time | 字符串 | R |
| ISO 8601 格式,文件的上次更新时间。 |
shared_with | 对象 | R |
| 对象,包含的权限信息。 |
访问 (shared_with 对象) | 字符串 | R |
| 谁可以访问该文件夹的信息。选项有: · 我选的人 · 就我自己 · 所有人 (公开) · 朋友 · 我的朋友们和他们的朋友 · 有一个链接的人 默认情况下只是我. |
下面是一个文件对象的示例。
{
"data": [
{
"id": "file.22688711f5410e6c.22688711F5410E6C!942",
"from": {
"name": "William Flash",
"id": "22688711f5410e6c"
},
"name": "Processing.docx",
"description": null,
"parent_id": "folder.22688711f5410e6c.22688711F5410E6C!479",
"size": 12692,
"upload_location": "https://apis.live.net/v5.0/file.22688711f5410e6c.22688711F5410E6C!942/content/",
"comments_count": 0,
"comments_enabled": true,
"is_embeddable": false,
"source": "http://storage.live.com/s1pEwo9qzyT4_BJZqMNm-aVzgLo-WRsQGzjzFsXjyREuQG5pDYr237vKz3i2pmqFuniYPzsuIZAOCUMB_gdfKCUpLpVcaAMXGrk4T7jOWenRniCv9vex7GWfSvy-XCVBVnU/Processing.docx:Binary",
"link": "https://skydrive-df.live.com/redir.aspx?cid\u003d22688711f5410e6c\u0026page\u003dview\u0026resid\u003d22688711F5410E6C!942\u0026parid\u003d22688711F5410E6C!479",
"type": "file",
"shared_with": {
"access": "Everyone (public)"
},
"created_time": "2011-10-12T23:18:23+0000",
"updated_time": "2011-10-12T23:18:23+0000"
},{
...
}
]
}
若要获取文件资源的属性,使到GET请求 /FILE_ID (目标文件 ID)。
要下载的文件资源的内容,请获取的请求 /FILE_ID/content。文件内容返回响应正文中。
要返回的文件资源的下载链接,使到GET请求 /FILE_ID/content 与suppress_redirects = true参数。URL 返回以下格式的响应正文。
{
"location": "..."
}
提示如果客户端已要求文件的属性,在源字段将下载链接。
若要创建新的文件资源,您可以使到POST请求 /FOLDER_ID/files,一个POST请求 /UPLOAD_LOCATION目标文件夹的文件夹,或把请求 /FOLDER_ID/files/ < 文件名称 >。对于POST请求,必须设置请求的格式作为多部分/格式数据RFC 2388中所述。您必须指定内容类型为多部分/格式数据,并指定此类边界。
Content-Type: multipart/form-data; boundary=AaB03x
提供要上载的文件的名称和由多部分组成的部分,作为内容处置标头,文件名参数的值的项,如下所示。
--AaB03x
Content-Disposition: file; filename="file1.txt"
Content-Type: text/plain
...contents of file1.txt...
--AaB03x--
请注意
边值 (所示为"AaB03x") 可以是任意字符串的任何值。
我们支持只有一个由多部分组成的部分,每个请求。对于提出的请求,将内容类型保留空白,将文件的内容放在请求正文中。
成功创建时,响应正文和新创建的文件的位置,位置标头点包含下列属性。
{
"id": "ID of the new file",
"source": "URL where the file can be downloaded from"
}
任何以下的方法,可以上载文件到现有的资源。
- 请把UPLOAD_LOCATION的父文件夹的 id。
- 把要求 /FOLDER_ID/文件/文件名。
- 把要求 /UPLOAD_LOCATION文件来更新。
- 把要求 /FILE_ID/content。
若要更新文件资源的属性,使提出的请求 /FILE_ID,并在请求的正文中,指定所做的更改,如下所示。在此示例中,更新文件的名称和说明。请注意文件扩展名是需要更新的文件名称时。
{
"name": "UFO_Sightings_1979.docx"
"description": "The detailed accounts of all UFO sightings in 1979."
}
要删除一个文件,请删除请求 /FILE_ID.
若要移动的文件,使移动的请求 /FILE_ID或 /FOLDER_ID,并在请求的正文中,指定目标文件夹的 ID,如下所示。
{
"destination": "FOLDER_ID"
}
要复制的文件,使副本的请求 /FILE_ID或 /FOLDER_ID,并在请求的正文中,指定目标文件夹的 ID,如下所示。
{
"destination": "FOLDER_ID"
}
为把和POST请求,可以以指示是否请求应是失败的资源已经存在,如下所示使用覆盖查询字符串参数。
overwrite=true
or
overwrite=false
如果覆盖查询字符串参数的值设置为true,并且该文件存在,则将覆盖它。如果该值设置为false,不覆盖该文件并返回resource_already_exists错误。如果指定了没有覆盖的查询字符串参数,则默认值为true.
文件夹对象
文件夹对象包含有关 SkyDrive 中用户的文件夹的信息。文件夹可以包含组合的照片、 视频、 音频和子文件夹。阅读文件夹对象的活连接其它 API 支持。使用wl.photos范围读取文件夹对象。使用wl.contacts_photos范围读取任何专辑、 照片、 视频和音频,用户与其他用户共享。
文件夹对象包含以下结构。
结构 | 类型 | R/W | 所需的创建 | 说明 |
数据 | 阵列 | R |
| 文件夹对象,如果对象的集合,则返回的数组容器。 |
id | 字符串 | R |
| 文件夹对象的 id。 |
从 | 对象 | R |
| 有关创建文件夹的用户的信息。 |
(从对象) 的名称 | 字符串 | R |
| 创建该文件夹的用户的名称。 |
id (从对象) | 字符串 | R |
| 创建该文件夹的用户的 ID。 |
名称 | 字符串 | 乌尔曼 | 是 | 文件夹的名称。 |
说明 | 字符串/空 | 乌尔曼 |
| 文件夹或null如果没有描述指定的说明。 |
计数 | 编号 | R |
| 文件夹中的项目总数。 |
链接 | 字符串 | R |
| 在 SkyDrive 中承载的文件夹的 URL。 |
upload_location | 字符串 | R |
| 上载项目在 SkyDrive 中承载的文件夹的 URL。需要wl.skydrive范围。 |
parent_id | 字符串 | R |
| 父母的资源 ID。 |
类型 | 字符串 | R |
| 类型的对象 ;在这个案例,"文件夹"。 |
created_time | 字符串 | R |
| ISO 8601 格式,创建该文件夹的时间。 |
updated_time | 字符串 | R |
| ISO 8601 格式,最后更新文件夹中的内容是时间。 |
shared_with | 对象 | R |
| 文件夹的权限信息。需要wl.skydrive范围。 |
访问 (shared_with 对象) | 字符串 | R |
| 谁可以访问该文件夹的信息。选项有: · 我选的人 · 就我自己 · 所有人 (公开) · 朋友 · 我的朋友们和他们的朋友 · 有一个链接的人 默认情况下只是我. |
以下是集合的一个示例的文件夹对象。(为简洁起见,只有第一个对象是显示。
{
"data": [
{
"id": "folder.8c8ce076ca27823f.8C8CE076CA27823F!142",
"from": {
"name": "Roberto Tamburello",
"id": "8c8ce076ca27823f"
},
"name": "My Sample Folder in Album 1",
"description": "",
"parent_id": "folder.de57f4126ed7e411",
"upload_location": "https://apis.live.net/v5.0/folder.de57f4126ed7e411.DE57F4126ED7E411!126/files/",
"count": 3,
"link": "https://cid-8c8ce076ca27823f.skydrive.live.com/redir.aspx?page\u003dself\u0026resid\u003d8C8CE076CA27823F!142\u0026parid\u003d8C8CE076CA27823F!126\u0026type\u003d5",
"type": "folder",
"created_time": "2011-04-22T00:36:30+0000",
"updated_time": "2011-04-22T19:18:12+0000"
}, {
...
}
]
}
要通过使用实时连接其它 API 获取根文件夹资源,可获取请求向任一/我/skydrive 或 /USER_ID/skydrive。
要获得某个子文件夹中的资源,使到GET请求 /FOLDER_ID.
若要枚举文件夹中的内容,使到GET请求 /FOLDER_ID/files。
文件夹可能包含下列对象。
若要创建新的文件夹资源,使到POST请求 /FOLDER_ID。在请求的正文中,传递的名称和说明的属性,如下所示。
{
"name": "Informative Spreadsheets",
"description": "A folder full of useful data visualizations."
}
作为一个孩子在请求的 URL 中指定的文件夹的情况下创建该文件夹。新创建的文件夹的位置,并响应正文位置标头指向包含新创建的文件夹的属性。
若要更新文件夹的属性,使提出的请求 /FOLDER_ID。通过在请求的正文中,更新的属性,如下所示。
{
"name": "Very Informative Spreadsheets",
"description": "A folder full of even more useful data visualizations."
}
要删除文件夹,请删除请求 /FOLDER_ID.
在前面的示例中, FOLDER_ID替换目标文件夹 id。
朋友对象
朋友对象包含有关用户的朋友的信息。朋友对象代表用户的联系人的is_friend值设置为true。阅读朋友对象的活连接其它 API 支持。
朋友对象包含以下结构。
结构 | 所需的范围 | 类型 | 说明 |
数据 | 阵列 | 朋友对象时,对象的集合,则返回的数组容器。 | |
id | wl.basic | 字符串 | 朋友的 id。 |
名称 | wl.basic | 字符串 | 朋友的完整名称,格式化的区域设置。 |
以下是集合的示例的朋友对象。(为简洁起见,只有第一个对象是显示。
{
"data": [
{
"id": "d09ea18fafc39a0c",
"name": "Henrik Jensen"
}, {
...
}
]
}
要获得朋友的对象的集合,使用实时连接其它 API,交不到朋友/我 / GET请求。
权限对象
权限对象包含的作用域,显示的用户已同意这些作用域的列表。响应正文包含一个列出所有表示同意的作用域为名称/值对的 JSON 对象。每个用户的同意的范围是目前作为键。
下面是一个权限对象的一个示例。(为简洁起见,不是所有的作用域是显示。
{
"wl.basic": 1,
"wl.offline_access": 1,
"wl.signin": 1,
...
}
要通过使用实时连接其它 API 获取权限对象,/我/权限进行GET请求。
照片对象
照片对象包含关于 SkyDrive 上用户的照片的信息。住连接其它 API 支持创建、 读取、 更新和删除照片的对象。使用wl.photos范围读取图片对象。使用wl.contacts_photos范围读取任何专辑、 照片、 视频和音频的其他用户已与用户共享。使用wl.skydrive_update范围创建、 更新或删除照片的对象。
请注意
照片上传到 SkyDrive 通过 API 仅限于最大分辨率 2048 x 2048 像素。任何对该决议的照片是按比例缩放以适合最大大小为 2048 x 2048 像素。
照片对象包含以下结构。
结构 | 类型 | R/W | 所需的创建 | 说明 |
数据 | 阵列 | R |
| 图片对象,当对象的集合,则返回的数组。 |
id | 字符串 | R |
| 照片对象的 id。 |
从 | 对象 | R |
| 上传照片者有关的信息。 |
(从对象) 的名称 | 字符串 | R |
| 上传照片的用户的名称。从对象的一部分。 |
id (从对象) | 字符串 | R |
| 上传照片者 ID。从对象的一部分。 |
名称 | 字符串 | 乌尔曼 | 是 | 图片的文件名称。 |
parent_id | 字符串 | R |
| 存储该项目的文件夹的 ID。 |
说明 | 字符串/空 | 乌尔曼 |
| 照片,或null如果没有描述指定的说明。 |
大小 | 编号 | R |
| 大小,以字节为单位) 的照片。 |
comments_count | 编号 | R |
| 照片与关联的注释的数目。 |
comments_enabled | 真/假 | R |
| 一个值,指示是否启用评论照片。如果可以提出意见,此值为true;否则,它是假. |
tags_count | 编号 | R |
| 照片上的标记的数量。 |
tags_enabled | 真/假 | R |
| 一个值,指示是否启用标记照片。如果用户可以标记照片,此值为true;否则,它是假. |
图片 | 字符串 | R |
| 照片的图片的 URL。 |
源 | 字符串 | R |
| 照片的下载 URL。 警告 此值不是持久的。使用后立即发出请求,并且避免缓存。 |
图像 | 阵列 | R |
| 各种尺寸的照片的信息。 |
高度 (图像阵列) | 编号 | R |
| 高度以像素为单位,此图像的此特定大小。 |
宽度 (图像阵列) | 编号 | R |
| 宽度以像素为单位,此图像的此特定大小。 |
源 (图像阵列) | 字符串 | R |
| 此图像的此特定大小的源代码文件的 URL。 |
类型 (图像阵列) | 字符串 | R |
| 此图像的此特定大小的类型。有效值包括: · 全 (最大大小 2048 x 2048 像素) · 正常 (最大大小 800 x 800 像素) · 相册 (最大大小 200 x 200 像素) · 小 (最大大小 100 x 100 像素) |
链接 | 字符串 | R |
| 照片,在 SkyDrive 中承载的 URL。 |
upload_location | 字符串 | R |
| 上传照片内容在 SkyDrive 中承载的 URL。只返回此值wl.skydrive范围是否存在。 |
when_taken | 字符串/空 | R |
| 在 ISO 8601 格式,其拍摄照片,或null如果没有日期指定日期。 |
高度 | 编号 | R |
| 高度以像素为单位,照片。 |
宽度 | 编号 | R |
| 宽度以像素为单位,照片。 |
类型 | 字符串 | R |
| 类型的对象 ;在此情况下,"照片。" |
created_time | 字符串 | R |
| ISO 8601 格式,创建照片的时间。 |
updated_time | 字符串 | R |
| ISO 8601 格式,照片上次更新的时间。 |
shared_with | 对象 | R |
| 包含的对象的权限信息的照片。 |
访问 (shared_with 对象) | 字符串 | R |
| 谁可以访问照片的信息。选项有: · 我选的人 · 就我自己 · 所有人 (公开) · 朋友 · 我的朋友们和他们的朋友 · 有一个链接的人 默认情况下只是我. |
以下是集合的示例图片对象。(为简洁起见,只有第一个对象是显示。
{
"data": [
{
"id": "file.de57f4126ed7e411.DE57F4126ED7E411!128",
"from": {
"name": "Nuno Bento",
"id": "de57f4126ed7e411"
},
"name": "Maui-2012_0034.JPG",
"description": null,
"parent_id": "folder.de57f4126ed7e411.DE57F4126ED7E411!126",
"size": 561683,
"comments_count": 1,
"comments_enabled": true,
"tags_count": 0,
"tags_enabled": true,
"picture": "http://storage.live.com/s1pKk5vzd-gdPanbzKYhB0nQGn8wGq5DSgqvrgIHU1NTXA4e2-spGkAhQjW1d9pcgKAGLB4NsEsSvDoREmdx5w-JiFrinEJJuEoz08Ws_IFupkX2bPSvy5qmths9ijwvDrXi1OBCWk9GW9Kt-qNNOAA9g/Maui09_0034.JPG:Thumbnail",
"source": "http://storage.live.com/s1pKk5vzd-gdPanbzKYhB0nQGn8wGq5DSgqvrgIHU1NTXA4e2-spGkAhQjW1d9pcgKAGLB4NsEsSvDoREmdx5w-JiFrinEJJuEoz08Ws_IFupkX2bPSvy5qmths9ijwvDrXi1OBCWk9GW9Kt-qNNOAA9g/Maui09_0034.JPG:HighRes",
"upload_location": "https://apis.live.net/v5.0/file.de57f4126ed7e411.DE57F4126ED7E411!128/content/",
"images": [
{
"height": 450,
"width": 600,
"source": "http://storage.live.com/s1pKk5vzd-gdPanbzKYhB0nQGn8wGq5DSgqvrgIHU1NTXA4e2-spGkAhQjW1d9pcgKAGLB4NsEsSvDoREmdx5w-JiFrinEJJuEoz08Ws_IFupkX2bPSvy5qmths9ijwvDrXi1OBCWk9GW9Kt-qNNOAA9g/Maui09_0034.JPG:WebReady",
"type": "normal"
}, {
"height": 132,
"width": 176,
"source": "http://storage.live.com/s1pKk5vzd-gdPanbzKYhB0nQGn8wGq5DSgqvrgIHU1NTXA4e2-spGkAhQjW1d9pcgKAGLB4NsEsSvDoREmdx5w-JiFrinEJJuEoz08Ws_IFupkX2bPSvy5qmths9ijwvDrXi1OBCWk9GW9Kt-qNNOAA9g/Maui09_0034.JPG:MobileReady",
"type": "album"
}, {
"height": 72,
"width": 96,
"source": "http://storage.live.com/s1pKk5vzd-gdPanbzKYhB0nQGn8wGq5DSgqvrgIHU1NTXA4e2-spGkAhQjW1d9pcgKAGLB4NsEsSvDoREmdx5w-JiFrinEJJuEoz08Ws_IFupkX2bPSvy5qmths9ijwvDrXi1OBCWk9GW9Kt-qNNOAA9g/Maui09_0034.JPG:Thumbnail",
"type": "thumbnail"
}, {
"height": 1200,
"width": 1600,
"source": "http://storage.live.com/s1pKk5vzd-gdPanbzKYhB0nQGn8wGq5DSgqvrgIHU1NTXA4e2-spGkAhQjW1d9pcgKAGLB4NsEsSvDoREmdx5w-JiFrinEJJuEoz08Ws_IFupkX2bPSvy5qmths9ijwvDrXi1OBCWk9GW9Kt-qNNOAA9g/Maui09_0034.JPG:HighRes",
"type": "full"
}
],
"link": "https://skydrive.live.com/redir.aspx?cid\u003dde57f4126ed7e411\u0026page\u003dview\u0026resid\u003dDE57F4126ED7E411!128\u0026parid\u003dDE57F4126ED7E411!126",
"when_taken": null,
"height": 1200,
"width": 1600,
"type": "photo",
"shared_with": {
"access": "Everyone (public)"
},
"created_time": "2012-12-03T18:14:03+0000",
"updated_time": "2012-12-03T18:31:01+0000"
}, {
...
}
]
}
要获取照片对象的集合,使用实时连接其它 API,使到GET请求 /ALBUM_ID/files。
请注意您还可以通过调用其中任何一个图片对象的集合 /ALBUM_ID/photos,或 /FOLDER_ID/photos。
请注意要显示一张照片,请致电 /PHOTO_ID/picture。要显示特定图像大小的一张照片,请按照 /PHOTO_ID/picture 与吗? 类型 =及以下内容之一:缩略图、小、相册、正常或完整。默认值是正常的。以下是调用的一个示例,显示的缩略图图像。
https://apis.live.net/v5.0/PHOTO_ID/picture?type=thumbnail&access_token=ACCESS_TOKEN
在前面的示例中,ALBUM_ID 和 PHOTO_ID 替换目标相册,或照片 id。
若要创建一个新的图片资源,您可以使到POST请求 /FOLDER_ID或使一个POST请求 /UPLOAD_LOCATION目标文件夹的文件夹。您必须为多部分/格式数据RFC 2388中所述格式请求。您必须指定内容类型为多部分/格式数据,并指定此类边界。
Content-Type: multipart/form-data; boundary=AaB03x
提供对由多部分组成的部分及图片的名称上载的内容处置标头,文件名参数的值作为项目,如下所示。
Content-Type: multipart/form-data; boundary=AaB03x
--AaB03x
Content-Disposition: file; filename="hovering_orbs.jpg"
Content-Type: image/jpeg
...contents of hovering_orbs.jpg...
--AaB03x--
请注意
边值 (所示为"AaB03x") 可以是任意字符串的任何值。
只有一个由多部分组成的部分,每个请求的支持。对于提出的请求,将内容类型保留空白,将文件的内容放在请求正文中。
成功创建时,位置标头点到的位置的新创建的照片和响应正文包含下列属性。
{
"id": "ID of the new photo",
"source": "URL where the photo can be downloaded from"
}
任何以下的方法,可以将照片上载到现有资源中。
- 请把请求/UPLOAD_LOCATION/filename 文件夹你想要上传。
- 把要求 /FOLDER_ID/files。
- 把要求 /ALBUM_ID/files。
- 把要求 /UPLOAD_LOCATION文件来更新。
- 把要求 /PHOTO_ID/content。
若要更新照片资源的属性,使提出的请求 /PHOTO_ID,并在请求的正文中,指定所做的更改,如下所示。
{
"name": "fast-moving_orbs.jpg"
"description": "Fast moving objects."
}
要删除照片,请删除请求 /PHOTO_ID.
若要移动的照片,使移动的请求 /PHOTO_ID或 /FOLDER_ID,并在请求的正文中,指定目标文件夹的 ID,如下所示。
{
"destination": "FOLDER_ID"
}
要复制一张照片,请复制的请求 /PHOTO_ID或 /FOLDER_ID,并在请求的正文中,指定目标文件夹的 ID,如下所示。
{
"destination": "FOLDER_ID"
}
为把和POST请求,可以以指示是否请求应是失败的资源已经存在,如下所示使用覆盖查询字符串参数。请注意移动和复制不支持这次改写。
overwrite=true
or
overwrite=false
如果覆盖查询字符串参数的值设置为true,并且该文件存在,则将覆盖它。如果该值设置为false,不覆盖该文件,并返回resource_already_exists错误。如果指定了没有覆盖的查询字符串参数,则默认值为true.
标记对象
标记对象包含有关与一张照片或视频 SkyDrive 相关联的标记的信息。阅读标记对象的活连接其它 API 支持。使用wl.photos和wl.skydrive范围读取标记的对象。阅读与任何其他用户已与用户共享的照片相关联的标记对象使用的wl.contacts_photos和wl.contacts_skydrive的作用域。
标记对象包含以下结构。
结构 | 类型 | R/W | 所需的创建 | 说明 |
数据 | 阵列 | R |
| 返回数组的对象标记,如果对象的集合。 |
id | 字符串 | R |
| 标记对象的 id。 |
用户 | 对象 | 乌尔曼 |
| 带标记的人为的用户对象。 |
名称 (用户对象) | 字符串 | 乌尔曼 |
| 带标记的人的姓名。 |
id (用户对象) | 字符串 | 乌尔曼 |
| 如果他们有一个 ; 加标签的用户的用户 ID否则为空. |
x | 编号 | 乌尔曼 |
| 中心的标记的水平位置,从 0 到 100,浮点的百分比测量从左边缘的照片。对于视频对象不会返回此值。 |
y | 编号 | 乌尔曼 |
| 中心的标记的垂直位置,从 0 到 100,浮点的百分比测量从照片的上边缘。对于视频对象不会返回此值。 |
created_time | 字符串 | R |
| ISO 8601 格式,创建标记的时间。 |
以下是集合的示例标记对象。(为简洁起见,只有第一个对象是显示。
{
"id": "tag.22688711f5410e6c.22688711f5410e6c!767.PRaXZrdHI1uYGQYi9CU0StrzHak",
"user": {
"name": "Roberto Tamburello",
"id": "8c8ce076ca27823f"
},
"x": 43.8986,
"y": 54.4138,
"created_time": "2011-04-22T01:17:00+0000"
}
请注意
有关标记的用户的信息存储在用户属性。
X和y的成员从视频对象返回的标签上不存在。
要获取标记对象的集合,使用实时连接其它 API,使到GET请求 /RESOURCE_ID/tags。
用户对象
用户对象包含有关用户的信息。阅读用户对象的活连接其它 API 支持。
用户对象包含以下结构。
结构 | 所需的范围 | 类型 | 说明 |
id | 无 | 字符串 | 用户的 id。 |
名称 | 无 | 字符串 | 用户的全名。 |
名字 | 无 | 字符串/空 | 用户的名字。 |
last_name | 无 | 字符串/空 | 用户的姓氏。 |
链接 | 字符串 | 用户的配置文件页的 URL。 | |
birth_day | 数量/空 | 用户的出生日期,或null如果指定没有出生日期的一天。 | |
birth_month | wl.birthday | 数量/空 | 如果没有出生日期指定,用户的月生日期,则为 null 。 |
birth_year | wl.birthday | 数量/空 | 用户年出生日期,则为 null如果指定没有出生日期。 |
工作 | 阵列 | 一个数组,包含用户的工作信息。 | |
雇主 (工作阵列) | wl.work_profile | 对象 | 关于用户的雇主的信息。 |
名称 (雇主对象) | wl.work_profile | 字符串/空 | 用户的雇主,或null如果未指定,雇主名称的名称。 |
位置 (工作阵列) | wl.work_profile | 对象 | 关于用户的工作位置的信息。 |
姓名 (位置对象) | wl.work_profile | 字符串/空 | 用户的工作位置,或null如果未指定的工作位置的名称的名称。 |
性别 | 无 | 字符串/空 | 用户的性别。有效值为"男"、"女",或为空,如果未指定用户的性别。 |
电子邮件 | 对象 | 用户的电子邮件地址。 | |
首选 (电子邮件对象) | wl.emails | 字符串/空 | 如果不指定一个用户的首选电子邮件地址,则为 null 。 |
帐户 (电子邮件对象) | wl.emails | 字符串 | 与帐户关联的电子邮件地址。 |
个人 (电子邮件对象) | wl.emails | 字符串/空 | 未指定用户的个人电子邮件地址,或null如果一个。 |
业务 (电子邮件对象) | wl.emails | 字符串/空 | 未指定用户的业务电子邮件地址,或null如果一个。 |
其他 (电子邮件对象) | wl.emails | 字符串/空 | 未指定用户的"替补"电子邮件地址,或null如果一个。 |
地址 | 对象 | 用户的邮政地址。 | |
个人 (地址对象) | wl.postal_addresses | 对象 | 用户的个人的邮政地址。 |
街 (个人对象) | wl.postal_addresses | 字符串/空 | 未指定用户的个人的街道地址或null如果一个。 |
street_2 (个人对象) | wl.postal_addresses | 字符串/空 | 第二行的用户的个人的街道地址或null如果一个未指定。 |
城市 (个人对象) | wl.postal_addresses | 字符串/空 | 未指定的用户的个人地址或null如果一个城市。 |
状态 (个人对象) | wl.postal_addresses | 字符串/空 | 未指定的用户的个人地址或null如果一个状态。 |
postal_code (个人对象) | wl.postal_addresses | 字符串/空 | 未指定的用户的个人地址或null如果一个邮政编码。 |
区域 (个人对象) | wl.postal_addresses | 字符串/空 | 未指定的用户的个人地址或null如果一个区域。 |
业务 (地址对象) | wl.postal_addresses | 对象 | 用户的业务的邮政地址。 |
街 (业务对象) | wl.postal_addresses | 字符串/空 | 未指定用户的商业街道地址,或null如果一个。 |
street_2 (业务对象) | wl.postal_addresses | 字符串/空 | 未指定用户的商业街道地址,或null如果一个的第二行。 |
城市 (业务对象) | wl.postal_addresses | 字符串/空 | 未指定的用户的业务地址或null如果一个城市。 |
状态 (业务对象) | wl.postal_addresses | 字符串/空 | 未指定的用户的业务地址或null如果一个状态。 |
postal_code (业务对象) | wl.postal_addresses | 字符串/空 | 未指定的用户的业务地址或null如果一个邮政编码。 |
区域 (业务对象) | wl.postal_addresses | 字符串/空 | 未指定的用户的业务地址或null如果一个区域。 |
电话 | 对象 | 用户的电话号码。 | |
个人 (手机对象) | wl.phone_numbers | 字符串/空 | 未指定用户的个人电话号码,或null如果一个。 |
业务 (手机对象) | wl.phone_numbers | 字符串/空 | 未指定用户的电话号码或null如果一个。 |
移动 (手机对象) | wl.phone_numbers | 字符串/空 | 未指定用户的移动电话号码,或null如果一个。 |
区域设置 | 无 | 字符串 | 用户的区域设置代码。 |
updated_time | 字符串 | 用户上次更新对象的 ISO 8601 格式的时间。 |
以下是用户对象的示例。
{
"id": "8c8ce076ca27823f",
"name": "Roberto Tamburello",
"first_name": "Roberto",
"last_name": "Tamburello",
"link": "http://cid-8c8ce076ca27823f.profile.live.com/",
"birth_day": 20,
"birth_month": 4,
"birth_year": 2010,
"work": [
{
"employer": {
"name": "Microsoft Corporation"
},
"position": {
"name": "Software Development Engineer"
}
}
],
"gender": "male",
"emails": {
"preferred": "Roberto@contoso.com",
"account": "Roberto@contoso.com",
"personal": "Roberto@fabrikam.com",
"business": "Robert@adatum.com",
"other": "Roberto@adventure-works.com"
},
"addresses": {
"personal": {
"street": "123 Main St.",
"street_2": "Apt. A",
"city": "Redmond",
"state": "WA",
"postal_code": "12990",
"region": "United States"
},
"business": {
"street": "456 Anywhere St.",
"street_2": "Suite 1",
"city": "Redmond",
"state": "WA",
"postal_code": "12399",
"region": "United States"
}
},
"phones": {
"personal": "(555) 555-1212",
"business": "(555) 111-1212",
"mobile": null
},
"locale": "en_US",
"updated_time": "2011-04-21T23:55:34+0000"
}
要通过使用实时连接其它 API 获取用户对象,可获取请求向任一 / 我,或 /USER_ID.
请注意若要重定向的用户的图片的 URL获取调用,您可以调用/我/图片或 /USER_ID/picture。
视频对象
视频对象包含有关 SkyDrive 的视频用户的信息。住连接其它 API 支持创建、 读取、 更新和删除视频对象。使用wl.photos范围读取视频对象。使用wl.contacts_photos范围读取的专辑、 照片和视频的用户与其他用户共享。使用wl.skydrive_update范围创建、 更新或删除视频对象。
该视频对象包含以下结构。
结构 | 类型 | R/W | 所需的创建 | 说明 |
数据 | 阵列 | R |
| 视频对象,如果对象的集合,则返回的数组。 |
id | 字符串 | R |
| 视频对象的 id。 |
从 | 对象 | R |
| 用户的视频上传相关的信息。 |
(从对象) 的名称 | 字符串 | R |
| 视频上传的用户的名称。 |
id (从对象) | 字符串 | R |
| 视频上传的用户 ID。 |
名称 | 字符串 | 乌尔曼 | 是 | 视频文件的名称。 |
parent_id | 字符串 | R |
| 存储该项目的文件夹的 id。 |
说明 | 字符串/空 | 乌尔曼 |
| 视频或null如果没有描述指定的说明。 |
大小 | 编号 | R |
| 大小,以字节为单位) 的视频。 |
comments_count | 编号 | R |
| 与视频相关联的注释的数目。 |
comments_enabled | 真/假 | R |
| 一个值,指示是否启用视频的评论。如果可以提出意见,此值为true;否则,它是假. |
tags_count | 编号 | R |
| 视频上标记的数量。 |
tags_enabled | 真/假 | R |
| 一个值,指示是否启用视频的标签。如果可以设置标记,此值为true;否则,它是假. |
图片 | 字符串 | R |
| 代表视频的图片的 URL。 |
源 | 字符串 | R |
| 视频的下载 URL。 警告 此值不是持久的。使用后立即发出请求,并且避免缓存。 |
链接 | 字符串 | R |
| 在 SkyDrive 主办的视频的 URL。 |
upload_location | 字符串 | R |
| 上传视频内容,URL 在 SkyDrive 主办。只返回此值wl.skydrive范围是否存在。 |
高度 | 编号 | R |
| 高度以像素为单位,视频。 |
宽度 | 编号 | R |
| 宽度以像素为单位,视频。 |
持续时间 | 编号 | R |
| 持续时间,以毫秒为单位,视频的运行时间。 |
比特率 | 编号 | R |
| 中比特每秒,视频的比特率。 |
类型 | 字符串 | R |
| 类型的对象 ;在本例中,"视频"。 |
created_time | 字符串 | R |
| ISO 8601 格式,创建该视频的时间。 |
updated_time | 字符串 | R |
| ISO 8601 格式,视频上次更新的时间。 |
shared_with | 对象 | R |
| 包含的对象的权限信息。 |
访问 (shared_with 对象) | 字符串 | R |
| 谁可以访问该文件的信息。选项有: · 我选的人 · 就我自己 · 所有人 (公开) · 朋友 · 我的朋友们和他们的朋友 · 有一个链接的人 默认情况下只是我. |
以下是集合的示例视频对象。(为简洁起见,只有第一个对象是显示。
{
"data": [
{
"id": "file.de57f4126ed7e411.DE57F4126ED7E411!135",
"from": {
"name": "Nuno Bento",
"id": "de57f4126ed7e411"
},
"name": "Wildlife.wmv",
"description": null,
"parent_id": "folder.de57f4126ed7e411.DE57F4126ED7E411!126",
"size": 26246026,
"comments_count": 0,
"comments_enabled": true,
"tags_count": 0,
"tags_enabled": true,
"picture": "http://storage.live.com/s1pKk5vzd-gdPaJ5Q1MKN34itsyRlUkAYzD_zsr0Dg-5r4bH8Qo8XRgsunA0M-V4G-XPpu1spowx4xwfjCuDcWQVa7aWld2WCdfeWjBK_coPqaQqzoE26BJP3OZAITB5i_DRPK8jK3ZLilSbNJd-onrOA/Wildlife.wmv:Thumbnail",
"source": "http://storage.live.com/s1pKk5vzd-gdPaJ5Q1MKN34itsyRlUkAYzD_zsr0Dg-5r4bH8Qo8XRgsunA0M-V4G-XPpu1spowx4xwfjCuDcWQVa7aWld2WCdfeWjBK_coPqaQqzoE26BJP3OZAITB5i_DRPK8jK3ZLilSbNJd-onrOA/Wildlife.wmv:VideoMain",
"upload_location": "https://apis.live.net/v5.0/file.de57f4126ed7e411.DE57F4126ED7E411!135/content/",
"link": "https://skydrive.live.com/redir.aspx?cid\u003dde57f4126ed7e411\u0026page\u003dview\u0026resid\u003dDE57F4126ED7E411!135\u0026parid\u003dDE57F4126ED7E411!126",
"height": 720,
"width": 1280,
"duration": 30093,
"bitrate": 5942130,
"type": "video",
"shared_with": {
"access": "Everyone (public)"
},
"created_time": "2011-08-23T23:41:18+0000",
"updated_time": "2011-08-23T23:41:32+0000"
}, {
...
}
]
}
要获取视频对象的集合,使用实时连接其它 API,使到GET请求 /ALBUM_ID/files。
请注意您还可以通过调用其中任何一个视频对象的集合 /ALBUM_ID/videos,或 /FOLDER_ID/videos。
在前面的示例中,ALBUM_ID 替换目标活连接相册 id。
若要创建一个新的视频资源,您可以使到POST请求 /FOLDER_ID或使一个POST请求 /UPLOAD_LOCATION目标文件夹的文件夹。RFC 2388中所述,您必须设置格式多部分/格式数据,作为请求。您必须指定内容类型为多部分/格式数据,并指定边界,如下所示。
Content-Type: multipart/form-data; boundary=AaB03x
提供对由多部分组成的部分及图片的名称上载的内容处置标头,文件名参数的值作为项目,如下所示。
Content-Type: multipart/form-data; boundary=AaB03x
--AaB03x
Content-Disposition: file; filename="strange_lights.avi"
Content-Type: video/x-msvideo
...contents of strange_lights.avi...
--AaB03x--
请注意
边值 (所示为"AaB03x") 可以是任意字符串的任何值。
只有一个由多部分组成的部分,每个请求的支持。对于提出的请求,将内容类型保留空白,将文件的内容放在请求正文中。
成功创建时,位置标头点到的位置的新创建的视频和响应正文包含下列属性。
{
"id": "ID of the new video",
"source": "URL where the video can be downloaded from"
}
任何以下的方法,可以将视频上载到现有资源中。
- 请把UPLOAD_LOCATION的父文件夹的 id。
- 把要求 /FOLDER_ID/files。
- 把要求 /ALBUM_ID/files。
- 把要求 /UPLOAD_LOCATION文件来更新。
- 把要求 /VIDEO_ID/content。
若要更新视频资源的属性,使提出的请求 /VIDEO_ID,并在请求的正文中,指定所做的更改,如下所示。
{
"name": "triangle_formation.avi"
"description": "Sightings of UFOs in triangle formation."
}
要删除的视频,请删除的请求 /VIDEO_ID.
要移动一个视频,使移动的请求 /VIDEO_ID或 /FOLDER_ID,并在请求的正文中,指定目标文件夹的 ID,如下所示。
{
"destination": "FOLDER_ID"
}
要复制的视频,使副本的请求 /VIDEO_ID或 /FOLDER_ID,并在请求的正文中,指定目标文件夹的 ID,如下所示。
{
"destination": "FOLDER_ID"
}
为把和POST请求,可以以指示是否请求应是失败的资源已经存在,如下所示使用覆盖查询字符串参数。
overwrite=true
or
overwrite=false
如果覆盖查询字符串参数的值设置为true,并且该文件存在,则将覆盖它。如果该值设置为false,不覆盖该文件,并返回resource_already_exists错误。如果指定了没有覆盖的查询字符串参数,则默认值为true.
附加 URL 参数
您可以指定其他参数,作为生活连接其它 API,要指导生活连接 Api 返回其结果如何获取请求的 URL 的一部分。下表说明了这些参数。
参数 | 说明 | 有效的值 | 默认值 | 示例 |
漂亮 | 当此值设置为true时,住连接更多人可读的格式返回响应。当此值设置为false,白空间,并不包括新线的时这可以提高性能,但作出响应的可读性降低。 | 真/假 | true | pretty=false |
回调 | 处理与填充 (JSONP) 的函数调用 JSON 的函数的名称。当指定了此参数,则所有错误响应以帮助确保正确处理在 web 浏览器中都使用的 HTTP 状态代码 200。 | 一个字符串,表示回调函数的名称。 | 无 | callback=onResponse |
suppress_response_codes | 当此值设置为true时,住连接返回所有错误响应的 HTTP 状态的代码 200。此选项非常有用与像微软 Silverlight 或 Adobe Flash Player 的 web 浏览器插件。 | 真/假 | 假 | suppress_response_code=true |
方法 | 用于请求处理的而不是得到的 HTTP 方法. | 一个字符串,表示 HTTP 请求的方法,如开机自检. | 无 | method=POST |
return_ssl_resources | 当此值设置为true时,住连接使用安全超文本传输协议 (HTTPS) 返回响应。这很有用,原诉网站也使用 HTTPS 防止 web 浏览器的警告。 | 真/假 | 假 | return_ssl_resources=true |
例如,下面的 URL 使相当参数设置为false的GET请求的用户的联系人列表中,.
https://apis.live.net/v5.0/me/contacts?pretty=false&access_token=ACCESS_TOKEN
Send comments about this topic to Microsoft
Build date: 12/5/2011
© 2012 Microsoft. 版权所有。
保留所有权利 | 商标 | 隐私权声明 | 个人信息中心 | 法律信息 | MSDN Flash 中心 | 联系我们 | 网站反馈