Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 110 Next »

           

On this page:

The LibraryCloud Item API provides access to metadata about items in the Harvard Library collections. For the purposes of this API, an “item” is the metadata describing a catalog record within the Harvard Library. LibraryCloud Item API searches over 20,000,000 aggregated metadata records. Records are sourced from Harvard Library's main catalog (Alma), JSTOR Forum (for visual information components), and ArchivesSpace (for archival finding aid components). 

Base URI

https://api.lib.harvard.edu/v2/items

Simple Query

The simplest query to the API includes only a search term:
https://api.lib.harvard.edu/v2/items?q=peanuts
The response will include all items where any field contains the text “peanuts”, as XML

Multiple terms may be used in a simple query:
https://api.lib.harvard.edu/v2/items?q=Schulz peanuts
https://api.lib.harvard.edu/v2/items?q=Schulz+peanuts
https://api.lib.harvard.edu/v2/items?q=Schulz AND peanuts
All the above queries will return items where any field contains the text “Schulz” AND “peanuts”.

https://api.lib.harvard.edu/v2/items.json?q=Schulz OR peanuts
The response will include all items where any field contains the text “Schulz” OR “peanuts”, as JSON.

 https://api.lib.harvard.edu/v2/items?q=Schulz NOT peanuts
The response will include all item where any field contains the text "Schulz" but NOT "peanuts".

Simple Response

The response to any query contains the total number of matching records, the number of records included within this response, the page number of this response, and the matching records. 

Sample XML Response:
https://api.lib.harvard.edu/v2/items?q=peanuts

Searching by Field

See the Field Reference for a list of field-based queries.

A query can be limited to a particular field:
https://api.lib.harvard.edu/v2/items?title=peanuts
This query returns all items with the text “peanuts” in the title field.

Query terms can be combined:
https://api.lib.harvard.edu/v2/items?title=peanuts&q=snack
This query returns all items with the text “peanuts” in the title field and “snack” anywhere in the record. There is currently no equivalent syntax to express "OR" or "NOT" with fielded query terms.

https://api.lib.harvard.edu/v2/items?title=peanuts&name=Schulz
This query returns all items with the text “peanuts” in the title field and “Shulz” in the name field.

Case-sensitive exact-match queries can be done on specific fields by appending _exact to the field name:
https://api.lib.harvard.edu/v2/items?title_exact=Peanuts
This query returns all items with a title of exactly “Peanuts”. In the Field Reference list, the Exact Match Search column indicates if a field supports an exact match query. 

Accented Characters and Punctuation

If your query terms contain accented characters, include these in the search:
https://api.lib.harvard.edu/v2/items?name=Saint-Exupéry, Antoine de
https://api.lib.harvard.edu/v2/items?name=Molière

If your query includes an ampersand, the ampersand must be replaced by the URL-encoded equivalent (%26). For example, to search the title Saxo Grammaticus & the life of Hamlet:
https://api.lib.harvard.edu/v2/items?title_exact=Saxo+Grammaticus+%26+the+life+of+Hamlet 

At this time, LibraryCloud queries can be sensitive to the presence of punctuation. Some MODS fields (e.g. Genre) include supplied punctuation (e.g., a terminal period or comma) that must be included in the query or it will fail. 

Stemming, Stopwords and Wildcards

LibraryCloud uses standard Solr index stemming and stopword lists. The stemming algorithm is based on the Porter stemming algorithm.

Keywords may be wild-carded with an asterisk:
https://api.lib.harvard.edu/v2/items?title=peanut*
https://api.lib.harvard.edu/v2/items?title=p*nut

Paging

By default, each response will include the first 10 records available. A query can request more records in a response (up to 250), and page through the results.
https://api.lib.harvard.edu/v2/items?title=peanuts?start=100&limit=50
Return the results for the query starting at item 100, with a page size of 50 (e.g. records 100 through 149).

ParameterDescription
start

The row number to start returning results from. If omitted, will default to 1.

