API for Morphbank Query Services

Contact: Greg Riccardi mailto://griccardi@fsu.edu

HTTP Get queries with Key-Value parameters

Get operations URL prefix http://services.morphbank.net/mb3/request?

HTTP Post queries with XML document

Post queries submitted to URL http://services.morphbank.net/mbd/restful

Parameters

· String method; // value that determines action, values described below.

· String keywords; // search terms for method=search (or xml)

· int limit = 10; // maximum number of results to return

· int firstResult = 0; // offset of first result

· String format; // requested format for return value

· int id; // Morphbank local identifier for object

· String userId; // uin or Morphbank id of a user

· String groupId; // group name or Morphbank id of a group

· String keyString; // unique key assigned to user and/or group

· String objectType; // return restricted to objects of these types (maxOccurs=unlimited)

· String taxonName; // scientific name of taxon

· Date changeDate; // specifies date of changed objects

Values of parameter method

· search: search by keyword

· taxon: search by taxonomic names

· id: search for an object by its Morphbank id

· externalId: search for an object by its external identification

· changes: find objects changed since changeDate

· ocr: perform OCR analysis on an image

· herbis: perform language analysis and characterization of text using the Herbis analyzer.

· xml: deprecated synonym for search

Values of parameter format

· xml

· rss

· svc

· id

· rdf

· thumb

Parameter/method correspondence

Method	search	id	taxon	externalId	changes	ocr	herbis
keywords	X			X
format	X	X	X	X	X
id		X				X	X
limit	X	X	X	X	X
firstResult	X		X		X
userId	X		X		X
group	X		X		X
keyString	X		X		X
objectTypes	X		X		X
taxonName			X		X
changeDate					X

XML Schema mbsvc.xsd at http://www.morphbank.net/schema/mbsvc.xsd

The requests tag is the root of a document that represents queries, updates and inserts.

To add new content to the metadata repository