REST 1.x

Owned by raff
Last updated: Mar 12, 2013
2 min read

This is an old and no longer supported version. Please see REST Module for the latest version.

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/tree/1.x 

Download at https://modules.openmrs.org/modules/download/webservices.rest/webservices.rest-1.1.29293.omod

Download OpenMRS 1.9.x extension module at https://modules.openmrs.org/modules/view.jsp?module=webservices.rest19ext (It is needed, if you are running OpenMRS 1.9.1 and want to access some of the new API methods, tables, and objects.)

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 with XML to be added at a later date.

For Creators of Web Service Core/Module Methods

Adding a Web Service Step by Step Guide for Core Developers (REST 1.x)
Adding a Web Service Step by Step Guide for Module Developers (REST 1.x)

For Web Service Client Developers

See REST Web Services API For Clients

For more information on individual objects within the API, see REST Web Service Resources in OpenMRS 1.8

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

Example Client code

Release Notes