Changes from Version 1 of zooomr.contacts.getList

Author:

bluemonki (IP: 78.86.133.53)

Timestamp:

05/09/08 04:45:11 (2 years ago)

Comment:

--

zooomr.contacts.getList

@@ +1 @@
+= zooomr.contacts.getList =
+
+Get a list of contacts for the calling user.
+
+=== Authentication ===
+
+This method requires authentication with 'read' permission.
+
+=== Arguments ===
+
+api_key (Required)
+    Your API application key. 
+
+filter (Optional) THIS IS EITHER IGNORED OR DIFFERENT FROM FLICKR
+    An optional filter of the results. The following values are valid:
+     
+
+    friends
+
+    Only contacts who are friends (and not family)
+
+    family
+
+    Only contacts who are family (and not friends)
+
+    both
+
+    Only contacts who are both friends and family
+
+    neither
+
+    Only contacts who are neither friends nor family
+
+page (Optional)
+    The page of results to return. If this argument is omitted, it defaults to 1.
+per_page (Optional)
+    Number of photos to return per page. If this argument is omitted, it defaults to 1000. The maximum allowed value is 1000.
+
+=== Example Response ===
+{{{
+ {"stat": "ok", "contacts": {"total": 137, "perpage": 10, "page": 1, "_content": {"contact": [{"username": "CaseyAllen", "ignored": 0, "hasicon": 1, "realname": "Casey Allen", "family": 0, "iconserver": 1, "nsid": "36130@Z01", "urlname": "caseyallen", "friend": 0}, {"username": "kunix", "ignored": 0, "hasicon": 1, "realname": "\u90a6\u8cb4 \u65b0\u8218", "family": 0, "iconserver": 1, "nsid": "60331@Z01", "urlname": "kunix", "friend": 0}, {"username": "dbcohen", "ignored": 0, "hasicon": 1, "realname": "Dave Cohen", "family": 0, "iconserver": 1, "nsid": "29397@Z01", "urlname": "dbcohen", "friend": 0}, {"username": "scherbi", "ignored": 0, "hasicon": 1, "realname": "Bill Scherer", "family": 0, "iconserver": 1, "nsid": "45902@Z01", "urlname": "scherbi", "friend": 0}, {"username": "Rime", "ignored": 0, "hasicon": 1, "realname": "Ray Whitt", "family": 0, "iconserver": 1, "nsid": "81113@Z01", "urlname": "rime", "friend": 0}, {"username": "crazyfridge", "ignored": 0, "hasicon": 1, "realname": "Yannick V", "family": 0, "iconserver": 1, "nsid": "64649@Z01", "urlname": "crazyfridge", "friend": 0}, {"username": "jonhwilliams", "ignored": 0, "hasicon": 0, "realname": "Jon Williams", "family": 0, "iconserver": 1, "nsid": "81940@Z01", "urlname": "jonhwilliams", "friend": 0}, {"username": "throughmylens ", "ignored": 0, "hasicon": 1, "realname": "Christine Delissio", "family": 0, "iconserver": 1, "nsid": "75964@Z01", "urlname": "throughmylens", "friend": 0}, {"username": "mill", "ignored": 0, "hasicon": 1, "realname": "Mill K", "family": 0, "iconserver": 1, "nsid": "70365@Z01", "urlname": "rollingmill", "friend": 0}, {"username": "shigekicks", "ignored": 0, "hasicon": 1, "realname": "shige kicks", "family": 0, "iconserver": 1, "nsid": "78433@Z01", "urlname": "shigekicks", "friend": 0}]}, "pages": 14}}
+}}}