Blocks/exists

跳转到: 导航, 搜索
(Response (about return values):)
 
(未显示2个用户的4个中间版本)
第1行: 第1行:
== blocks/exists ==
+
{{api_desc2|
Returns if the authenticating user is blocking a target user. Will return the blocked user's object if a block exists, and error with a HTTP 404 response code otherwise.
+
uri=blocks/exists|
 
+
desc=检测指定用户是否在登录用户的黑名单内。|
=== URL: ===
+
format=XML/JSON|
http://api.t.sina.com.cn/blocks/exists/id.format
+
httpMethod=GET|
+
needAuth=true|
===Formats:===
+
rateLimit=true|
xml, json
+
params={{api_args|user_id|true|int64|要检测的用户ID}}
+
{{api_args|screen_name|false|string|要检测的用户微博昵称}}|
=== HTTP Method(s): ===
+
getParam=&user_id=12345|
GET
+
postParam=|
+
result=
===Requires Authentication (about authentication):===
+
===XML示例===
true
+
<pre>
 
+
<?xml version="1.0" encoding="UTF-8"?>
===API rate limited (about rate limiting):===
+
<result>false</result>
1 call per request
+
</pre>
 
+
===JSON示例===
===Parameters:===
+
<pre>
One of the following:
+
{
* id.  Optional.  The ID or screen_name of the potentially blocked user.
+
    "result" : false
o Example: http://api.t.sina.com.cn/blocks/exists/bob.xml
+
}
* user_id.  Optional.  Specfies the ID of the potentially blocked user. Helpful for disambiguating when a valid user ID is also a valid screen name.
+
</pre>|
o Example: http://api.t.sina.com.cn/blocks/exists.xml?user_id=1401881
+
useAge=
* screen_name.  Optional.  Specfies the screen name of the potentially blocked user. Helpful for disambiguating when a valid screen name is also a user ID.
+
如果user_id或者screen_name均未提供,则返回400错误。|
o Example: http://api.t.sina.com.cn/blocks/exists.xml?screen_name=101010
+
otherInfo=
 
+
}}
===Response (about return values): ===
+
XML examplez:
+
Block does not exist, returned as an HTTP 404:
+
    <?xml version="1.0" encoding="UTF-8"?>  
+
    <hash>
+
          <request>/blocks/exists.xml?screen_name=al3x</request>
+
          <error>You are not blocking this user.</error>
+
    </hash>
+
Block exists:
+
<?xml version="1.0" encoding="UTF-8"?>
+
<user>
+
<id>1401881</id>
+
<name>Doug Williams</name>
+
<screen_name>dougw</screen_name>
+
<location>San Francisco, CA</location>
+
<description>Twitter API Support. Internet, greed, users, dougw and opportunities are my passions.</description>
+
<profile_image_url>http://s3.amazonaws.com/twitter_production/profile_images/59648642/avatar_normal.png</profile_image_url>
+
<url>http://www.igudo.com</url>
+
<protected>false</protected>
+
<followers_count>1031</followers_count>
+
<profile_background_color>9ae4e8</profile_background_color>
+
<profile_text_color>000000</profile_text_color>
+
<profile_link_color>0000ff</profile_link_color>
+
<profile_sidebar_fill_color>e0ff92</profile_sidebar_fill_color>
+
<profile_sidebar_border_color>87bc44</profile_sidebar_border_color>
+
<friends_count>293</friends_count>
+
<created_at>Sun Mar 18 06:42:26 +0000 2007</created_at>
+
<favourites_count>0</favourites_count>
+
<utc_offset>-18000</utc_offset>
+
<time_zone>Eastern Time (US & Canada)</time_zone>
+
<profile_background_image_url>http://s3.amazonaws.com/twitter_production/profile_background_images/2752608/twitter_bg_grass.jpg</profile_background_image_url>
+
<profile_background_tile>false</profile_background_tile>
+
<statuses_count>3390</statuses_count>
+
<notifications>false</notifications>
+
<following>false</following>
+
<verified>true</verified>
+
<status>
+
<created_at>Tue Apr 07 22:52:51 +0000 2009</created_at>
+
<id>1472669360</id>
+
<text>At least I can get your humor through tweets. RT @abdur: I don't mean this in a bad way, but genetically speaking your a cul-de-sac.</text>
+
<source><a href="http://www.tweetdeck.com/">TweetDeck</a></source>
+
<truncated>false</truncated>
+
<in_reply_to_status_id></in_reply_to_status_id>
+
<in_reply_to_user_id></in_reply_to_user_id>
+
<favorited>false</favorited>
+
<in_reply_to_screen_name></in_reply_to_screen_name>
+
</status>
+
</user>
+
 
+
JSON example:
+
Block does not exist, returned as an HTTP 404:
+
{"request":"\/blocks\/exists.json?screen_name=al3x","error":"You are not blocking this user."}
+
 
+
===Usage examples: ===
+
cURL (about cURL):
+
 
+
curl -u user:password http://api.t.sina.com.cn/blocks/exists/al3x.json
+

2012年9月24日 (一) 11:44的最后版本

目录

blocks/exists

检测指定用户是否在登录用户的黑名单内。

URL

http://api.t.sina.com.cn/blocks/exists.(json%7Cxml)

支持格式

XML/JSON

HTTP请求方式

GET

是否需要登录

true
关于授权机制,参见授权机制声明

请求数限制

true
关于请求数限制,参见接口访问权限说明

请求参数

  必选 类型及范围 说明
source true string 申请应用时分配的AppKey,调用接口时候代表应用的唯一身份。(采用OAuth授权方式不需要此参数)
user_id true int64 要检测的用户ID
screen_name false string 要检测的用户微博昵称

注意事项

如果user_id或者screen_name均未提供,则返回400错误。

返回结果

XML示例

<?xml version="1.0" encoding="UTF-8"?>
<result>false</result>

JSON示例

{
    "result" : false
}

其他

文档更新时间: 2012-09-24