xREL.v3

API: favs/lists method - Wiki

Change Language
Board RSS API Status Help Contact
Preferences

Article: API: favs/lists method

API: favs/lists method

Returns a list of all the current user's favorite lists.

URL
https://api.xrel.to/v2/favs/lists.format

Formats
json, xml

HTTP Method(s)
GET

Authentication
OAuth

Parameters
none

Example Response
<fav_lists>
  <fav_list>
    <id>1</id>
    <name>Watchlist</name>
    <public>0</public>
    <notify>1</notify>
    <auto_read>1</auto_read>
    <include_p2p>1</include_p2p>
    <description>Default favorites list</description>
    <password_hash>
      f0aedf295071ed34ab8c6a7692223d22b6a19841
    </password_hash>
    <entry_count>6</entry_count>
    <unread_releases>0</unread_releases>
  </fav_list>
</fav_lists>


About password_hash:
If the list has a password, this will be a hash value that has been composed like this:
$password_hash = sha1($list->id . "\r\n" . $list->password);
So if you want to check whether if a password for a list is correct, compose this hash and compare it with the hash from this method. For lists without a password, password_hash will be empty.

Last edit: 15 Apr. 2016 6:29 PM.

Preferences

Rate this article
5/55/55/55/55/55/55/55/55/55/5
Rating: 5.0 / 5.0 (2 votes)