Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack

Documentation

Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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

  • No labels