/
Atlas Server Rest API

Atlas Server Rest API



Markers

URLs

url

Description

url

Description

GET /api/markers

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

Creates 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

Gets/Puts

GET

POST create

PATCH update

GET

POST create

PATCH 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

url

Description

url

Description

GET /api/distributions

Fetches data of all distributions

GET /api/distribution/:id

Fetches distribution with a specific id

POST /api/distribution

Creates distribution with properties in request

PATCH /api/distribution/:id

Updates distribution of given id with properties in request

DELETE /api/distribution/:id

Delete distribution of given id

Gets/Puts

GET

POST create

PATCH update

GET

POST create

PATCH update

id

name

created_at

is_standard

name

is_standard

name

is_standard

Types

URLs

url

Description

url

Description

GET /api/types

Fetches data of all types of markers

GET /api/type/:id

Fetches type with a specific id

POST /api/type

Creates type with properties in request

PATCH /api/type/:id

Updates type of given id with properties in request

DELETE /api/type/:id

Delete type of given id

Gets/Puts

GET

POST create

PATCH update

GET

POST create

PATCH update

id

name

icon

name

icon

name

icon

Versions

URLs

url

Description

url

Description

GET /api/versions

Fetches data of all versions

GET /api/version/:id

Fetches version with a specific id

POST /api/version

Create version with properties in request

PATCH /api/version/:id

Updates version of given id with properties in request

DELETE /api/version/:id

Delete version of given id

Gets/Puts

GET

POST create

PATCH update

GET

POST create

PATCH update

id

version

version

version

Auth

URLs

url

Description

url

Description

GET /api/auth

Fetches all auth rules

POST /api/auth

Create new auth rule

DELETE /api/auth/:id

Delete auth rule of given id

Gets/Puts

GET

POST create

GET

POST create

id

atlas_id

principal

privileges

expires

atlas_id

principal

token

privileges

expires

Unsubscribed

URLs

url

Description

url

Description

POST /api/unsubscribed

Unsubscribe authenticated user from notifications

DELETE /api/unsubscribed

Subscribe authenticated user for notifications

POST /api/unsubscribed/:username

Unsubscribe user from notifications

DELETE /api/unsubscribed/:username

Subscribe user for notifications

Gets/Puts

POST create

POST create

id

username

Module

URLs

url

Description

url

Description

POST /api/module/ping, /api/module/ping.php

Pings to the server that the marker is alive.

POST /api/module/auth

Creates an UPDATE rule for the module and marker.

DELETE /api/module/auth

Deletes UPDATE rule for the module and marker.

Gets/Puts

POST update

POST create

POST update

POST create

id

patients

observations

encounters

atlasVersion

data

version

modules[] : [

    id

    name

    version

    active

]

atlas_id

Report

URLs

url

Description

url

Description

GET /api/report/module

Gets data of all modules

GET /api/report/module/:module_id

Gets data about a specific module

Gets/Puts

GET module

GET module

id

name

versions[] : [

    version: count

]





Related content

Atlas 3.0 Project
Atlas 3.0 Project
More like this
Atlas Module
Atlas Module
More like this
Atlas Module 2.0 Project
Atlas Module 2.0 Project
More like this
Atlas 3.1 Project
Atlas 3.1 Project
More like this
OpenMRS Atlas
OpenMRS Atlas
More like this
REST Web Service Resources in OpenMRS 1.9
REST Web Service Resources in OpenMRS 1.9
More like this