searchEadDoclist

From Archives Portal Europe Wiki
Revision as of 14:14, 9 January 2018 by Admin (Talk | contribs) (→‎Basic Response example)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Request url: https://api.archivesportaleurope.net/services/search/ead/docList. This service is a POST-request.

This search-service delivers a list of finding aids (fa), holding guides (hg) or source guides (sg) that contain archival descriptions with the requested search term. The docList-service can be viewed as the resultlist of the search-service, where the results are grouped by fa, hg or sg. A web developer is able to filter results on various facets.



Request parameters

Several request parameters can be used to do a search in archival descriptions.

Empty Request example

{
  "count": "5",
  "startIndex": 0,
  "query": "*",
  "docType": "fa",
  "filters": [
    {
      "facetFieldName": "string",
      "facetFieldIds": [
        "string"
      ]
    }
  ],
  "dateFilters": [
    {
      "dateFieldName": "string",
      "dateFieldId": "string"
    }
  ]
}

Basic Request example

{
  "count": "5",
  "startIndex": 0,
  "query": "nepal",
  "docType": "fa",
  "filters": [
    {
      "facetFieldName": "country",
      "facetFieldIds": [
        "7"
      ]
    }
  ],
  "dateFilters": [
    {
      "dateFieldName": "fromDate",
      "dateFieldId": "1800-01-01_2"
    }
  ]
}

This example searches for finding aids ("fa") with the term "nepal" and filters on the facet "country" with id = 7 (identifier for "NETHERLANDS") and date-facet "fromDate" with id = "1800-01-01_2" (identifier for the period 1800-1999).

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.

query

Containing the search term(s). Required.

docType

Defining on which type of EAD document the search should be performed: finding aids ("fa"), holdings guide ("hg") or source guide ("sg").

filters

Request parameter "filters" enables you to filter the result on facets. The facets are summarised in searchEadDoclist#facets.

dateFilters

Request parameters "dateFilters" enables you to filter the result on a certain period of time. The dateFacets are summarised in searchEadDoclist#date_facets

Response parameters

The response contains a list of the finding aids where the requested search term(s) was/were found.

Empty Response example

{
  "totalResults": 0,
  "startIndex": 0,
  "totalPages": 0,
  "totalDocs": 0,
  "eadDocList": [
    {
      "id": "string",
      "findingAidTitle": "string",
      "numberOfResults": 0,
      "repository": "string",
      "country": "string",
      "language": "string",
      "repositoryCode": "string",
      "findingAidNo": "string",
      "unitDate": "string",
      "scopeContent": "string",
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0
    }
  ],
  "facetFields": {
    "country": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "subject": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "repository": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "docType": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "level": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "hasDigitalObject": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "digitalObjectType": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "unitDateType": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ]
  },
  "facetDateFields": {
    "fromDate": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "toDate": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ]
  }
}

Basic Response example

Response for the basic request example above: 

