Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

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

Projects

Page tree

Versions Compared

Key

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

All routes must be prepended with '/api'.

Markers

URLs

urlDescription
GET /markersFetches data of all markers
GET /markers?username={username}Fetches markers that were created by user with username 'uid'
GET /marker/{id}Fetches marker by id
GET /markers?type={type}&versions={versions}&dists={dists}

Fetches  markers based on type, openmrs_version and distribution

POST /markerCreates marker with properties  in request
PATCH /marker/{id}Modifies marker of given id with properties in request
DELETE /marker/{id}Deletes marker with given id

...

urlDescription
POST /unsubscribedUnsubscribe authenticated user from notifications
DELETE /unsubscribedSubscribe authenticated user for notifications
POST /unsubscribed/:usernameUnsubscribe user from notifications
DELETE /unsubscribed/:usernameSubscribe user for notifications

Gets/Puts

POST create

id

username

...

Module

URLs

urlDescription
POST /module/ping, /module/ping.phpPings to the server that the marker is alive.
POST /module/authCreates an UPDATE rule for the module and marker.
DELETE /module/ping.php?id={id}&secret={secret}Deletes authDeletes UPDATE rule for the module and marker.

Gets/Puts

POST updatePOST create

id

patients

observations

encounters

atlasVersion

data

version

modules[] : [

    id

    name

    version

    active

]

atlas_id

Report

URLs

urlDescription
GET /report/moduleGets data of all modules
GET /report/module/:module_idGets data about a specific module

Gets/Puts

GET module

id

name

versions[] : [

    count

]