Difference between revisions of "downloadEad"

From Archives Portal Europe Wiki
Jump to: navigation, search
Line 10: Line 10:
  
 
== id ==
 
== id ==
Internal APE identifier of a Finding Aid (id is starting with "F"), a Holdings Guide (id's 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.
+
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.
 
<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]]

Revision as of 12:41, 5 June 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.

Response parameters

None. The response is the actual EAD/XML file of the requested document.