album.docs.getList

← All the API methods

Live testing

Return the list of documents in an album

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

URL

https://api.ipernity.com/api/album.docs.getList

Parameters

api_key ∗ Your api_key.
album_id ∗ The Album ID to return the documents for.
media Only return this type of media. Valid values are : photo, video, audio, other.
share Only return the documents matching this privacy level. Possible values are :
  • 0 : private documents
  • 1 : documents visible to family
  • 2 : documents visible to friends
  • 3 : documents visible to friends & family
  • 4 : public documents
This option is only available on an album owned by an authenticated calling user.
extra A comma seprarated list of extra information to include in each records. Extra values are: dates, geo, medias, original, link.
thumbsize Choose your prefered size for the thumbnails: 75x, 100, 240, 250x, 500, 560, 640, 800, 1024, 1600 or 2048. (Value is 75x by default)
per_page The number of docs to return on each page. (Default is 20, maximum is 100)
page The page of results to return.
∗ : this parameter is required.
Access to thumbnail size greater than 800 pixels depends on user preferences.

Response

<album album_id="10460">
  <docs total="12" per_page="20" page="1" pages="1">
    <doc doc_id="394926" media="photo" license="0" title="test de photo" safety="1">
      <thumb label="75x" ext="jpg" w="75" h="75" 
             url="https://u1.ipernity.com/2/49/26/394926.e831d113.75x.jpg"/>
    </doc>
    <doc doc_id="3611" media="photo" license="11" title="110693" safety="1">
      <thumb label="75x" ext="jpg" w="75" h="75" 
             url="https://u1.ipernity.com/1/36/11/3611.236f34e9.75x.jpg"/>
    </doc>
    (...)
  </docs>
  <cover doc_id="395574" w="75" h="75"
         url="https://u1.ipernity.com/2/55/74/395574.a1dccd50.75x.jpg"/>
</album>

Error codes

1 Album not found The album ID is invalid or insufficient permissions to view this album.
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.
130 OAuth protocol version unsupported We only support OAuth version 1.1 and 1.1a
131 OAuth parameters are missing Some of the OAuth parameters were not sent: %s%
132 OAuth Clock skew The timestamp sent is out of ranges. Please check your computer clock is not skewed.
133 OAuth Nonce is invalid The OAuth Nonce parameter cannot be used twice.
134 OAuth Timestamp is invalid The OAuth Timestamp parameter is out of ranges (clock skew) or inferior to the previous timestamp sent.
135 OAuth Signature method unsupported The OAuth Signature must be either MD5, HMAC_SHA1 or PLAINTEXT over HTTPS.
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

  • 2013-07-05: Added link to extra values.
  • 2010-09-02: Added safety.
  • 2008-12-01: Method created.

See also