Open Archives API » Comments/Add

This method add a comment with the specified record (this method bypasses the moderation queue).

URL

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

Method

POST

Input

Name	Required	Description	Default
key	Yes	API key
archive	Yes	Code of archive (obtain a list of valid archive codes via Stats/Archives)
identifier	Yes	Identifier of the record
comment	Yes	Contents of the comment
name	Yes	Name of commenter
email	Yes	E-mail address of commenter (not shown publicly)
callback	No	Function name to be called on JSON data (JSONP).

Output

The result in JSON(P) format is onlye a status "ok" message. An example status looks (pretty-printed) like:

{
	"status": "ok"
}

Errors

One of the following errors may be thrown:

Error code	Error message
1	Invalid archive
2	Invalid identifier (syntax)
3	Invalid key (syntax)
5	Invalid format
6	Invalid email (syntax)
11	Missing required archive
12	Missing required identifier
13	Missing required key
15	Missing required format specification
20	Missing required comment
21	Missing required name
22	Missing required email

An example error looks (pretty-printed) like:

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

Back to API documentation