Difference between revisions of "contentEadClevel"

From Archives Portal Europe Wiki
Jump to: navigation, search
(Created page with "Request url: <code>https://api.archivesportaleurope.net/services/content/ead/clevel/{id}</code> This service is a GET-request. <div><br/>__TOC__<br/></div> = Request paramete...")
 
Line 1: Line 1:
 
Request url: <code>https://api.archivesportaleurope.net/services/content/ead/clevel/{id}</code>
 
Request url: <code>https://api.archivesportaleurope.net/services/content/ead/clevel/{id}</code>
 
 
This service is a GET-request.
 
This service is a GET-request.
 +
 +
This content-service delivers all information available of the description of an archival description identified with {id}. A web-developer can use this service to create a detailed presentation of a search result.
 +
 
<div><br/>__TOC__<br/></div>
 
<div><br/>__TOC__<br/></div>
 
= Request parameters =
 
= Request parameters =
Line 15: Line 17:
 
   "unitId": "2.05.313 - 2.77",
 
   "unitId": "2.05.313 - 2.77",
 
   "unitTitle": "Nepal",
 
   "unitTitle": "Nepal",
 +
  "fondsUnitTitle": "Inventaris van het code-archief van het Ministerie van Buitenlandse Zaken, 1965-1974",
 
   "repositoryId": 361,
 
   "repositoryId": 361,
 
   "repository": "Nationaal Archief",
 
   "repository": "Nationaal Archief",
Line 30: Line 33:
  
 
== unitTitle ==
 
== unitTitle ==
Title of the information provided by the repository.
+
Title of the information, provided by the repository.
 +
 
 +
== fondsUnitTitle ==
 +
Title of the finding aid, provided by the repository.
  
 
== repositoryId ==
 
== repositoryId ==

Revision as of 09:29, 1 November 2016

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

This content-service delivers all information available of the description of an archival description identified with {id}. A web-developer can use this service to create a detailed presentation of a search result.



Request parameters

id

Internal APE identifier of a Descriptive Unit (id is starting with "C"). In this service, if the identifier does not start with a "C", you will get an error message. This parameter is required.

Response parameters

{
  "id": "C4134966",
  "unitId": "2.05.313 - 2.77",
  "unitTitle": "Nepal",
  "fondsUnitTitle": "Inventaris van het code-archief van het Ministerie van Buitenlandse Zaken, 1965-1974",
  "repositoryId": 361,
  "repository": "Nationaal Archief",
  "content": {
   --- skip ---
  }
}

id

Internal APE identifier of the Descriptive Unit. 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.

fondsUnitTitle

Title of the finding aid, 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 a Component-element (<c>) of an EAD/XML-document.