REST Web Services API

Conventions

TODO: copy from Web Services API (Design Page) once it is finalized

Representations

TODO: copy from Web Services API (Design Page) once it is finalized

Authentication

Nearly every method in the OpenMRS API requires authentication, therefore, some every method in the webservices module needs to have an authenticated user in order to work.

There is a filter defined on the module that intercepts all calls and authenticates the given request. 

Currently only BASIC authentication is supported.  Header arguments values of ___ and ___ are expected. 

Alternatively, a session token can be used.  GET /openmrs/ws/rest/session with the BASIC credentials will return the current token value.  This token should be passed with all subsequent calls as a cookie named jsessionid=token.

REST API

The pages listed below contain specific web services and object representations.  For general REST web service information, see the module page or the REST user guide