Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

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

Projects

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 21 Next »

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

Gets/Puts

GETPOST createPATCH update

id

latitude

longitude

name

url

type

image

patients

encounters

observations

contact

email

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

email

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

email

notes

data

atlas_version

date_created

date_changed

created_by

show_counts

openmrs_version

distribution

Distributions

URLs

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

Gets/Puts

GETPOST createPATCH update

id

name

created_at

is_standard

name

is_standard

name

is_standard

Types

URLs

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

Gets/Puts

GETPOST createPATCH update

id

name

icon

name

icon

name

icon

Versions

URLs

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

Gets/Puts

GETPOST createPATCH update

id

version

version

version

Auth

URLs

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

Gets/Puts

GETPOST create

id

atlas_id

principal

privileges

expires

atlas_id

principal

token

privileges

expires

Unsubscribed

URLs

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/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

]


  • No labels