Help / API

album.getList / Live testing

Return the albums list for a given user

This method call does not require authentication.
This method does not require any particular permission.

URL

http://www.ipernity.com/api/album.getList

Parameters

`api_key`	∗	Your api_key.
`user_id`		The ID of the user to get an album list for. (If not specified, the calling user is assumed)
`thumbsize`		Choose your prefered size for the cover: `75x, 100, 240, 500 or 560`. (Value is 75x by default)
`per_page`		The number of records to return on each page. (Default is 100, maximum is 100)
`page`		The page of results to return.

∗ : this parameter is required.

Response

<albums total="17" per_page="2" page="1" count="2" thumbsize="75x">
  <can create="1"/>
  <album album_id="10551" link="http://www.ipernity.com/doc/1/album/10551" 
         title="My very first album">
    <dates created_at="1218038768" last_comment_at="0" last_update_at="0" />
    <count docs="2" visits="0" faves="0" comments="0" 
           family="1" friend="1" ff="1" public="1" />
    <cover doc_id="395574" w="122" h="240"
           url="http://u1.ipernity.com/2/55/74/395574.a1dccd50.240.jpg" />
    <can fave="1" comment="1" />
    <permissions comment="3" />
  </album>
  <album album_id="10540" link="http://www.ipernity.com/doc/1/album/10540" 
         title="Summer">
    <visibility family="0" friend="0" ff="0" public="1" />
    <dates created_at="1218037919" last_comment_at="0" last_update_at="0" />
    <count docs="1" visits="0" faves="0" comments="0" />
    <cover doc_id="395557" w="240" h="156"
           url="http://u1.ipernity.com/2/55/57/395557.e8265d4f.240.jpg" />
    <can fave="1" comment="1" />
    <permissions comment="3" />
  </album>
</albums>

Permissions are only returned on an authenticated call by the albums owner.
The count.family, count.friend, (...) indicates the number of documents visible for each part of the calling user's network.

Error codes

1	`User not found`	The user ID is either invalid or the account is closed/suspended.

100	`API Key is missing`	Please add the api_key parameter to this request.
101	`API Key is invalid`	This API key is invalid or disabled.
102	`Invalid format`	The requested format is invalid. Valid formats are : json, xml, php.
103	`Method not found`	The requested method is invalid or missing.
104	`Signature missing`	The query signature is missing.
105	`Signature is invalid`	The query signature is invalid.
106	`Token missing`	User is not logged. The authentication token is missing.
107	`Token invalid`	The authentication token is invalid.
108	`Account closed`	The user account is closed or suspended.
109	`Action blocked`	This action is blocked because of a member or a group blocklist restriction
110	`Insufficient permissions`	Insufficient permissions for this method.
111	`IP not allowed`	The request came from a remote address not allowed by this application.
112	`Application Quota Error`	The application has reached its requests quota.
113	`Client IP Quota Error`	The client IP has reached a limit. Limits are based on requests per seconds, minutes, hours, ...
120	`HTTP POST required`	This API method must be called using HTTP POST.
121	`Invalid SOAP envelope`	The SOAP envelope could not be parsed.
122	`Invalid XML-RPC envelope`	The XML-RPC envelope could not be parsed.
500	`Service error`	Service general error.
501	`Maintenance mode`	Service under temporarily maintenance. Thank you for your kind understanding.
503	`Service unavailable`	The service is temporarily unavailable. Please try again in a few minutes.

Changelog

2008-12-01: Method created.