Friendships/show

跳转到: 导航, 搜索
(friendships/show)
第1行: 第1行:
 
== friendships/show ==
 
== friendships/show ==
 
返回两个用户关系的详细情况
 
返回两个用户关系的详细情况
 
Returns detailed information about the relationship between two users.
 
  
 
=== URL: ===
 
=== URL: ===
 
http://api.t.sina.com.cn/friendships/show.format
 
http://api.t.sina.com.cn/friendships/show.format
 
   
 
   
===Formats:===
+
===格式===
 
xml, json
 
xml, json
 
   
 
   
=== HTTP Method(s): ===
+
=== HTTP请求方式===
 
GET
 
GET
 
   
 
   
===Requires Authentication (about authentication):===
+
===是否需要身份验证===
false (see usage notes)
+
true
 
   
 
   
===API rate limited (about rate limiting):===
+
===请求数限制===
 
true
 
true
 
   
 
   
===Parameters:===
+
===请求参数===
如果请求没做身份验证,下面参数为必选一个:
+
以下参数可不填写,如不填,则取当前用户
* source_id. 要判断的源用户UID
+
* source_id. 源用户UID
o Example: http://api.t.sina.com.cn/friendships/show.xml?source_id=123
+
:o 示例: http://api.t.sina.com.cn/friendships/show.xml?source_id=10502
* source_screen_name. T要判断的源用户帐号 
+
* source_screen_name. 源用户昵称
o Example: http://api.t.sina.com.cn/friendships/show.xml?source_screen_name=bob  
+
:o 示例: http://api.t.sina.com.cn/friendships/show.xml?source_screen_name=bob  
 +
 
 
下面参数必须选填一个:
 
下面参数必须选填一个:
 
* target_id. 要判断的目的用户UID
 
* target_id. 要判断的目的用户UID
o Example: http://api.t.sina.com.cn/friendships/show.xml?target_id=456
+
:o Example: http://api.t.sina.com.cn/friendships/show.xml?target_id=10503
* target_screen_name. 要判断的目的用户帐号
+
* target_screen_name. 要判断的目的用户昵称
o Example: http://api.t.sina.com.cn/friendships/show.xml?target_screen_name=jack
+
:o Example: http://api.t.sina.com.cn/friendships/show.xml?target_screen_name=timyang
  
 
+
===使用说明===
One of the following is required if the request is unauthenticated:
+
* 如果用户已登录,此接口将自动使用登陆用户ID作为source_id。就算指定了源ID也将使用登陆用户来作为源ID来查询关系
* source_id. The user_id of the subject user.
+
o Example: http://api.t.sina.com.cn/friendships/show.xml?source_id=123
+
* source_screen_name. The screen_name of the subject user.
+
o Example: http://api.t.sina.com.cn/friendships/show.xml?source_screen_name=bob
+
One of the following is required:
+
* target_id. The user_id of the target user.
+
o Example: http://api.t.sina.com.cn/friendships/show.xml?target_id=456
+
* target_screen_name. The screen_name of the target user.
+
o Example: http://api.t.sina.com.cn/friendships/show.xml?target_screen_name=jack
+
 
+
===Usage Notes:===
+
* 如果用户已登录,此接口将自动使用登陆用户ID左右源ID。就算指定了源ID也将使用登陆用户来作为源ID来查询关系
+
* 如果来源是没有指定一个未经验证的请求,将返回http的403错误
+
 
* 如果源用户或目的用户不存在,将返回http的403错误
 
* 如果源用户或目的用户不存在,将返回http的403错误
 
* 消息格式的定义,晚点补充
 
* 消息格式的定义,晚点补充
  
* If this method is invoked as an authenticated request, the method will use the authenticated user as the source user implicitly. However, a source explicitly specified with parameters will override an authenticated user as the source of the relationship query.
+
===返回===
* If the source is not specified for an unauthenticated request, the method will return an HTTP 403.
+
* If a source or target is specified but does not exist, the method will return an HTTP 404.
+
* The <notifications_enabled> element will only be returned for an authenticated source user within the <source> element. Notification data is not publicly available data and therefore remains restricted to authenticated users within the API. For unauthenticated source users and target users, the <notifications_enabled> element will be empty.
+
* This method returns redundant data, in that the bi-directional relationship of the source and target can be determined by looking at the <following> and <followed_by> element within either the <source> or <target> nodes. We deliver this data twice in denormalized form for convenience and increased readability.
+
 
+
 
+
===Response (about return values): ===
+
 
XML example:
 
XML example:
 
  <?xml version="1.0" encoding="UTF-8"?>
 
  <?xml version="1.0" encoding="UTF-8"?>
第75行: 第54行:
 
  </target>
 
  </target>
 
  </relationship>
 
  </relationship>
JSON example:
+
 
 +
JSON 示例:
 
  {"relationship": {
 
  {"relationship": {
 
  "source": {
 
  "source": {
第92行: 第72行:
 
  }
 
  }
  
===Usage examples: ===
+
===使用示例===
 
cURL (about cURL):
 
cURL (about cURL):
 
 
curl -u user:password http://api.t.sina.com.cn/friendships/show.xml?target_id=456
 
curl -u user:password http://api.t.sina.com.cn/friendships/show.xml?target_id=456

2009年12月22日 (二) 17:08的版本

目录

friendships/show

返回两个用户关系的详细情况

URL:

http://api.t.sina.com.cn/friendships/show.format

格式

xml, json

HTTP请求方式

GET

是否需要身份验证

true

请求数限制

true

请求参数

以下参数可不填写,如不填,则取当前用户

  • source_id. 源用户UID
o 示例: http://api.t.sina.com.cn/friendships/show.xml?source_id=10502
  • source_screen_name. 源用户昵称
o 示例: http://api.t.sina.com.cn/friendships/show.xml?source_screen_name=bob

下面参数必须选填一个:

  • target_id. 要判断的目的用户UID
o Example: http://api.t.sina.com.cn/friendships/show.xml?target_id=10503
  • target_screen_name. 要判断的目的用户昵称
o Example: http://api.t.sina.com.cn/friendships/show.xml?target_screen_name=timyang

使用说明

  • 如果用户已登录,此接口将自动使用登陆用户ID作为source_id。就算指定了源ID也将使用登陆用户来作为源ID来查询关系
  • 如果源用户或目的用户不存在,将返回http的403错误
  • 消息格式的定义,晚点补充

返回

XML example:

<?xml version="1.0" encoding="UTF-8"?>
<relationship>
<source>
<id>123</id>
<screen_name>bob</screen_name>
<following>true</following>
<followed_by>false</followed_by>
<notifications_enabled>false</notifications_enabled>
</source>
<target>
<id>456</id>
<screen_name>jack</screen_name>
<following>false</following>
<followed_by>true</followed_by>
<notifications_enabled></notifications_enabled>
</target>
</relationship>

JSON 示例:

{"relationship": {
"source": {
"id": 123,
"screen_name": "bob",
"following": true,
"followed_by": false,
"notifications_enabled": false },
"target": {
"id": 456,
"screen_name": "jack",
"following": false,
"followed_by": true,
"notifications_enabled": null }
}
}

使用示例

cURL (about cURL): curl -u user:password http://api.t.sina.com.cn/friendships/show.xml?target_id=456