account.getQuota album.create album.delete album.docs.add album.docs.getContext album.docs.getList album.docs.remove album.docs.setList album.edit album.get album.getFaves album.getList album.getVisitors album.orderList album.setPerms api.methods.get api.methods.getList auth.checkToken auth.getFrob auth.getToken doc.albums.add doc.checkMD5 doc.comments.add doc.comments.delete doc.comments.edit doc.comments.get doc.comments.getList doc.comments.reply doc.delete doc.get doc.getContainers doc.getContext doc.getExif doc.getFaves doc.getList doc.getMedias doc.getPerms doc.getVisitors doc.notes.add doc.notes.delete doc.notes.edit doc.search doc.set doc.setGeo doc.setLicense doc.setPerms doc.setSafety doc.tags.add doc.tags.edit doc.tags.getList doc.tags.remove explore.docs.getPopular explore.docs.getRecent explore.docs.homepage explore.groups.getRandom faves.albums.add faves.albums.getList faves.albums.remove faves.docs.add faves.docs.getList faves.docs.remove folder.albums.add folder.albums.getList folder.albums.remove folder.create folder.delete folder.edit folder.get folder.getList folder.orderList group.docs.add group.docs.getContext group.docs.getList group.docs.remove group.get group.getList group.search network.autocomplete network.docs.getRecent network.getList post.comments.add post.comments.delete post.comments.edit post.comments.get post.comments.getList post.comments.reply post.get post.getContext post.getFaves post.getList post.getVisitors post.search post.set tags.docs.getList tags.user.getList tags.user.getPopular test.echo test.hello upload.checkTickets upload.file upload.replace user.get

Live testing

Replace all the documents and the cover of an album

• This method call must be authenticated and signed.
• This method requires "write" permission on docs.

URL

HTTP POSThttp://api.ipernity.com/api/album.docs.setList

Parameters

api_key	∗	Your api_key.
album_id	∗	The Album ID you wish to set its document list.
doc_ids	∗	A comma separated list of document IDs. This list of documents will replace the album existing list. Document will appear in the album the order sent.
cover_id	∗	The document ID to use as the album cover. This document must belong to the doc_ids list.

∗ : this parameter is required.

Response

<album album_id="123" cover_id="1235659" total="219" added="217" skipped="2">
  <doc doc_id="1235658" added="1" error="0"/>
  <doc doc_id="1235659" added="1" error="0"/>
  <doc doc_id="1235660" added="0" error="1"/>
  <doc doc_id="1256852" added="0" error="0"/>
  (...)
</album>

Error codes

1	Album not found	The album ID is invalid or insufficient permissions to view this album.
2	Documents not found	One or more document IDs are not found or do not belong to the calling user.
3	Cover document not found	The cover document ID is missing or is not a member of the doc_ids list.
4	Album limit reached	The album cannot contain that much documents.
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

• 2008-12-01: Method created.

See also

• album.create
• album.delete
• album.docs.add
• album.docs.getContext
• album.docs.getList
• album.docs.remove
• album.edit
• album.get
• album.getFaves
• album.getList
• album.orderList
• album.setPerms