doc.setPerms

← All the API methods

Live testing

Set permissions for a document.

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

URL

HTTP POSThttps://api.ipernity.com/api/doc.setPerms

Parameters

api_key ∗ Your api_key.
doc_id ∗ The ID of the document you wish to set permissions for.
is_public Set to 1 to flag this document as public, 0 to make it private.
is_family Set to 1 to flag this document as family.
is_friend Set to 1 to flag this document as friend.
share Set the privacy level with one parameter. Values are :
  • 0 : private
  • 1 : visible to family
  • 2 : visible to friends
  • 3 : visible to friends & family
  • 4 : public
When sent, the is_public, is_family and is_friend flags are ignored.
perm_comment The new permissions to comment on the document :
  • 0: only you
  • 3: friends & family
  • 4: contacts
  • 5: every member
perm_tag The new permissions to add a tag on the document :
  • 0: only you
  • 3: friends & family
  • 4: contacts
  • 5: every member
perm_tagme The new permissions to let a member add his personal member tag on the document :
  • 0: only you
  • 3: friends & family
  • 4: contacts
  • 5: every member
∗ : this parameter is required.
At least one of the required parameters is needed. When setting the document privacy the three parameters is_public, is_friend, is_family are required - or use share.

Response

This method only returns a status and a possible error code.

Error codes

1 Document not found The document ID is invalid or insufficient permissions to view this doc.
2 Invalid arguments One or many required arguments were not sent or have an invalid value.
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