edan_ead_search: EAD Search

View source: R/edan_ead_search.R

edan_ead_searchR Documentation

EAD Search

Description

Returns structured data rows relating to ead type of content.

Usage

edan_ead_search(
  query = NA,
  fqs = NA,
  AppID = NA,
  AppKey = NA,
  rows = 10,
  start = 0,
  returnjson = FALSE
)

Arguments

query

The search term. Default value: *:*

fqs

A JSON array of filter query params.

AppID

AppID used for authentication

AppKey

Key for the AppID used for authentication

rows

Number of rows to return, max is 100.

start

Start number, to use with rows

returnjson

Boolean to return the answer as JSON, otherwise as a list.

Details

All queries require valid EDAN credentials (AppID and AppKey). Consult the EDAN Docs (https://edandoc.si.edu/) for instructions on how to obtain a set of credentials.

Value

List or JSON with the results.


Smithsonian/EDANr documentation built on Dec. 11, 2023, 2:18 a.m.