Help / API

group.docs.add / Live testing

Add one or many docs to a group

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

URL

HTTP POSThttp://www.ipernity.com/api/group.docs.add

Parameters

`api_key`	∗	Your api_key.
`group_id`	∗	The group ID you wish to add documents in.
`doc_id`	∗	A document ID or a comma separated list of document IDs. (List may contain a maximum of 20 IDs)

∗ : this parameter is required.

Response

<group group_id="10551" total="552" added="2" skipped="2" pending="2">
  <doc doc_id="396419" added="1" pending="0" error="0"/>
  <doc doc_id="396414" added="1" pending="1" error="0"/>
  <doc doc_id="396413" added="0" pending="1" error="0"/>
  <doc doc_id="396433" added="0" pending="0" error="1"/>
</group>

A document is skipped (marked added="0") when it is already a member of this group. A document is marked as pending when it needs to be approved by the group moderators.
When a doc is marked added="0" and pending="1", it means the doc has been added previously and is still waiting for approval.
Document error codes:

error="1": The document has been previously added to the maximum allowed groups.
error="2": The document type (photo/audio/video/other) does not match the group restrictions

Error codes

1	`Group not found`	The group ID is invalid or the calling user is not a member of this group.
2	`Documents not found`	One or more document IDs are not found or do not belong to the calling user.
3	`Quota limit reached`	The calling user has reached the quota limit of this group.
4	`Group closed or limit reached`	This group is closed or cannot contain anymore 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.
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.