Wiki Spaces
Documentation
Projects
Resources
Get Help from Others
Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack
All routes must be prepended with '/api'.
url | Description |
---|---|
GET /markers | Fetches 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 /marker | Creates 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 |
GET | POST create | PATCH update |
---|---|---|
id latitude longitude name url type image patients encounters observations contact notes data atlas_version date_created date_changed created_by show_counts openmrs_version distribution | latitude longitude name url type image patients encounters observations contact notes data atlas_version date_created date_changed created_by show_counts openmrs_version distribution | latitude longitude name url type image patients encounters observations contact notes data atlas_version date_created date_changed created_by show_counts openmrs_version distribution |
url | Description |
---|---|
GET /distributions | Fetches data of all distributions |
GET /distribution/:id | Fetches distribution with a specific id |
POST /distribution | Creates distribution with properties in request |
PATCH /distribution/:id | Updates distribution of given id with properties in request |
DELETE /distribution/:id | Delete distribution of given id |
GET | POST create | PATCH update |
---|---|---|
id name created_at is_standard | name is_standard | name is_standard |
url | Description |
---|---|
GET /types | Fetches data of all types of markers |
GET /type/:id | Fetches type with a specific id |
POST /type | Creates type with properties in request |
PATCH /type/:id | Updates type of given id with properties in request |
DELETE /type/:id | Delete type of given id |
GET | POST create | PATCH update |
---|---|---|
id name icon | name icon | name icon |
url | Description |
---|---|
GET /versions | Fetches data of all versions |
GET /version/:id | Fetches version with a specific id |
POST /version | Create version with properties in request |
PATCH /version/:id | Updates version of given id with properties in request |
DELETE /version/:id | Delete version of given id |
GET | POST create | PATCH update |
---|---|---|
id version | version | version |
url | Description |
---|---|
GET /auth | Fetches all auth rules |
POST /auth | Create new auth rule |
DELETE /auth/:id | Delete auth rule of given id |
GET | POST create |
---|---|
id atlas_id principal privileges expires | atlas_id principal token privileges expires |
url | Description |
---|---|
POST /unsubscribed | Unsubscribe authenticated user from notifications |
DELETE /unsubscribed | Subscribe authenticated user for notifications |
POST /unsubscribed/:username | Unsubscribe user from notifications |
DELETE /unsubscribed/:username | Subscribe user for notifications |
POST create |
---|
id username |
url | Description |
---|---|
POST /module/ping, /module/ping.php | Pings to the server that the marker is alive. |
POST /module/auth | Creates an UPDATE rule for the module and marker. |
DELETE /module/auth | Deletes UPDATE rule for the module and marker. |
POST update | POST create |
---|---|
id patients observations encounters atlasVersion data version modules[] : [ id name version active ] | atlas_id |
url | Description |
---|---|
GET /report/module | Gets data of all modules |
GET /report/module/:module_id | Gets data about a specific module |
GET module |
---|
id name versions[] : [ count ] |