Wiki Spaces


Get Help from Others

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


Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


The "retired" and "voided" boolean properties are on the ref/default/full representations. The ref rep will only contain the property if the object if isVoided/isRetired returns true.


The OpenMRS API will change over time and this will necessitate the rest representations and urls to be modified as well. The first release of the module will be version "1". The entire rest api is versioned with this same number:


When a non-backwards compatible change is made to the api, the version will be incremented to "1.1". (Hopefully by that time the spring bug restricting the use of a "." in the uri is fixed)

The actual visible version of the module will be incremented independenty from openmrs AND from the version of the rest api.

TODO: When necessary, insert table of rest module version to rest api version to openmrs required version.

There were discussions about using the Media-Type header instead of a number in the uri. However, looking at a lot of major players in the api space, we decided to go with a global api version in the uri.



(available with OpenMRS v1.8.1 or higher due to the Spring Framework 3.0.5 requirement)