I'm using this call for my website.

http://dev.twitter.com/doc/get/lists/statuses

The documentation states that the url works like this:

http://api.twitter.com/**version**/lists/statuses.**format**

Issue #1: Valid version numbers

I was unable to locate valid values for "version". I tried 1.1.14,
which I understand the current version to be from searching the site,
but that causes a 404. It was only after digging around for examples
that I noticed people using "1". A page describing valid version
numbers should be linked from the word "version".

Issue #2: Extremely unclear parameter passing

As this call uses GET, and the documentation lists parameters you
should include, this implies to me that you should use a query string.
The docs list the following required parameters:

* list_id - The numerical id of the list.
* slug - You can identify a list by its slug instead of its numerical
id. If you decide to do so, note that you'll also have to specify the
list owner using the owner_id or owner_screen_name parameters.

As it is not at all obvious how you discover the "list_id" or
"owner_id", I opted to use "slug" and "owner_screen_name". However, if
you

$ curl 
http://api.twitter.com/1/lists/statuses.json?owner_screen_name=cnn&slug=cnnnews

you get

{"error":"You must specify either a list ID or a slug and
owner","request":"\/1\/lists\/statuses.json?owner_screen_name=cnn"}

Notice that the response json lists the request with only the
"owner_screen_name" parameter. I imagine that 1 or more things went
wrong, possibly including:

1. The API has a bug that is stripping the second parameter
2. The documentation is incorrect, and you may not use "slug" and
"owner_screen_name" to retrieve results.
3. The documentation does not properly describe how you pass the
arguments in the query string. Perhaps you're supposed to encode the
entire string. I was not able to discern this.
4. The documentation is incorrect about the url format.

Issue #3: No obvious way to discover "list_id" or "owner_id"

Issue #4: Undocumented, un-obvious correct url

I was finally able to retrieve the results using this url, pieced
together from scattered examples.

$ curl http://api.twitter.com/1/cnn/lists/cnnnews/statuses.json

So far as I could tell, the documentation in no way implies that you
could use such a url.

For issues 2 though 4, a single, helpful example url would have done
wonders. If the API put http://api.twitter.com/1/cnn/lists/cnnnews/statuses.json
on the page it would have saved me about 5 hours of work.

-- 
Twitter developer documentation and resources: https://dev.twitter.com/doc
API updates via Twitter: https://twitter.com/twitterapi
Issues/Enhancements Tracker: https://code.google.com/p/twitter-api/issues/list
Change your membership to this group: 
https://groups.google.com/forum/#!forum/twitter-development-talk

Reply via email to