limitThe number of results to return. Default is 10. May be between 0 and 250.

Sorting

Responses can sorted in ascending or descending order. See the Field Reference for a list of sortable fields.
https://api.lib.harvard.edu/v2/items?title=peanuts&sort.asc=resourceType
Sort results by the “resourceType” field, in ascending order.

ParameterDescription
sort.asc OR sort

The field to use for sorting, in ascending order

sort.descThe field to use for sorting, in descending order

Facets

Many fields are available for faceting (see the Field Reference "Can Facet" column for details).
https://api.lib.harvard.edu/v2/items.json?title=peanuts&facets=name,resourceType
Facet search results by the “name” and “resourceType” fields

ParameterDescription
facets

A comma-separated list of facets to return

facet_sizeThe maximum number of facets to be returned for each faceted field. Default is 10. May be between 1 and 100.

Response Format

By default, all responses are in MODS format. Dublin Core (DC) can be requested by adding .dc to the base URI
https://api.lib.harvard.edu/v2/items.dc?title=peanuts

Response Serialization

By default, all responses are returned as XML. Responses can be returned as JSON either by adding “.json” to the base URI, or by setting the “Accept” HTTP header in the request to “application/json”. When specifying both the response format and serialization, the format should be added first.
https://api.lib.harvard.edu/v2/items.json?title=peanuts
https://api.lib.harvard.edu/v2/items.dc.json?title=peanuts

Cross-domain queries

The API sets the necessary CORS header to allow cross-domain requests in supported browsers. Cross-domain queries can also use JSONP by specifying a callback function name in a “callback” parameter.
https://api.lib.harvard.edu/v2/items.json?title=peanuts&callback=myfunction

ParameterDescription
calback

Javascript function name. The response data will enclosed in a javascript function call with this name.

 

API Versioning

The version number of the API is specified in the base URL (e.g. “v2”). A version number is always required when accessing the API. The version number will be incremented whenever breaking (non backwards-compatible) changes are made to the API.

Field Reference

This section describes the fields available for searching through the API. In some cases, fields available through the API aggregate multiple fields with the MODS records. When applicable, this is identified in the MODS field mapping column.

Yes
NameOn LC Solr field list?Keyword SearchExact Match SearchCan SortCan FacetMODS Field MappingNotes

title

Y

Yes

Yes

No

No

titleInfo.title
titleInfo.subTitle
titleInfo.partNumber
titleInfo.partName

https://api.lib.harvard.edu/v2/items?title=complete motown singles

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?title_exact=Labour Party

name

Y

Yes

Not available 

No

Yes

name.namePart

e.g. "Greenblatt, Stephen"

Will find term in any name field:
https://api.lib.harvard.edu/v2/items?name=shakespeare

?Search by name_exact returns 0 for known items:
https://api.lib.harvard.edu/v2/items?name_exact=keller, helen

role

Y

Yes

Yes?

No

Yes

name.namePart.role.roleTerm

https://api.lib.harvard.edu/v2/items?name=shakespeare&role=publisher

resourceType

GETTING FALSE POSITIVES

Y

Yes

Yes?

No

Yes

typeOfResource

https://api.lib.harvard.edu/v2/items?name=shakespeare&resourceType=three dimensional object

isCollection
(Values are “true” or “false”)

GETTING FALSE POSITIVES

Y

No

Yes?

No

Yes

typeOfResource (where collection="yes")

Indicates whether or not a record describes a collection of items.

 https://api.lib.harvard.edu/v2/items?q=colonial+north+america&isCollection=true 

isManuscript
(Values are “true” or “false”)

GETTING FALSE POSITIVES

Y

No

Yes?

No

Yes

typeOfResource (where manuscript="yes")

Indicates whether or not a record describes manuscript or archival material.

https://api.lib.harvard.edu/v2/items?q=colonial+north+america&isManuscript=true

genre

Y

Yes

Yes

No

Yes

genre

https://api.lib.harvard.edu/v2/items?q=fish+watercolor&genre=Drawings

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?genre_exact=pendants (jewelry)

