Difference between revisions of "downloadEad"
(Created page with "Request url: <code>https://api.archivesportaleurope.net/services/download/ead/{id}</code> This service is a GET-request. <div><br/>__TOC__<br/></div> = Request parameters =...") |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | Request url: <code>https://api.archivesportaleurope.net/services/download/ead/{id}</code> | + | Request url: [https://www.archivesportaleurope.net/ApeApi/#!/download/downloadXmlEad <code>https://api.archivesportaleurope.net/services/download/ead/{id}</code>]. |
| − | + | ||
This service is a GET-request. | This service is a GET-request. | ||
| + | |||
| + | This download-service enables a web developer to download a complete finding aid, holdings guide or source guide identified with {id} as EAD/XML-document. | ||
| + | |||
| + | For this service you must change the accept header into "application/octet-stream" or leave it out. | ||
| + | |||
<div><br/>__TOC__<br/></div> | <div><br/>__TOC__<br/></div> | ||
= Request parameters = | = Request parameters = | ||
== id == | == id == | ||
| − | Internal APE identifier of a | + | Internal APE identifier of a finding aid (id is starting with "F"), a holdings guide (id is starting with "H"), a source guide (id is starting with "S"). In this service, if the identifier does not start with a "F", "H" or "S" you will get an error message. This parameter is required. |
| + | |||
| + | ''N.B.: you can find the (internal APE) identifier of a finding aid, a holdings guide or a source guide which is necessary for using this service via the [[searchEad | /search/ead]] service'' | ||
<br/><br/> | <br/><br/> | ||
| + | |||
= Response parameters = | = Response parameters = | ||
None. The response is the actual EAD/XML file of the requested document. | None. The response is the actual EAD/XML file of the requested document. | ||
[[Category:Technical_documentation]] | [[Category:Technical_documentation]] | ||
Latest revision as of 14:44, 30 August 2017
Request url: https://api.archivesportaleurope.net/services/download/ead/{id}.
This service is a GET-request.
This download-service enables a web developer to download a complete finding aid, holdings guide or source guide identified with {id} as EAD/XML-document.
For this service you must change the accept header into "application/octet-stream" or leave it out.
Request parameters
id
Internal APE identifier of a finding aid (id is starting with "F"), a holdings guide (id is starting with "H"), a source guide (id is starting with "S"). In this service, if the identifier does not start with a "F", "H" or "S" you will get an error message. This parameter is required.
N.B.: you can find the (internal APE) identifier of a finding aid, a holdings guide or a source guide which is necessary for using this service via the /search/ead service
Response parameters
None. The response is the actual EAD/XML file of the requested document.
