OLA MLC Actions - uchicago-library/ldr_documentation GitHub Wiki

“Actions” means what happens when a user types into the web interface: “I” is input to the API; “O” is output from the API.

Given the complexities of the metadata, and the fact that this was originally intended to work against an RDF triplestore, some of this will require explanation.

x getResultsByCreator	I: 
  			dc:contributor 
  			OPTIONAL dc:creator
			O: 
			dc:title
			dc:contributor 
			OPTIONAL dc:creator
			dc:language
			dcterms:spatial
			dc:date
			bf:content
			dcterms:accessRights

x getResultsByLanguage	I: 
  			dc:language
			O: 
			dc:title
			dc:contributor
			OPTIONAL dc:creator
			dc:language
			dcterms:spatial
			dc:date
			bf:content
			dcterms:accessRights

x getResultsByLocation	I: 
  			dcterms:spatial
			O: 
			dc:title
			dc:contributor
			OPTIONAL dc:creator
			dc:language
			dcterms:spatial
			dc:date
			bf:content
			dcterms:accessRights

x getResultsByDate	I: 
  			dc:date
			O: 
			dc:title
			dc:contributor
			OPTIONAL dc:creator
			dc:language
			dcterms:spatial
			dc:date
			bf:content
			dcterms:accessRights

x getItem		I: 
  			dcterms:identifier (item)
			O: 
			dcterms:identifier (item)
			dc:title (series)
			dma:title
			dcterms:alternative
			dc:contributor
			OPTIONAL dc:creator
			dc:language
			dcterms:spatial
			dc:date
			dc:description
			olac:linguisticDataType
			olac:discourseType
			dma:contentType
			dcterms:accessRights

x getSeries		I: 
  			dcterms:identifier (series)
			O: 
			dcterms:identifier (series)
			edm:datasetName,
			dc:title
			dcterms:alternative
			dc:contributor
			OPTIONAL dc:creator
			dc:language (indigenous language) where	dma:languageRole == Subject
			dc:language (language) where dma:languageRole == Primary,
			dcterms:spatial
			dc:date
			dc:description
			dcterms:accessRights
			dc:identifier (item) == dma:identifier == __kp_ItemID
			dma:title
			Also
			retrieve dc:identifier (item) ==
			dma:identifier == __kp_ItemID for all child
			items belonging to a Series

x getBrowseListLanguages	I: 
  				none
			O: 
			dc:language

x getBrowseListLocations	I: 
  				none
			O: 
			dcterms:spatial

x getBrowseListContributors	I: 
  				none
			O: 
			dc:contributor
			OPTIONAL dc:creator

x getBrowseListDates	I: 
  			none
			O: 
			dc:date (item)

getKeywordSearch	I: 
			dc:contributor
			dc:creator
			dc:date
			dc:description (item)
x getResultsByCreator	I: 
  			dc:contributor 
  			OPTIONAL dc:creator
			O: 
			dc:title
			dc:contributor 
			OPTIONAL dc:creator
			dc:language
			dcterms:spatial,
			dc:date
			bf:content
			dcterms:accessRights

x getResultsByLanguage	I: 
  			dc:language
			O: 
			dc:title
			dc:contributor
			OPTIONAL dc:creator
			dc:language
			dcterms:spatial
			dc:date
			bf:content
			dcterms:accessRights

x getResultsByLocation	I: 
  			dcterms:spatial
			O: 
			dc:title
			dc:contributor
			OPTIONAL dc:creator
			dc:language
			dcterms:spatial
			dc:date
			bf:content
			dcterms:accessRights

x getResultsByDate	I: 
  			dc:date
			O: 
			dc:title
			dc:contributor
			OPTIONAL dc:creator
			dc:language
			dcterms:spatial
			dc:date
			bf:content
			dcterms:accessRights

x getItem		I: 
  			dcterms:identifier (item)
			O: 
			bf:content
			dcterms:identifier (item)
			dc:title (series)
			dma:title
			dcterms:alternative
			dc:contributor
			OPTIONAL dc:creator
			dc:language
			dcterms:spatial
			dc:date
			dc:description
			olac:linguisticDataType
			olac:discourseType
			dma:contentType
			dcterms:accessRights

x getSeries		I: 
  			dcterms:identifier (series)
			O: 
			dcterms:identifier (series)
			edm:datasetName,
			dc:title
			dcterms:alternative
			dc:contributor
			OPTIONAL dc:creator
			dc:language (indigenous language) where	dma:languageRole == Subject
			dc:language (language) where dma:languageRole == Primary,
			dcterms:spatial
			dc:date
			dc:description
			dcterms:accessRights
			dc:identifier (item) == dma:identifier == __kp_ItemID
			dma:title
			Also
			retrieve dc:identifier (item) ==
			dma:identifier == __kp_ItemID for all child
			items belonging to a Series

x getBrowseListLanguages	I: 
  				none
			O: 
			dc:language

x getBrowseListLocations	I: 
  				none
			O: 
			dcterms:spatial

x getBrowseListContributors	I: 
  				none
			O: 
			dc:contributor
			OPTIONAL dc:creator

x getBrowseListDates	I: 
  			none
			O: 
			dc:date (item)

getResultsByKeyword	I: 
			getResultsByCreator
			dc:contributor
			dc:creator

			getResultsByDate
			dc:date

			getResultsByDescriptionOrTitle
			dc:description (item)
			dc:description (series)
			dc:title (series)
			dcterms:alternative

			getResultsByLanguage
			dc:language [NEEDS Glottolog]

			getResultsByLocation
			dcterms:spatial [NEEDS TGN]

			getResultsByMisc
			dma:contentType
			edm:datasetName
			olac:discourseType

			O: 
			dcterms:identifier
			bf:content
			dc:contributor
			OPTIONAL dc:creator
			dc:date
			dc:language
			dc:title
			dcterms:accessRights
			dcterms:spatial