Open Archives API » Links/Add

This method queues a page in a family tree publication to be checked for the existance of a reference to a specific record on Open Archives (eg. http://www.openarchieven.nl/show.php?archive=elo&identifier=9695ce6f-add1-c8e7-0e6c-541567beb570&lang=en) or record on website of archive (eg. http://www.archiefleiden.nl/home/collecties/personen/zoek-op-personen/weergave/akte/layout/default/id/9695ce6f-add1-c8e7-0e6c-541567beb570). If such a reference is found then a link is placed on the records page on Open Archives to the specified page. The <title> is used as a title for the link on the records page.

URL

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

Method

POST

Input

Name	Required	Description	Default
archive	Yes	Code of archive (obtain a list of valid archive codes via Stats/Archives)
identifier	Yes	Identifier of the record
url	Yes	Page in a family tree with a reference to record on Open Archives or archives website (only http/https URL's are allowed), this page should have a link to the record and have a title.
key	Yes	API key
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)
7	Unknown key
8	Invalid url (syntax)
11	Missing required archive
12	Missing required identifier
13	Missing required key
14	Missing required url
39	Page has no title
40	Page has no link to record

An example error looks (pretty-printed) like:

{
	"error_code": 7,
	"error_description": "Unknown key"
}

Back to API documentation