originPlace

Y

Yes

Yes

No

Yes

originInfo.place.placeTerm

https://api.lib.harvard.edu/v2/items?q=colonial+north+america&originPlace=Boston

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?originPlace_exact=New-England

publisher

Y

Yes

Yes

No

Yes

originInfo.publisher

https://api.lib.harvard.edu/v2/items?q=shakespeare&publisher=Arden

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?q=shakespeare&publisher_exact=Arden Shakespeare

originDate

Y

Yes

Yes

No

Yes

originInfo.dateIssued
originInfo.dateCreated
originInfo.dateCaptured
originInfo.copyrightDate
originInfo.dateOther

https://api.lib.harvard.edu/v2/items?name=asimov+isaac&originDate=1961

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?name=asimov+isaac&originDate_exact=[1961]

dateIssued

Y

Yes

Yes

Yes

Yes

originInfo.dateIssued

https://api.lib.harvard.edu/v2/items?name=asimov%20isaac&dateIssued=1961

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?name=asimov%20isaac&dateIssued_exact=[1961]

dateCreated

Y

Yes

Yes

Yes

Yes

originInfo.dateCreated

https://api.lib.harvard.edu/v2/items?q=daguerreotypes&dateCreated=1806

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?dateCreated_exact=late 18th-early 19th century

dateCaptured

Y

Yes

Yes

Yes

Yes

originInfo.dateCaptured

https://api.lib.harvard.edu/v2/items?dateCaptured=2016&genre=performed+music

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?dateCaptured_exact=201502--

copyrightDate

Y

Yes

Yes

Yes

Yes

originInfo.copyrightDate

Use YYYY format to search.

https://api.lib.harvard.edu/v2/items?copyrightDate=2010

dates.startY item api code does start/end processingYesNoNoNo

originInfo.dateIssued
originInfo.dateCreated

This query returns all works by Molière published from 1990 forward:
https://api.lib.harvard.edu/v2/items?name=Molière&dates.start=1990

This query returns all works by Molière published from 1990 backward:
https://api.lib.harvard.edu/v2/items?name=Molière&dates.end=1990

This query returns all works by Molière published from 1990 to 2000:
https://api.lib.harvard.edu/v2/items?name=Molière&dates.start=1990&dates.end=2000

dates.end
dateRange (future)       

edition

Y

Yes

Yes

Yes

Yes

originInfo.edition

 https://api.lib.harvard.edu/v2/items?name=Molière&edition=7th. ed.

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?name=wordsworth&edition_exact=[1st ed.]

issuance

Y

Yes

Yes

Yes

Yes

originInfo.issuance

This query returns items with subject "astronomy" issued as a serial:
https://api.lib.harvard.edu/v2/items?subject=astronomy&issuance=serial

languageCode
(Searches based on language ISO code)

Y

No

Yes

No

Yes

language.languageTerm (where languageTerm type="code")

This query returns items of Shakespeare in Chinese:
https://api.lib.harvard.edu/v2/items?name=shakespeare&languageCode=chi

languageText
(Searches based on language name text)

Y

Yes

Yes

No

Yes

language.languageTerm (where languageTerm type="text")

facet as "language" rather than "languageText"

This query returns itemsby or about Laozi in Chinese:
https://api.lib.harvard.edu/v2/items?title=laozi&language=Chinese

physicalDescription

Y  

No

No

physicalDescription.form
physicalDescription.note

NOT WORKING (In mods2solr.xsl, in the mods:mods template, entry for physicalDescription field is commented out)
https://api.lib.harvard.edu/v2/items?title=peanut&physicalDescription=print

abstractTOC

Y

Yes

No

No

No

abstract
tableOfContents

This query returns items with the keyword "justinian" in an abstract or table of contents field:
https://api.lib.harvard.edu/v2/items?abstractTOC=Justinian

classification
(Physical organization code. Includes bibliographic-level classification but not holdings. See LibraryCloud Item API for holdings-level classification.)

