doc.notes.add

← All the API methods

Live testing

Add a note to a photo.

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

URL

HTTP POSThttps://api.ipernity.com/api/doc.notes.add

Parameters

api_key ∗ Your api_key.
doc_id ∗ The ID of the photo you wish to add a note on.
content ∗ The note text. (Some HTML tags are accepted)
member_id The user ID associated to this note.
x ∗ The left coordinate of the note.
y ∗ The top coordinate of the note.
w ∗ The width of the note.
h ∗ The height of the note.
preview Set this flag to 1 to preview the note. The note will not be added.
∗ : this parameter is required.
The note coordinates are expressed in pixels. Notes are shown normally on the 560 pixel image size. If the coordinates don't match with the photo dimensions, the note will be placed at x=0, y=0, w=50, h=50. When associating a member ID to a note, the content is not required.

Response

<note note_id="58856" user_id="58565" posted_at="1216898438" x="10" y="12" w="22" h="33">Your note</note>

Error codes

1 Document not found The document ID is invalid or insufficient permissions to view this doc.
2 Content is empty The content text of the note was not sent, is empty or only contains HTML.
3 Member ID not found The member ID sent does not exist, does not belong to the calling user network or has blocked the calling user.
4 Note coordinates are invalid The coordinates sent do not match the document dimension constraints.
5 Maximum of notes reached The maximum limit of notes for this photo was reached.
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