Difference between revisions of "contentEadArchdesc"

From Archives Portal Europe Wiki
Jump to: navigation, search
Line 6: Line 6:
 
== id ==
 
== 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"). Descriptive Units result in other information, so a separate request is developed, called <code>/content/ead/clevel/{id}</code>. 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"). Descriptive Units result in other information, so a separate request is developed, called <code>/content/ead/clevel/{id}</code>. 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/>
 
= Response parameters =
 
= Response parameters =
  

Revision as of 13:39, 11 August 2016

Request url: https://api.archivesportaleurope.net/services/content/ead/archdesc/{id} This service is a GET-request.



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"). Descriptive Units result in other information, so a separate request is developed, called /content/ead/clevel/{id}. 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

{
  "id": "F883",
  "unitId": "3066",
  "unitTitle": "Partij van de Arbeid (P.v.d.A.), Statenfractie PvdA Gelderland",
  "repositoryId": 363,
  "repository": "Gelders Archief",
  "content": {
   --- skip ---
  }
}

id

Internal APE identifier of the Finding Aid, Holdings Guide or Source Guide. The same as your request parameter "id".

unitId

Original identifier of the information provided by the repository.

unitTitle

Title of the information provided by the repository.

repositoryId

Internal APE identifier of the repository.

repository

Name of the repository.

content

Information in EAD-format, serialized as JSON. This part could potentially contain all the elements that can be part of an EAD/XML-document.