Difference between revisions of "getDocs"

From Archives Portal Europe Wiki
Jump to: navigation, search
Line 2: Line 2:
 
This service is a POST-request.
 
This service is a POST-request.
  
−
This institute service delivers a list of Finding Aids, Holding Guide and Source Guides provided through the API. Remember that this only contains document of institutes that have enabled Open Data in the APE Dashboard.  
+
This institute service delivers a list of Finding Aids, Holding Guides and Source Guides provided through the API. Remember that this only contains document of institutes that have enabled Open Data in the APE Dashboard.  
  
 
<div><br/>__TOC__<br/></div>
 
<div><br/>__TOC__<br/></div>
 
= Request parameters =
 
= Request parameters =
−
eg.
+
Four request parameters can be used to get a list of the documents of an archival institution that has enabled the API services for its datasets in the Archives Portal Europe's Dashboard.
 +
 
 +
Empty Request example:
 +
<pre>
 +
{
 +
  "count": "5",
 +
  "startIndex": 0,
 +
  "instituteId": "string",
 +
  "docType": "string"
 +
}
 +
</pre>
 +
 
 +
Basic Request example (for 5 documents, ie finding aids (fa), of the Nationaal Archief, ie with as internal APE identifier 32171):
 
<pre>
 
<pre>
 
{
 
{
−
   "count": 0,
+
   "count": "5",
 
   "startIndex": 0,
 
   "startIndex": 0,
−
   "instituteId": "361",
+
   "instituteId": "32171",
 
   "docType": "fa"
 
   "docType": "fa"
 
}
 
}
Line 23: Line 35:
  
 
== instituteId ==
 
== instituteId ==
−
APE-identifier for the repository from which you want to get the list of documents. Required.
+
Internal APE identifier for the archival institution (repository) from which you want to get the list of documents (required)
  
 
== docType ==
 
== docType ==
−
 
+
Depending on which type of archival description you want, use "fa" for finding aids, "hg" for holdings guides or "sg" for source guides (required)
−
Depending on which type of archival description you want, use "fa" for finding aid, "hg" for holdingsguide or "sg" for sourceguide. Required.
+
 
<br/><br/>
 
<br/><br/>
 +
 
= Response parameters =
 
= Response parameters =
  
−
eg.
+
The response contains basic information on the documents of the archival institution for which the list of documents was requested.
 +
 
 +
Empty Response example:
 
<pre>
 
<pre>
 