Y

No

Yes

Yes

Yes

classification

 

https://api.lib.harvard.edu/v2/items?classification=F1435.3

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?classification_exact=PR2825.A2 I8

identifier

(Identifier of an item in another system)

Y

No

Yes

Yes

No

identifier

This query returns an item by it's ISBN:
https://api.lib.harvard.edu/v2/items?identifier=9789601426440

seriesTitleY item api code does the translation from seriesTitleYesYes?NoYes

In relatedItem[@type='series']:

titleInfo.title
titleInfo.subtitle
titleInfo.partName
titleInfo.partNumber

facet as "relatedItem" rather than "seriesTitle"

https://api.lib.harvard.edu/v2/items?seriesTitle=Harvard-Yenching Institute Monograph Series

subject

Y

Yes

Yes?

No

Yes?

subject.topic
subject.geographic
subject.temporal
subject.titleInfo
subject.name
subject.genre
subject.hierarchicalGeographic.continent
subject.hierarchicalGeographic.country
subject.hierarchicalGeographic.province
subject.hierarchicalGeographic.region
subject.hierarchicalGeographic.state
subject.hierarchicalGeographic.territory
subject.hierarchicalGeographic.county
subject.hierarchicalGeographic.city
subject.hierarchicalGeographic.island
subject.hierarchicalGeographic.area
subject.hierarchicalGeographic.extraterrestrialArea
subject.hierarchicalGeographic.citySection

https://api.lib.harvard.edu/v2/items?subject=perseus

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?subject_exact=cylinder seals

Notes:

  • An exact query will not match on a subject plus its subdivision because this metadata is fielded separately in LibCloud. E.g.: the subject heading "Older people -- Services for" appears in the LibCloud MODS record as:

    <mods:topic>Older people</mods:topic>
    <mods:topic>Services for</mods:topic>

  • Faceting or an _exact query on MODS subject.name and subject.titleinfo does not currently work.

subject.topic

Y

Yes

Yes

No

Yes

subject.topic

 https://api.lib.harvard.edu/v2/items?subject.topic=Mochica pottery

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?subject.topic_exact=Mochica pottery

subject.temporal

Y

Yes

Yes

No

Yes

subject.temporal

https://api.lib.harvard.edu/v2/items?q=samurai&subject.temporal=edo

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?q=samurai&subject.temporal_exact=Edo period, 1600-1868

subject.titleInfo

Y

Yes

Yes

No

Yes

subject.titleInfo.title
subject.titleInfo.subTitle
subject.titleInfo.partNumber
subject.titleInfo.partName

https://api.lib.harvard.edu/v2/items?subject.titleInfo=Middlemarch

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?subject.titleInfo_exact=Gospel%20of%20Mary

subject.name

Y

Yes

Yes

No

Yes

subject.name
subject.name.namePart

https://api.lib.harvard.edu/v2/items?subject.name=kubrick stanley

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?subject.name=Kubrick,%20Stanley

subject.name.role

Y

Yes?

Yes

No

Yes

subject.name.role.roleTerm

https://api.lib.harvard.edu/v2/items?subject.name.role=cmp

?Most role terms in this MODS path are terminated with a period (e.g. photographer.). Need to include punctuation or query will fail:
https://api.lib.harvard.edu/v2/items?subject.name.role=photographer.

OTOH, subject.genre also has terminal periods on terms but the solr query works with or without:
https://api.lib.harvard.edu/v2/items?subject.genre=Folklore.

subject.genre

Y

Yes

Yes?

No

Yes

subject.genre

https://api.lib.harvard.edu/v2/items?subject.genre=folklore

?Case-sensitive exact match DOESN"T WORK:
https://api.lib.harvard.edu/v2/items?subject.genre_exact=Folklore.

subject.geographic

Y

Yes

Yes

No

Yes

subject.geographic

https://api.lib.harvard.edu/v2/items?subject.geographic=giza

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?subject.geographic_exact=Giza, Egypt

