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 /api/markersFetches data of all markers
GET /api/markers?username={username}Fetches markers that were created by user with username 'uid'
GET /api/marker/{id}Fetches marker by id
GET /api/markers?type={type}&versions={versions}&dists={dists}

Fetches  markers based on type, openmrs_version and distribution

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

...

Distributions

URLs

urlDescription
GET /api/distributionsFetches data of all distributions
GET /api/distribution/:idFetches distribution with a specific id
POST /api/distributionCreates distribution with properties in request
PATCH /api/distribution/:idUpdates distribution of given id with properties in request
DELETE /api/distribution/:idDelete distribution of given id

...

Types

URLs

urlDescription
GET /api/typesFetches data of all types of markers
GET /api/type/:idFetches type with a specific id
POST /api/typeCreates type with properties in request
PATCH /api/type/:idUpdates type of given id with properties in request
DELETE /api/type/:idDelete type of given id

...

Versions

URLs

urlDescription
GET /api/versionsFetches data of all versions
GET /api/version/:idFetches version with a specific id
POST /api/versionCreate version with properties in request
PATCH /api/version/:idUpdates version of given id with properties in request
DELETE /api/version/:idDelete version of given id

...

Auth

URLs

urlDescription
GET /api/authFetches all auth rules
POST /api/authCreate new auth rule
DELETE /api/auth/:idDelete auth rule of given id

...

Unsubscribed

URLs

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

...

Module

URLs

urlDescription
POST /api/module/ping, /api/module/ping.phpPings to the server that the marker is alive.
POST /api/module/authCreates an UPDATE rule for the module and marker.
DELETE /api/module/authDeletes UPDATE rule for the module and marker.

...

POST updatePOST create

id

patients

observations

encounters

atlasVersion

data

version

modules[] : [

    id

    name

    version

    active

]

atlas_id

Report

URLs

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

Gets/Puts

GET module

id

name

versions[] : [

    version: count

]