{
 
{
−
   "totalResults": 6714,
+
   "totalResults": 0,
 
   "startIndex": 0,
 
   "startIndex": 0,
−
   "totalPages": 1343,
+
   "totalPages": 0,
 
   "eadResults": [
 
   "eadResults": [
 
     {
 
     {
−
       "id": "F11649",
+
       "id": "string",
−
       "fondsUnitTitle": "Inventaris van de Burgerlijke Stand der gemeente Sommelsdijk",
+
      "fondsUnitTitle": "string",
−
       "fondsUnitId": "3.198.07",
+
      "fondsUnitId": "string",
 +
      "repository": "string",
 +
      "country": "string",
 +
      "language": "string",
 +
      "langMaterial": "string",
 +
      "unitDate": "string",
 +
      "repositoryCode": "string",
 +
      "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 0,
 +
      "numberOfDescendents": 0,
 +
      "docType": "string",
 +
      "docTypeId": "string",
 +
      "level": "string",
 +
      "indexDate": "string"
 +
    }
 +
  ]
 +
}
 +
</pre>
 +
 
 +
Basic Response example (for 5 documents, ie finding aids (fa), of the Nationaal Archief, ie with as internal APE identifier 32171): 
 +
<pre>
 +
{
 +
  "totalResults": 6754,
 +
  "startIndex": 0,
 +
  "totalPages": 3,
 +
  "eadResults": [
 +
    {
 +
      "id": "F379214",
 +
       "fondsUnitTitle": "Inventaris van het archief van de Verenigde Oost-Indische Compagnie (VOC), 1602-1795 (1811)",
 +
       "fondsUnitId": "1.04.02",
 
       "repository": "Nationaal Archief",
 
       "repository": "Nationaal Archief",
 
       "country": "NETHERLANDS",
 
       "country": "NETHERLANDS",
 
       "language": "",
 
       "language": "",
 
       "langMaterial": "",
 
       "langMaterial": "",
−
       "unitDate": "1812-1932",
+
       "unitDate": "1602-1811",
 
       "repositoryCode": "NL-HaNA",
 
       "repositoryCode": "NL-HaNA",
 
       "hasDigitalObject": false,
 
       "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 4349944,
 +
      "numberOfDescendents": 17243,
 
       "docType": "Finding Aid",
 
       "docType": "Finding Aid",
 
       "docTypeId": "fa",
 
       "docTypeId": "fa",
 
       "level": "archdesc",
 
       "level": "archdesc",
−
       "indexDate": "Sun Dec 13 16:07:22 UTC 2015"
+
       "indexDate": ""
 +
    },
 +
    {
 +
      "id": "F379212",
 +
      "fondsUnitTitle": "Inventaris van het archief van de Koninklijke Nederlandse Voetbalbond (KNVB), 1889-1996 (1997)",
 +
      "fondsUnitId": "2.19.123",
 +
      "repository": "Nationaal Archief",
 +
      "country": "NETHERLANDS",
 +
      "language": "",
 +
      "langMaterial": "",
 +
      "unitDate": "1889-1997",
 +
      "repositoryCode": "NL-HaNA",
 +
      "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 21215,
 +
      "numberOfDescendents": 5662,
 +
      "docType": "Finding Aid",
 +
      "docTypeId": "fa",
 +
      "level": "archdesc",
 +
      "indexDate": ""
 +
    },
 +
    {
 +
      "id": "F379209",
 +
      "fondsUnitTitle": "Inventaris van de collectie Aanwinsten Kaarten en Tekeningen sinds 1888",
 +
      "fondsUnitId": "4.AANW",
 +
      "repository": "Nationaal Archief",
 +
      "country": "NETHERLANDS",
 +
      "language": "",
 +
      "langMaterial": "",
 +
      "unitDate": "1888-1990",
 +
      "repositoryCode": "NL-HaNA",
 +
      "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 72,
 +
      "numberOfDescendents": 3796,
 +
      "docType": "Finding Aid",
 +
      "docTypeId": "fa",
 +
      "level": "archdesc",
 +
      "indexDate": ""
 +
    },
 +
    {
 +
      "id": "F379208",
 +
      "fondsUnitTitle": "Inventaris van de archieven van de Nederlandse Factorij in Japan te Hirado [1609-1641] en te Deshima, [1641-1860], 1609-1860",
 +
      "fondsUnitId": "1.04.21",
 +
      "repository": "Nationaal Archief",
 +
      "country": "NETHERLANDS",
 +
      "language": "",
 +
      "langMaterial": "",
 +
      "unitDate": "1609-1860",
 +
      "repositoryCode": "NL-HaNA",
 +
      "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 1323,
 +
      "numberOfDescendents": 2369,
 +
      "docType": "Finding Aid",
 +
      "docTypeId": "fa",
 +
      "level": "archdesc",
 +
      "indexDate": ""
 +
    },
 +
    {
 +
      "id": "F379215",
 +
      "fondsUnitTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
 +
      "fondsUnitId": "2.19.225",
 +
      "repository": "Nationaal Archief",
 +
      "country": "NETHERLANDS",
 +
      "language": "",
 +
      "langMaterial": "",
 +
      "unitDate": "1914-2011",
 +
      "repositoryCode": "NL-HaNA",
 +
      "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 0,
 +
      "numberOfDescendents": 6063,
 +
      "docType": "Finding Aid",
 +
      "docTypeId": "fa",
 +
      "level": "archdesc",
 +
      "indexDate": ""
 
     }
 
     }
 
   ]
 
   ]
Line 70: Line 193:
 
Enumeration of the results. Depending on the value of Request parameter 'docType', result could be a holdings guide, a source guide or a finding aid.
 
Enumeration of the results. Depending on the value of Request parameter 'docType', result could be a holdings guide, a source guide or a finding aid.
  
−
(table)
+
{| class="wikitable"
 +
| id
 +
| Internal APE identifier of the result
 +
|-
 +
| fondsUnitTitle
 +
| Title of the document (finding aid, holdings guide or source guide)
 +
|-
 +
| fondsUnitId
 +
| Identifier of the finding aid, holdings guide or source guide provided by the archival institution (repository)
 +
|-
 +
| repository
 +
| Name of the repository (archival institution) holding the material that is described in the document (finding aid, holdings guide or source guide)
 +
|-
 +
| country
 +
| Name of the country where the repository is. In English
 +
|-
 +
| language
 +
| Language of the description of the document (finding aid, holdings guide or source guide)
 +
|-
 +
| langMaterial
 +
| Language in which the archival material described in the document (finding aid, holdings guide or source guide) is created
 +
|-
 +
| unitDate
 +
| Date of creation of the archival material described in the document (finding aid, holdings guide or source guide)
 +
|-
 +
| repositoryCode
 +
| Code of the repository holding the fonds. Preferably, but not necessarily [https://en.wikipedia.org/wiki/International_Standard_Identifier_for_Libraries_and_Related_Organizations ISIL]
 +
|-
 +
| hasDigitalObject
 +
| TRUE/FALSE (only for the search result)
 +
|-
 +
| numberOfDigitalObjects
 +
| Amount of digital objects available for the search result (is always 0 in case 'hasDigitalObject' = FALSE)
 +
|-
 +
| numberOfDigitalOjectsInDescendents
 +
| Amount of digital objects available for descendents of the search result (can be > 0 in case 'hasDigtalObject' = FALSE)
 +
|-
 +
| numberOfDescendents
 +
| Amount of descendents of the search result, ie amount of descriptive units in the document (finding aid, holdings guide or source guide)
 +
|-
 +
| docType
 +
| Type of document: "Finding Aid", "Holdings Guide", "Source Guide"
 +
|-
 +
| docTypeId
 +
| Acronym for the type of document ("fa" for "Finding Aid", "hg" for "Holdings Guide" or "sg" for "Source Guide")
 +
|-
 +
| level
 +
| Type of result: "archdesc" for highest level description or "clevel" for subordinate components (in this service it will always be: "archdesc")
 +
|-
 +
| indexDate
 +
| Date showing when the result was ingested/updated and indexed in the Archives Portal Europe (ie last change date)
 +
|}
 +
 
  
 
[[Category:Technical_documentation]]
 
[[Category:Technical_documentation]]

Revision as of 12:43, 5 June 2017

Request url: https://api.archivesportaleurope.net/services/institute/getDocs. This service is a POST-request.

This institute service delivers a list of Finding Aids, Holding Guides and Source Guides provided through the API. Remember that this only contains document of institutes that have enabled Open Data in the APE Dashboard.



Request parameters

Four request parameters can be used to get a list of the documents of an archival institution that has enabled the API services for its datasets in the Archives Portal Europe's Dashboard.

Empty Request example: 

{
  "count": "5",
  "startIndex": 0,
  "instituteId": "string",
  "docType": "string"
}

Basic Request example (for 5 documents, ie finding aids (fa), of the Nationaal Archief, ie with as internal APE identifier 32171): 

{
  "count": "5",
  "startIndex": 0,
  "instituteId": "32171",
  "docType": "fa"
}

count

The resultlist is delivered in chunks of a certain size. Request parameter "count" describes the number of results that are in one chunk. Optional. Default value is 5.

startIndex

Request parameter "startIndex" enables you to select the results that you want to have. Counting starts at zero. If "count" = 5, the second chunk starts with startIndex 5, the following at startIndex 10, etc. Optional. Default value is 0.

instituteId

Internal APE identifier for the archival institution (repository) from which you want to get the list of documents (required)

docType

Depending on which type of archival description you want, use "fa" for finding aids, "hg" for holdings guides or "sg" for source guides (required)

Response parameters

The response contains basic information on the documents of the archival institution for which the list of documents was requested.

Empty Response example: 

{
  "totalResults": 0,
  "startIndex": 0,
  "totalPages": 0,
  "eadResults": [
    {
      "id": "string",
      "fondsUnitTitle": "string",
      "fondsUnitId": "string",
      "repository": "string",
      "country": "string",
      "language": "string",
      "langMaterial": "string",
      "unitDate": "string",
      "repositoryCode": "string",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "string",
      "docTypeId": "string",
      "level": "string",
      "indexDate": "string"
    }
  ]
}

Basic Response example (for 5 documents, ie finding aids (fa), of the Nationaal Archief, ie with as internal APE identifier 32171): 

{
  "totalResults": 6754,
  "startIndex": 0,
  "totalPages": 3,
  "eadResults": [
    {
      "id": "F379214",
      "fondsUnitTitle": "Inventaris van het archief van de Verenigde Oost-Indische Compagnie (VOC), 1602-1795 (1811)",
      "fondsUnitId": "1.04.02",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1602-1811",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 4349944,
      "numberOfDescendents": 17243,
      "docType": "Finding Aid",
      "docTypeId": "fa",
      "level": "archdesc",
      "indexDate": ""
    },
    {
      "id": "F379212",
      "fondsUnitTitle": "Inventaris van het archief van de Koninklijke Nederlandse Voetbalbond (KNVB), 1889-1996 (1997)",
      "fondsUnitId": "2.19.123",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1889-1997",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 21215,
      "numberOfDescendents": 5662,
      "docType": "Finding Aid",
      "docTypeId": "fa",
      "level": "archdesc",
      "indexDate": ""
    },
    {
      "id": "F379209",
      "fondsUnitTitle": "Inventaris van de collectie Aanwinsten Kaarten en Tekeningen sinds 1888",
      "fondsUnitId": "4.AANW",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1888-1990",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 72,
      "numberOfDescendents": 3796,
      "docType": "Finding Aid",
      "docTypeId": "fa",
      "level": "archdesc",
      "indexDate": ""
    },
    {
      "id": "F379208",
      "fondsUnitTitle": "Inventaris van de archieven van de Nederlandse Factorij in Japan te Hirado [1609-1641] en te Deshima, [1641-1860], 1609-1860",
      "fondsUnitId": "1.04.21",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1609-1860",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 1323,
      "numberOfDescendents": 2369,
      "docType": "Finding Aid",
      "docTypeId": "fa",
      "level": "archdesc",
      "indexDate": ""
    },
    {
      "id": "F379215",
      "fondsUnitTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
      "fondsUnitId": "2.19.225",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1914-2011",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 6063,
      "docType": "Finding Aid",
      "docTypeId": "fa",
      "level": "archdesc",
      "indexDate": ""
    }
  ]
}

totalResults

The response parameter "totalResults" gives the number of results.

startIndex

The response parameter "startIndex" gives the number of the chunk you requested.

totalPages

The response parameter "totalPages" gives the number of chunks.

eadResults

Enumeration of the results. Depending on the value of Request parameter 'docType', result could be a holdings guide, a source guide or a finding aid.

id Internal APE identifier of the result
fondsUnitTitle Title of the document (finding aid, holdings guide or source guide)
fondsUnitId Identifier of the finding aid, holdings guide or source guide provided by the archival institution (repository)
repository Name of the repository (archival institution) holding the material that is described in the document (finding aid, holdings guide or source guide)
country Name of the country where the repository is. In English
language Language of the description of the document (finding aid, holdings guide or source guide)
langMaterial Language in which the archival material described in the document (finding aid, holdings guide or source guide) is created
unitDate Date of creation of the archival material described in the document (finding aid, holdings guide or source guide)
repositoryCode Code of the repository holding the fonds. Preferably, but not necessarily ISIL
hasDigitalObject TRUE/FALSE (only for the search result)
numberOfDigitalObjects Amount of digital objects available for the search result (is always 0 in case 'hasDigitalObject' = FALSE)
numberOfDigitalOjectsInDescendents Amount of digital objects available for descendents of the search result (can be > 0 in case 'hasDigtalObject' = FALSE)
numberOfDescendents Amount of descendents of the search result, ie amount of descriptive units in the document (finding aid, holdings guide or source guide)
docType Type of document: "Finding Aid", "Holdings Guide", "Source Guide"
docTypeId Acronym for the type of document ("fa" for "Finding Aid", "hg" for "Holdings Guide" or "sg" for "Source Guide")
level Type of result: "archdesc" for highest level description or "clevel" for subordinate components (in this service it will always be: "archdesc")
indexDate Date showing when the result was ingested/updated and indexed in the Archives Portal Europe (ie last change date)
Retrieved from "http://wiki-deprecated.archivesportaleurope.net/index.php?title=getDocs&oldid=1619"