What this module does
The module exposes the OpenMRS API as REST web services. if an OpenMRS instance is running the Webservices.REST module, other programs (and languages) can connect to retrieve and post certain information through OpenMRS.
User Documentation
The module exposes the OpenMRS API through light-weight resource objects of the core OpenMRS objects.
See Enhanced Web Services (Design Page) for the starter documentation. This will be updated to point at the final documentation once the module has a 1.0 release.
TODO: create and link to the full user guide documentation page(s)
Technical Documentation
This module uses Spring 3 annotations to expose URLs.
Full example of adding new web services to the core/trunk openmrs: Adding a Web Service Step by Step Guide for Core Developers
TODO: create and link to the full module ws creation guide
Downloads
View Source: http://source.openmrs.org/browse/Modules/webservices.rest/trunk/
Checkout Source: http://svn.openmrs.org/openmrs-modules/webservices.rest/trunk/
Download: http://modules.openmrs.org/modules/view.jsp?module= (To be updated once module is formally released)
Development Plans / Timeline
Development sprint: 2011-05-16 Development Sprint
Release Notes
(To be filled in once a formal release is made to the Module Repository
Module Configuration
Global properties
webservices.rest.maxresults - This Global Property used to set the maximum number of resources that can be accessed on a webservice call.