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 2 Current »

resourceVersion property on all the Resources is 1.9, where as resourceVersion property for other OpenMRS REST resources is 1.8

Location

URLs

urldescription
GET /ws/rest/v1/location?qFetch all non-retired that match this parameter
GET /ws/rest/v1/location/\{uuid\}Fetch by unique uuid
GET /ws/rest/v1/locationFetch all non-retired
POST /ws/rest/v1/locationCreate with properties in request
POST /ws/rest/v1/location/\{uuid\}Edit with given uuid, only modifying properties in request
DELETE /ws/rest/v1/location/\{uuid\}?!purgeDelete this object from the database
DELETE /ws/rest/v1/location/\{uuid\}?purgeDelete this object from the database

Representations

GET refGET defaultGET fullPOST createPOST update
uuid
display
links
uuid
display
name
description
address1
address2
cityVillage
stateProvince
country
postalCode
latitude
longitude
countyDistrict
address3
address4
address5
address6
tags
parentLocation
childLocations
retired
attributes
links
resourceVersion
uuid
display
name
description
address1
address2
cityVillage
stateProvince
country
postalCode
latitude
longitude
countyDistrict
address3
address4
address5
address6
tags
parentLocation
childLocations
retired
auditInfo
attributes
links
resourceVersion
name
description
address1
address2
cityVillage
stateProvince
country
postalCode
latitude
longitude
countyDistrict
address3
address4
address5
address6
tags
parentLocation
childLocations
attributes
name
description
address1
address2
cityVillage
stateProvince
country
postalCode
latitude
longitude
countyDistrict
address3
address4
address5
address6
tags
parentLocation
childLocations
attributes

LocationAttribute

URLs

urldescription
GET /ws/rest/v1/location/\{parentUuid\}/attribute/\{uuid\}Fetch by unique uuid
GET /ws/rest/v1/location/\{parentUuid\}/attributeFetch all non-retired
POST /ws/rest/v1/location/\{parentUuid\}/attributeCreate with properties in request
POST /ws/rest/v1/location/\{parentUuid\}/attribute/\{uuid\}Edit with given uuid, only modifying properties in request
DELETE /ws/rest/v1/location/\{parentUuid\}/attribute/\{uuid\}?!purgeDelete this object from the database
DELETE /ws/rest/v1/location/\{parentUuid\}/attribute/\{uuid\}?purgeDelete this object from the database

Representations

GET refGET defaultGET fullPOST createPOST update
uuid
display
links

uuid
display
value
attributeType
voided
links
resourceVersion

uuid
display
value
attributeType
voided
auditInfo
links
resourceVersion
value
attributeType
value
attributeType

LocationAttributeType

URLs

urldescription
GET /ws/rest/v1/locationattributetype?qFetch all non-retired that match this parameter
GET /ws/rest/v1/locationattributetype/\{uuid\}Fetch by unique uuid
GET /ws/rest/v1/locationattributetypeFetch all non-retired
POST /ws/rest/v1/locationattributetypeCreate with properties in request
POST /ws/rest/v1/locationattributetype/\{uuid\}Edit with given uuid, only modifying properties in request
DELETE /ws/rest/v1/locationattributetype/\{uuid\}?!purgeDelete this object from the database
DELETE /ws/rest/v1/locationattributetype/\{uuid\}?purgeDelete this object from the database

Representations

GET refGET defaultGET fullPOST createPOST update
uuid
display
links
uuid
display
name
description
minOccurs
maxOccurs
datatypeClassname
preferredHandlerClassname
retired
links
resourceVersion
uuid
display
name
description
minOccurs
maxOccurs
datatypeClassname
datatypeConfig
preferredHandlerClassname
handlerConfig
retired
auditInfo
links
resourceVersion
name
datatypeClassname
description
minOccurs
maxOccurs
datatypeConfig
preferredHandlerClassname
handlerConfig
name
datatypeClassname
description
minOccurs
maxOccurs
datatypeConfig
preferredHandlerClassname
handlerConfig

Provider

URLs

urldescription
GET /ws/rest/v1/provider?qFetch all non-retired that match this parameter
GET /ws/rest/v1/provider/\{uuid\}Fetch by unique uuid
GET /ws/rest/v1/providerFetch all non-retired
POST /ws/rest/v1/providerCreate with properties in request
POST /ws/rest/v1/provider/\{uuid\}Edit with given uuid, only modifying properties in request
DELETE /ws/rest/v1/provider/\{uuid\}?!purgeDelete this object from the database
DELETE /ws/rest/v1/provider/\{uuid\}?purgeDelete this object from the database

Representations

GET refGET defaultGET fullPOST createPOST update
uuid
display
links
uuid
display
person
identifier
attributes
retired
links
resourceVersion
uuid
display
person
identifier
attributes
retired
auditInfo
links
resourceVersion
person
identifier
attributes
retired
person
identifier
attributes
retired

ProviderAttribute

URLs

urldescription
GET /ws/rest/v1/provider/\{parentUuid\}/attribute/\{uuid\}Fetch by unique uuid
GET /ws/rest/v1/provider/\{parentUuid\}/attributeFetch all non-retired
POST /ws/rest/v1/provider/\{parentUuid\}/attributeCreate with properties in request
POST /ws/rest/v1/provider/\{parentUuid\}/attribute/\{uuid\}Edit with given uuid, only modifying properties in request
DELETE /ws/rest/v1/provider/\{parentUuid\}/attribute/\{uuid\}?!purgeDelete this object from the database
DELETE /ws/rest/v1/provider/\{parentUuid\}/attribute/\{uuid\}?purgeDelete this object from the database

Representations

GET refGET defaultGET fullPOST createPOST update
uuid
display
links
uuid
display
value
attributeType
voided
links
resourceVersion
uuid
display
value
attributeType
voided
auditInfo
links
resourceVersion
value
attributeType
value
attributeType

ProviderAttributeType

URLs

urldescription
GET /ws/rest/v1/providerattributetype?qFetch all non-retired that match this parameter
GET /ws/rest/v1/providerattributetype/\{uuid\}Fetch by unique uuid
GET /ws/rest/v1/providerattributetypeFetch all non-retired
POST /ws/rest/v1/providerattributetypeCreate with properties in request
POST /ws/rest/v1/providerattributetype/\{uuid\}Edit with given uuid, only modifying properties in request
DELETE /ws/rest/v1/providerattributetype/\{uuid\}?!purgeDelete this object from the database
DELETE /ws/rest/v1/providerattributetype/\{uuid\}?purgeDelete this object from the database

Representations

GET refGET defaultGET fullPOST createPOST update
uuid
display
links
uuid
display
name
description
minOccurs
maxOccurs
datatypeClassname
preferredHandlerClassname
retired
links
resourceVersion
uuid
display
name
description
minOccurs
maxOccurs
datatypeClassname
datatypeConfig
preferredHandlerClassname
handlerConfig
retired
auditInfo
links
resourceVersion
name
datatypeClassname
description
minOccurs
maxOccurs
datatypeConfig
preferredHandlerClassname
handlerConfig
name
datatypeClassname
description
minOccurs
maxOccurs
datatypeConfig
preferredHandlerClassname
handlerConfig
  • No labels