{
  "totalResults": 165,
  "startIndex": 0,
  "totalPages": 7,
  "totalDocs": 35,
  "eadDocList": [
    {
      "id": "F1212683",
      "findingAidTitle": "Nepal Nag Papers",
      "numberOfResults": 1,
      "repository": "Internationaal Instituut voor Sociale Geschiedenis",
      "country": "NETHERLANDS",
      "language": "",
      "repositoryCode": "NL-AmISG",
      "findingAidNo": "http://hdl.handle.net/10622/ARCH02359",
      "unitDate": "1960-1972, c. 2007",
      "scopeContent": "Content   Political diary by Nepal Nag, held during the international conference of 81 communist parties in Moscow in November 1960; letters from Nepal Nag to his wife Nibedita Nag, sent during his stay in the Soviet Union 1960-1962; letters from Moni Singh to Nepal and Nibedita Nag 1969-1970; letter from Anil Mukherjee to Nepal Nag 1972.  Accrual 2008: copy, annotated by Shahriar Kabir, of the manuscript of the memoirs of Nibedita Nag c. 2007. Accrual 2017: two typed letters on the occasion of the anniversary of Nibedita Nag, with a written translation in English, 2007.",
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0
    },
    {
      "id": "F1044678",
      "findingAidTitle": "Inventaris van het archief van de Nederlandse Ambassade in Nepal, 1965-1974",
      "numberOfResults": 21,
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "repositoryCode": "NL-HaNA",
      "findingAidNo": "2.05.213",
      "unitDate": "1965-1974",
      "scopeContent": "Het archief bevat stukken betreffende de Nederlandse diplomatieke vertegenwoordiging in Nepal over de jaren 1965-1974 en bevat o.a. stukken betreffende handel, luchtvaart, juridische en protocollaire aangelegenheden, staatkunde en internationale organisaties.",
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 52
    },
    {
      "id": "F998374",
      "findingAidTitle": "General Federation of Nepalese Trade Unions Collection",
      "numberOfResults": 1,
      "repository": "Internationaal Instituut voor Sociale Geschiedenis",
      "country": "NETHERLANDS",
      "language": "",
      "repositoryCode": "NL-AmISG",
      "findingAidNo": "http://hdl.handle.net/10622/COLL00099",
      "unitDate": "1989-2010",
      "scopeContent": "General Federation of Nepalese Trade Unions (GEFONT) was established on 20th July 1989. As there was no union right in Nepal, GEFONT was launched underground. GEFONT has 20 affiliates as of April, 2014. It is the largest trade union in Nepal and represents nearly 400,000 workers from all affiliates. GEFONT is one the founders of international trade union body- the International Trade Union Confederation (ITUC) established on November 2006. GEFONT affiliates are affiliated with various Global Union Federations (GUFs).  Content Documents on various trade unions affiliated to Gefont and their initiatives and actions to improve the labour circumstances of labourers 1990-2010. Contains Books, brochures, posters, textile and 19 DVDs and 1 CD-Rom.",
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 25
    },
    {
      "id": "F1120010",
      "findingAidTitle": "International Federation of Chemical, Energy, Mine and General Workers' Unions (ICEM) Archives",
      "numberOfResults": 1,
      "repository": "Internationaal Instituut voor Sociale Geschiedenis",
      "country": "NETHERLANDS",
      "language": "",
      "repositoryCode": "NL-AmISG",
      "findingAidNo": "http://hdl.handle.net/10622/ARCH02742",
      "unitDate": "1995-2003, 2007",
      "scopeContent": "Content   Minutes of meetings of the Executive Committee and the Presidium 1996-2002; documents relating to congresses, conferences and other meetings of the ICEM 1995-2003; incoming mail 1995-1999 and copies of outgoing mail 1995-1999; documents concerning collective- and sector agreements, regional work, networks, various companies; reports and other documentation.  Documents on the Fourth ICEM World Congress in Bangkok, Thailand, 22-24 November 2007, collected by Manju Thapa, delegate from the NICIWU in Nepal.",
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0
    },
    {
      "id": "F1202916",
      "findingAidTitle": "Collection on Asian regional issues and organizations",
      "numberOfResults": 1,
      "repository": "Internationaal Instituut voor Sociale Geschiedenis",
      "country": "NETHERLANDS",
      "language": "",
      "repositoryCode": "NL-AmISG",
      "findingAidNo": "http://hdl.handle.net/10622/COLL00110",
      "unitDate": "1991-2006, 2009, 2011, 2013-2014",
      "scopeContent": "Collection of documents on Asian regional issues and organizations  Content Collection of documents on Asian regional organisations, conferences, seminars, and different regional topics (labour, peace etc.)",
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 61
    }
  ],
  "facetFields": {
    "country": [
      {
        "id": "7",
        "name": "NETHERLANDS",
        "frequency": 165
      },
      {
        "id": "3",
        "name": "GERMANY",
        "frequency": 60
      }
    ],
    "subject": [],
    "repository": [
      {
        "id": "2437",
        "name": "Nationaal Archief",
        "frequency": 156
      },
      {
        "id": "2091",
        "name": "Internationaal Instituut voor Sociale Geschiedenis",
        "frequency": 8
      },
      {
        "id": "373",
        "name": "Erfgoed Leiden en omstreken",
        "frequency": 1
      }
    ],
    "docType": [
      {
        "id": "fa",
        "name": "fa",
        "frequency": 165
      }
    ],
    "level": [
      {
        "id": "clevel",
        "name": "clevel",
        "frequency": 152
      },
      {
        "id": "archdesc",
        "name": "archdesc",
        "frequency": 13
      }
    ],
    "hasDigitalObject": [
      {
        "id": "false",
        "name": "false",
        "frequency": 165
      }
    ],
    "digitalObjectType": [],
    "unitDateType": [
      {
        "id": "normal",
        "name": "normal",
        "frequency": 165
      }
    ]
  },
  "facetDateFields": {
    "fromDate": [
      {
        "id": "1920-01-01_3",
        "name": "1920-1939",
        "frequency": 4
      },
      {
        "id": "1940-01-01_3",
        "name": "1940-1959",
        "frequency": 64
      },
      {
        "id": "1960-01-01_3",
        "name": "1960-1979",
        "frequency": 86
      },
      {
        "id": "1980-01-01_3",
        "name": "1980-1999",
        "frequency": 11
      }
    ],
    "toDate": [
      {
        "id": "1800-01-01_2",
        "name": "1800-1999",
        "frequency": 158
      },
      {
        "id": "2000-01-01_2",
        "name": "2000-2199",
        "frequency": 7
      }
    ]
  }
}

totalResults

The response parameter "totalResults" gives the number of results in Descriptive Units. The totalDocs gives the number of findings aids, holding guides or source guides in which the search term was found.

startIndex

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

totalPages

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

totalDocs

The response parameter totalDocs gives the number of findings aids, holding guides or source guides in which the search term was found.

eadDocList

Enumeration of the results. All response parameters are optional, except for "id".

id Internal APE identifier of the result
findingAidTitle Title of the finding aid.
numberOfResults Number of clevels of this finding aid, holdings guide or source guide containing the search term
repository Name of the repository holding the fonds
country Name of the country where the repository is, in English
language Language of the description of the result
repositoryCode Code of the repository holding the fonds; preferably, but not necessarily ISIL
findingAidNo Identifier of the fonds provided by the repository
unitDate Date of creation of the result
scopeContent More descriptive information about the 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

facetFields

This response parameter gives an enumeration of facets. Every facet has three variables.

id Internal APE identifier of the value; use this "id" in the filter request parameter
name Human readable value (in English)
frequency The number of results of this facet containing the search term

facets

country Name of the country where the repository is, in English
subject Subject that is added to the archival description
repository Name of the repository holding the fonds
docType Type of archives describing document where the result is found: "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
hasDigitalObject TRUE/FALSE
digitalObjectType Type of the Object: most of the time: IMAGE
unitDateType Type of date describing the archival unit

date facets

With the date facets you can zoom in on the period of time. Results are grouped in periods of two centuries in the first step. If you use these groupings in the request-parameter dateFilter, you'll have new dateFacets that groups the results into groups of two decades.

fromDate Grouping of the search result in starting dates
toDate Grouping of the search result in ending dates
Retrieved from "https://wiki-deprecated.archivesportaleurope.net/index.php?title=searchEadDoclist&oldid=1780"