Having a RESTful data interface means that Wildbook can be one of many programs working together to manage and analyze data in your study.
The principles of REST are well documented on the web, such as in this article: http://en.wikipedia.org/wiki/Representational_state_transfer
The programming-language independent method of displaying data called JSON is also well documented elsewhere, such as in this article: http://en.wikipedia.org/wiki/JSON
Wildbook's REST interface by default uses the base URL of:
For example, if properly configured, your Wildbook will list all of the Encounters submitted within it as a list of JSON objects displayed at the URL:
Here is a real world example from the Wildbook demo site: http://www.splashcatalog.org/mmuwildbook/rest/demo/org.ecocean.Encounter
Here are examples of accessing RESTful data in Wildbook.
which corresponds to this page in Wildbook:
Here is how you could get the data for Encounter 462 from Wildbook's REST interface in the JSON data format:
Here is how you could get the metadata for the SinglePhotoVideo objects (its uploaded media) for Encounter 462 from Wildbook's REST interface in the JSON data format:
While REST support allows your wildbook to work with other research applications in your project, it also means that your data is potentially exposed for others to easily take. By default, Wildbook protects the REST URL with this configuration in web.xml:
/rest/** = authcBasicWildbook,roles[rest]
This configuration means two things:
This means that by default your data is protected. To provide another application with access, two things must happen.
Wildbook uses the Apache Shiro open source project for security. To learn more about Apache Shiro and how you might further modify web.xml for your own customer REST interface, check out this resource:
Within Wildbook, data storage is managed by the open source DataNucleus project, which provides the functionality that allows WIldbook to store data in multiple database types. DataNucleus provides the REST data interface used by Wildbook, and more information about it can be found here: