Open Archives API » Comments/Delete

This method deletes a specific comment, which was created via the Comments/Add API call with the same API key.

URL

https://api.openarchieven.nl/1.0/comments/delete.json

Method

POST

Input

Name	Required	Description	Default
key	Yes	API key
comment_id	Yes	Identifier of the comment, see the id field in the output of Comments/List
callback	No	Function name to be called on JSON data (JSONP).

Output

The result in JSON(P) format is a status message with either "ok" or "no records deleted". An example status looks (pretty-printed) like:

{
	"status": "ok"
}

Errors

One of the following errors may be thrown:

Error code	Error message
3	Invalid key (syntax)
13	Missing required key
41	Missing required comment_id

An example error looks (pretty-printed) like:

{
	"error_code": 41,
	"error_description": "Invalid email (syntax)"
}

Back to API documentation