Difference between revisions of "downloadEac-cpf"

From Archives Portal Europe Wiki
Jump to: navigation, search
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
Request url: <code>https://api.archivesportaleurope.net/services/download/eac-cpf/{id}</code>
+
Request url: [https://www.archivesportaleurope.net/ApeApi/#!/download/downloadXmlEacCpf <code>https://api.archivesportaleurope.net/services/download/eac-cpf/{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 authority record for a Corporate Body, a Person or a Family (EAC-CPF record) identified with {id} as EAC-CPF/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 EAC-CPF record. This parameter is required.
+
Internal APE identifier of an EAC-CPF record. This parameter is required.
 +
 
 +
''N.B.: you can find the (internal APE) identifier of a records creator (an EAC-CPF record) which is necessary for using this service via the [[searchEac | /search/eac]] 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 EAC-CPF/XML file of the requested document.
  
 
[[Category:Technical_documentation]]
 
[[Category:Technical_documentation]]

Latest revision as of 15:45, 30 August 2017

Request url: https://api.archivesportaleurope.net/services/download/eac-cpf/{id}. This service is a GET-request.

This download-service enables a web developer to download a complete authority record for a Corporate Body, a Person or a Family (EAC-CPF record) identified with {id} as EAC-CPF/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 an EAC-CPF record. This parameter is required.

N.B.: you can find the (internal APE) identifier of a records creator (an EAC-CPF record) which is necessary for using this service via the /search/eac service

Response parameters

None. The response is the actual EAC-CPF/XML file of the requested document.