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 to an OpenMRS database.
Downloads
Source at: https://github.com/openmrs/openmrs-module-webservices.rest
Download at: http://modules.openmrs.org/modules/view.jsp?module=webservices.rest
Example Client (SVN) https://project-development-software-victor-aravena.googlecode.com/svn/trunk/ClientOpenMRSRest/
User Documentation
Required OpenMRS Version
The REST Web Services module requires at least OpenMRS 1.9.0 or 1.8.1 to run.
Configuration Options
Technical Documentation
The module exposes the OpenMRS API through light-weight resource objects off of the core OpenMRS objects. The structure is very similar, but not guaranteed to match up exactly.
This module uses Spring 3 annotations to expose URLs. Primary transport language is currently JSON and XML (beta in 2.1).
For Creators of Web Service Core/Module Methods
Adding a Web Service Step by Step Guide for Core Developers
Adding a Web Service Step by Step Guide for Module Developers
For Web Service Client Developers
Development History
Initial project page: Enhanced Web Services (Design Page)
Development sprint 1: 2011-05-16 Development Sprint
Followup sprint: 2011-05-30 Development Sprint
Development sprint 2: 2011-07-05 Development Sprint
Development sprint 3: 2013-02-07 Integration of RESTWS
Example Client code
- Quick java swing client that displays patients and encounters: http://svn.openmrs.org/openmrs-contrib/examples/webservices/hackyswingexample/
- In the following link you can download a client (api) java that allows add - edit a person (any resource) and make a query to Webservice.Rest https://project-development-software-victor-aravena.googlecode.com/svn/trunk/ClientOpenMRSRest/
Release Notes
- 2.2
- New Features
- [RESTWS-348] - Require that user have View REST WS Menu privilege to view the menu in the administration page
- [RESTWS-391] - Rest API to search drug by name
- Bug fixes
- [RESTWS-373] - Incorrect Converter returned in ConversionUtil convertToRepresentation()
- [RESTWS-381] - Return object representation instead of id for person attribute
- [RESTWS-384] - restService.getSearchHandler fails with ClassCastException
- New Features
- 2.1
- Better XML support (backwads incompatibility, see RESTWS-206)
- Replaced .../concept/<conceptname> with .../concept?name=<conceptname> (backwards incompatibility, see RESTWS-370)
- Additional search handlers
- Improvements to the catalog
- 2.0 (see Migration from REST 1.x to 2.x)
- Integrated Webservices.rest 1.9 extension module
- Removed controllers (single point of entry)
- Added search handlers
- Added support for Concept mappings
- 1.1
- (23 bugs/features fixed/added)
- Fixed concept.answers
- Fixed patient.identifiers
- Made more resources editable
- Added ability to return retired resources generally
- Added Provider and Visit support to the 1.9ext module
- 1.0
- Main functionality realized with no new bugs
- 0.9 (Beta)
- Bugfixes
- 0.8 (Alpha)
- All use cases working as defined on the Web Service 1.0 User Stories page
- Download omod to install in your own OpenMRS installation
Download standalone with webservices module for an out of the box openmrs with rest web services ready to go.