subject.hierarchicalGeographic

The umbrella "subject" field is not populated, but most individual components are. Remove and JIRA this.

Y

Yes?

Yes

NoNo

subject.hierarchicalGeographic.continent
subject.hierarchicalGeographic.country
subject.hierarchicalGeographic.province
subject.hierarchicalGeographic.region
subject.hierarchicalGeographic.state
subject.hierarchicalGeographic.territory
subject.hierarchicalGeographic.county
subject.hierarchicalGeographic.city
subject.hierarchicalGeographic.island
subject.hierarchicalGeographic.area
subject.hierarchicalGeographic.extraterrestrialArea
subject.hierarchicalGeographic.citySection

Solr query returns no results:
https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic=Boston

?But some of the individual MODS paths work in a query or as a facet, e.g.:
https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.city=Boston
https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.country=Morocco
https://api.lib.harvard.edu/v2/items?q=volcano*&facets=subject.hierarchicalGeographic.country

subject.hierarchicalGeographic.continent

Y

Yes

Yes

No

Yes

subject.hierarchicalGeographic.continent

NOT WORKING / Seems a valid SOLR field, but no values returned

https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.continent=africa

subject.hierarchicalGeographic.country

Y

Yes

Yes

No

Yes

subject.hierarchicalGeographic.country

https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.country=canada

subject.hierarchicalGeographic.province

Y

Yes

Yes

No

Yes

subject.hierarchicalGeographic.province

NOT WORKING / Seems a valid SOLR field, but no values returned

https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.province=quebec

subject.hierarchicalGeographic.region

Y

Yes

Yes

No

Yes

subject.hierarchicalGeographic.region

NOT WORKING / Seems a valid SOLR field, but no values returned

https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.region=nile

subject.hierarchicalGeographic.state

Y

Yes

Yes

No

Yes

subject.hierarchicalGeographic.state

https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.state=massachusetts&q=maps

subject.hierarchicalGeographic.territory

Y

Yes

Yes

No

Yes

subject.hierarchicalGeographic.territory

NOT WORKING / Seems a valid SOLR field, but no values returned

https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.territory=*

subject.hierarchicalGeographic.county

Y

Yes

Yes

No

Yes

subject.hierarchicalGeographic.county

https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.county=middlesex

subject.hierarchicalGeographic.city

Y

Yes

Yes

No

Yes

subject.hierarchicalGeographic.city

https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.city=Cochituate&q=maps

subject.hierarchicalGeographic.island

Y

Yes

Yes

No

Yes

subject.hierarchicalGeographic.island

NOT WORKING / Seems a valid SOLR field, but no values returned

https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.island=*

subject.hierarchicalGeographic.area

Y

Yes

Yes

No

Yes

subject.hierarchicalGeographic.area

https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.area=galicia

subject.hierarchicalGeographic.extraterrestrialArea

Y

Yes

Yes

No

Yes

subject.hierarchicalGeographic.extraterrestrialArea

https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.extraterrestrialArea=*

subject.hierarchicalGeographic.citySection

Y

Yes

Yes

No

Yes

subject.hierarchicalGeographic.citySection

https://api.lib.harvard.edu/v2/items?subject.hierarchicalGeographic.citySection=charlestown

physicalLocation

(Includes Harvard repository names but also non-Harvard locations, especially for artworks.)

Y

Yes

No

Yes

Yes

location.physicalLocation

https://api.lib.harvard.edu/v2/items?physicalLocation=tozzer&subject=cylinder seals

repository

(Includes Harvard repositories only)

N (item api code does the processing)

Yes

Yes

No

Yes

Search: location.physicalLocation (where @type="repository")

Facet: extension.librarycloud.HarvardRepositories.HarvardRepository

A search will query the long form repository name (e.g.Eda Kuhn Loeb Music Library); faceting will return the short form repository name (e.g. Loeb Music).

 https://api.lib.harvard.edu/v2/items?q=peanuts&repository=Oakes Ames

