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

Compare with Current View Page History

« Previous Version 16 Next »

Many of the Scholars Portal Applications are equipped with REST Services allowing your institution to access the underlying data for use in your own internal applications. The following page lists the URLs which will enable you these resources. If you require additional information not available from this page, please make request using the contact form for the specific application in question

Scholars Portal Books

The starting URL should be "http://books.scholarsportal.info/SolrRequest?raw=true&" and the rest is any parameter compatible with Solr (more about search parameters: http://wiki.apache.org/solr/SearchHandler)

For example:
A simple query with XML response for Titles with "Degas": http://books.scholarsportal.info/SolrRequest?raw=true&q=Title:Degas&start=0&rows=2000&indent=on (maximum rows returned will be limited to 1000)
A fecet query with JSON response: http://books.scholarsportal.info/SolrRequest?raw=true&rows=0&indent=on&facet=true&facet.limit=20&facet.mincount=1&facet.field=LCC1-sortable&facet.field=SubjectLCSH-sortable&facet.field=Contributor-sortable&facet.field=Series-sortable&facet.field=Type-sortable&facet.field=Language-sortable&wt=json&json.wrf=Solr.retrieve&q=Title:Degas

Solr throws an error if an undefined field is used, so make sure to include the correct field names from schema .

Scholars Portal Journals

GeoPortal

Searching for records in Scholars Geoportal can be done by calling the Base URL 'http://geo2.scholarsportal.info/proxy.html?http:__giseditor.scholarsportal.info/search/index.html?limit=entitled&limit=entitled&env=production&' followed by additional URL parameters as appropriate.
 

Here are a list of URL parameters you can use to retrieve specific results:

Note that each new parameters must be separated by an ampersand character '&'

> q = search terms (can be multiple)
Searching for 'water' simply add '&q=water' to the end of the Base URL as follows http://geo.scholarsportal.info/proxy.html?http:__giseditor.scholarsportal.info/search/index.html?limit=entitled&limit=entitled&env=production&q=water

> field = field constraints (can be multiple and defaults to 'anywhere' if left blank) accepts the following options KW for KeywordTI for Title, AB for Abstract, SE for Series, bbox for Boundary Box, DR for Date Range, URI for Unique Resource Identifier, and HTD for Historical Maps
E.g searching for 'water' as a keyword add '&q=water&field=KW' to the end of the Base URL as follows http://geo.scholarsportal.info/proxy.html?http:__giseditor.scholarsportal.info/search/index.html?limit=entitled&limit=entitled&env=production&q=water&field=KW

> i = number of results per page (default is 10)
To display 100 results while searching for 'water' add '&q=water&i=100' to the end of the Base URL as follows  http://geo.scholarsportal.info/proxy.html?http:__giseditor.scholarsportal.info/search/index.html?limit=entitled&limit=entitled&env=production&q=water&i=100

> p = page number
To display the second page of results while searching for 'water' add '&q=water&p=2' to the end of the Base URL as follows http://geo.scholarsportal.info/proxy.html?http:__giseditor.scholarsportal.info/search/index.html?limit=entitled&limit=entitled&env=production&q=water&p=2


> val = facet constrain
To constrain a search to the keyword 'canada' while searching for 'water' add '&q=water&val=KW:"canada"' to the end of the Base URL as follows http://geo.scholarsportal.info/proxy.html?http:__giseditor.scholarsportal.info/search/index.html?limit=entitled&limit=entitled&env=production&q=water&p=2

> fm = json or xml (default is json)
To display results in XML while searching for water add '&q=water&fm=xml' to the end of the Base URL as follows http://geo.scholarsportal.info/proxy.html?http:__giseditor.scholarsportal.info/search/index.html?limit=entitled&limit=entitled&env=production&q=water&fm=xml

 

To download the metadata in ISO 19115 for any of the records use the Details Full Base URL 'http://geo1.scholarsportal.info/proxy.html?http:__giseditor.scholarsportal.info/details/full.html?uri=' followed by the record's URI.
E.g to display the first record from the 'water' search, append the URI '/NAP/OGDE_SPRWATER.xml' to the Details Full Base URL as follows http://geo1.scholarsportal.info/proxy.html?http:__giseditor.scholarsportal.info/details/full.html?uri=/NAP/OGDE_SPRWATER.xml
Note: Simply navigating to the Details Full Base URL with a URI in your browser will trigger a redirect to the metadata page in the geoportal.

To download the HTML for any of the records use the Details View Base URL 'http://geo1.scholarsportal.info/proxy.html?http:__giseditor.scholarsportal.info/details/view.html?uri=' followed by the records URI.
E.g to display the first record from the water search append the URI '/NAP/OGDE_SPRWATER.xml' to the Details View Base URL as follows http://geo1.scholarsportal.info/proxy.html?http:__giseditor.scholarsportal.info/details/view.html?uri=/NAP/OGDE_SPRWATER.xml
Note: A stylesheet should be used to display these.

ODESI

Searching for records in ODESI can be done by calling the Base URL 'http://search1.odesi.ca/search?requestURL=' followed by your search parameters as outlined below and ending with the URL encoded string '%26options%3Dodesi-opts2%26format%3Djson' which specifies the search options and format type (either json or xml). 

The entire search request is to be surrounded in round brackets with each search term also surrounded in round brackets.
E.g to search for 'smoking' you would add '((smoking))' to the Base URL as follows http://search1.odesi.ca/search?requestURL=((smoking))%26options%3Dodesi-opts2%26format%3Djson

To filter your search, prefix one of the following two letter codes to your search term; VL for Variable/Category Label, TI for Title, KW for Keywords, AB for Abstract, SE for Series.
E.g to search for 'smoking' in the title of a record, add  '((TI:smoking))' to the end of the  Base URL as follows http://search1.odesi.ca/search?requestURL=((TI:smoking))%26options%3Dodesi-opts2%26format%3Djson

To sort the search results by 'date', add 'AND (sort:date)' within the search request as follows  http://search1.odesi.ca/search?requestURL=((TI:smoking)) AND (sort:date)%26options%3Dodesi-opts2%26format%3Djson

To restrict the search results after a specific year (say 1999), add 'AND (date GE 1999)' within the search request as follows  http://search1.odesi.ca/search?requestURL=((TI:smoking)) AND (date GE 1999)%26options%3Dodesi-opts2%26format%3Djson 

To restrict the search results before a specific year (say 1999), add 'AND (date LE 1999)' within the search request as follows  http://search1.odesi.ca/search?requestURL=((TI:smoking)) AND (date LE 1999)%26options%3Dodesi-opts2%26format%3Djson 

Searches can be quite complex afforded by the underlying MarkLogic database. See https://docs.marklogic.com/guide/search-dev/string-query#id_98389 for examples of more complex searches.

To retrieve the metadata for a record, take the URI of a record and append to the end of the GetDetails Base URL 'http://search1.odesi.ca/getDetails?requestURL='.
E.g to show the metadata for the first record of the 'smoking' search results, add '/odesi/sos-82M0008E-E-1994.xml' to the end of the GetDetails Base URL as follows http://search1.odesi.ca/getDetails?requestURL=/odesi/sos-82M0008E-E-1994.xml&format=xml

 

Nesstar http://www.nesstar.com/software/public_api.html

ExLibris (SFX, bX, etc.)

 https://developers.exlibrisgroup.com/sfx/apis

Other Reference API's

Ontario Library Research Cloud 

http://developer.openstack.org/api-ref-objectstorage-v1.html

Dataverse

http://guides.dataverse.org/en/4.6/api/

 

  • No labels