shelfLocator

Y

Yes

Yes

Yes

No

location.shelfLocator

 https://api.lib.harvard.edu/v2/items?q=peanuts&shelfLocator=Film Mas

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?q=peanuts&shelfLocator_exact=Film%20Mas%2025860

url

Y

No

Yes

No

No

location.url

 https://api.lib.harvard.edu/v2/items?q=earhart amelia&url=*RAD.SCHL*

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?q=earhart amelia&url_exact=https://nrs.harvard.edu/urn-3:RAD.SCHL:29639951

url.access

(At this time, only url.access=preview works.)

N (url.access.preview, url.access.raw_object are listed, but item api code uses url.access)

No

Yes

No

Yes

location.url.access (range = <preview, raw object, object in context>)

facet as url.access.preview or url.access.raw_object

There's a typo in item api code: defined range values are "preview" and "raw object in context" but should be "preview", "raw object", and "object in context".

"preview" value works, e.g.:

https://api.lib.harvard.edu/v2/items?q=earhart amelia&url.access=preview 

"raw object in context" works as a query but it returns items without url@access="raw object", e.g.:

https://api.lib.harvard.edu/v2/items?q=earhart%20amelia&url.access=raw object in context

isOnline

(Indicates whether or not an item is available in digital form; values are "true" or "false. See also LibraryCloud Item API.)

Y

No

No

Yes

Yes

"true" if location.url[@access = 'raw object'] exists, "false" otherwise

https://api.lib.harvard.edu/v2/items?q=earhart amelia&isOnline=true

source

Y

No

No

Yes

Yes

recordInfo.recordIdentifier source attribute

Sources are currently MH:ALMA (from Alma), MH:VIA (image items from JSTOR forum), or MH:OASIS (finding aid components from ArchivesSpace).

Attribute occurs only on top-level recordInfo.recordIdentifier elements

https://api.lib.harvard.edu/v2/items?q=earhart amelia&source=MH:ALMA

recordIdentifier

Y

No

Yes

No

No

recordInfo.recordIdentifier at the top level only

priorrecordids.recordIdentifier

e.g. recordIdentifier=sch00443c00007  (for finding aids), recordIdentifier=S26791_olvsurrogate827653 (for images), recordIdentifier=012956251 (for Aleph)

(Internal recordInfo.recordIdentifier elements in finding aid components and image records can be searched as keywords.)

https://api.lib.harvard.edu/v2/items?recordIdentifier=990148733450203941 (for Alma)

https://api.lib.harvard.edu/v2/items?recordIdentifier=014873345 (for Aleph)

https://api.lib.harvard.edu/v2/items?recordIdentifier=sch00227c00197 (for finding aids)

https://api.lib.harvard.edu/v2/items?recordIdentifier=W42143_urn-3:FHCL:1176307 (for images)

Use a keyword query to retrieve items based on record ID in finding aid components and image records:
https://api.lib.harvard.edu/v2/items?q=olvsurrogate717044


urn

(?Queries an item by its NRS URN (the URN only e.g., " urn-3:FHCL:1155043" minus the actionable URL components)

YYesNoNoNolocation.urlhttps://api.lib.harvard.edu/v2/items?urn=urn-3:FHCL:1155043

collectionTitle
(see /wiki/spaces/LibraryStaffDoc/pages/43288674)

(Query by the set/collection title assigned to items that have been grouped together for delivery via Harvard Digital Collections)

YYesYesYesYes

extension.sets.setName
extension.sets.setSpec

https://api.lib.harvard.edu/v2/items?collectionTitle=Chinese Rare Books

Case-sensitive exact match:https://api.lib.harvard.edu/v2/items?collectionTitle_exact=Chinese Rare Books

collectionId
(see /wiki/spaces/LibraryStaffDoc/pages/43288674)

(Query by the set/collection ID assigned to items that have been grouped together fo rdelivery via Harvard Digital Collections)

YNoYesNoYesextension.sets.systemId

https://api.lib.harvard.edu/v2/items?collectionId=84560

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?collectionId_exact=84560

DRS Extensions       

inDRS

(Query for items in Harvard Library's digital repository service. See also LibraryCloud Item API.)

YNoYes Yesextension.HarvardDRS.inDRS  (range = <"true", "false">)https://api.lib.harvard.edu/v2/items?genre=daguerreotype&inDRS=true

accessFlag (valid if inDRS=true)

See also: LibraryCloud Item API to query human-readable version of DRS accessFlags.

YNoYes Yes

extension.HarvardDRS.accessFlag (range = <P, R, N, B>)

P (publicly accessible), R (restricted to Harvard), N (not available for delivery), B (bypass, access handled differently)

https://api.lib.harvard.edu/v2/items?genre=daguerreotype&accessFlag=P

contentModel (valid if inDRS=true)

 

See also: LibraryCloud Item API to query by human-readable value derived from the contentModel for an object in Harvard's Digital Repository Service (DRS).

YYesYes Yes

extension.HarvardDRS.contentModel (range = <AUDIO, DOCUMENT, PDS DOCUMENT, PDS DOCUMENT LIST, STILL IMAGE, TEXT, VIDEO>) Use _exact query to find "DOCUMENT"

 https://api.lib.harvard.edu/v2/items?title=biodiversity&limit=100&contentModel=PDS DOCUMENT

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?contentModel_exact=DOCUMENT

uriType (valid if inDRS=true)

(Query for items by type of delivery urn, which is a proxy for type of delivery service)

YNoYes Yes

extension.HarvardDRS.uriType  (range = <FDS, IDS, PDS, PDS_LIST, SDS, SDS_VIDEO>)

Delivery service types: FDS (text documents), IDS (images), PDS (page-turned objects), PDS_LIST (list of page-turned objects), SDS (streaming audio), (SDS_VIDEO (streaming video)

https://api.lib.harvard.edu/v2/items?subject=jazz&uriType=SDS 

fileDeliveryURL (valid if inDRS=true)

(Query an item by its full delivery URL)

YNoYes Noextension.HarvardDRS.fileDeliveryURL, eg. "http://nrs.harvard.edu/urn-3:FHCL.HOUGH:1090399"
https://api.lib.harvard.edu/v2/items?title=annual+report&fileDeliveryURL=https://nrs.harvard.edu/urn-3:HMS.COUNT:22923642
ownerCode (valid if inDRS=true)YNoYes Yesextension.HarvardDRS.ownerCode, eg. "FHCL.HOUGH"
https://api.lib.harvard.edu/v2/items?q=cookbook*&ownerCode=RAD.SCHL
ownerCodeDisplayName (valid if inDRS=true)YNoYes Yesextension.HarvardDRS.ownerCodeDisplayName, eg. "Houghton Library"
 
https://api.lib.harvard.edu/v2/items?q=daguerreotype&ownerCodeDisplayName=Schlesinger

metsLabel (valid if inDRS=true)

(Query for items by keywords in the descriptive METS label - if defined in DRS metadata)

YYesYes Noextension.HarvardDRS.metsLabel  eg. Any text string

https://api.lib.harvard.edu/v2/items?metsLabel=seward

Case-sensitive exact match:
https://api.lib.harvard.edu/v2/items?metsLabel_exact=The Italians in Chicago. Washington: G.P.O., 1897.

lastModifiedDate (valid if inDRS=true)

NOT WORKING

YNoYes Noextension.HarvardDRS.lastModifiedDate - eg. "2016-05-03T19:24:18.334Z". NOTE: This value needs to be converted into a searchable form, and the example value will change.

4/9/19 JW: item api reports "lastModifiedDate" as invalid field; note that field list, mods2solr.xsl and api code all refer to the field "_lastModifiedDate" but api reports this as undefined field also.

https://api.lib.harvard.edu/v2/items?title_exact=Peanuts&lastModifiedDate=2015-08-21T21:16:36.389Z

maxImageDeliveryDimension NoFutureNoFutureextension.HarvardDRS.maxImageDeliveryDimension - e.g., "600". Value is in pixels. 
LibraryCloud Extensions       

availableTo

See also: availableTo to query by DRS accessFlag.

 

YNoYesNoYes

extension.librarycloud.availableTo

Human-readable values for access to digital content in Harvard's Digital Repository Service (DRS).

Values are "Everyone" (corresponds to accessFlag=P) and "Harvard only" (corresponds to accessFlag=R).

https://api.lib.harvard.edu/v2/items?q=colonialism&availableTo=Everyone

digitalFormat

See also: LibraryCloud Item API to query by the DRS content model of an object in Harvard's Digital Repository Service (DRS).

YYes  Yes

extension.librarycloud.digitalFormats.digitalFormat

Human readable values derived from the contentModel for an object in Harvard's Digital Repository Service (DRS).

Values are audio, books and documents, images, and video.

https://api.lib.harvard.edu/v2/items?subject=poetry&digitalFormat=audio

processed.after

NNoYes  

extension.librarycloud.processingDate

Use YYYY-MM-DD format to search.

These date queries work, but # of matching hits is very high. What is meaning/context of processed.after and processed.before?

This query returns items processed after the date specified:
https://api.lib.harvard.edu/v2/items?processed.after=2019-01-01

This query returns items processed before the date specified:
https://api.lib.harvard.edu/v2/items?processed.before=2019-01-02

This query returns items processed between the specified dates:
https://api.lib.harvard.edu/v2/items?processed.after=2018-07-01&processed.before=2019-01-01

processed.before

Sets Extensions       
setNameYYes NoYes

extension.sets.set.setName

Human-readable names that identify a set of materials selected by, for example, a curator for administrative or discovery purposes or for harvesting via OAI-PMH.

https://api.lib.harvard.edu/v2/items?setName=chinese rare books
setSpecYYes NoYes

extension.sets.set.setSpec

Codes used to identify a set of materials selected by, for example, a curator for administrative or discovery purposes or for harvesting via OAI-PMH.

https://api.lib.harvard.edu/v2/items?setSpec=crb

Examples

#search all of LibraryCloud for “peanuts” in the title
http://api.lib.harvard.edu/v2/items?title=peanuts
 
#search oasis components for “peanuts” in the title
http://api.lib.harvard.edu/v2/items?title=peanuts&source=MH:OASIS   (can use MH:OASIS, MH:VIA, or MH:ALEPH)
 
#search for a specific component identifier in OASIS
http://api.lib.harvard.edu/v2/items?recordIdentifier=sch00443c00007&source=MH:OASIS

#search for a specific component identifier in VIA (the identifier actually has the form "<viaRecordId>_<URN>", but the wildcard matches the URN portion if not known.
http://api.lib.harvard.edu/v2/items?recordIdentifier=W188002*
 
#search for all components in an OASIS record
http://api.lib.harvard.edu/v2/items?recordIdentifier=sch00443*

#look up the MODS for a PDS object given its URN

http://api.lib.harvard.edu/v2/items?urn=urn-3:FHCL.HOUGH:25620083

#search all of library cloud for VIA records that are public and have “peanuts” in the title  (NOTE: "restricted" DRS Access Flag field not yet released to production API)
http://api.lib.harvard.edu/v2/items?title=peanuts&source=MH:VIA&accessFlag=P

#Get the facet counts for collections with various collection titles

https://api.lib.harvard.edu/v2/items?facets=collectionTitle

#Get all manuscripts from Schlesinger Library that contain either the string "electronic finding aid available" OR "electronic container list available"

https://api.lib.harvard.edu/v2/items?physicalLocation=sch&isManuscript=true&q=(https://api.lib.harvard.edu/v2/items?physicalLocation=sch&isManuscript=true&q=(electronic%20finding%20aid%20available)%20OR%20(electronic%20container%20list%20available))

Support

LibraryCloud Support



 

  • No labels