OpenMRS 1.9 Extension REST Resources
resourceVersion property on all the Resources is 1.9, where as resourceVersion property for other OpenMRS REST resources is 1.8
Location
URLs
| url | description |
|---|---|
| GET /ws/rest/v1/location?q | Fetch all non-retired that match this parameter |
| GET /ws/rest/v1/location/\{uuid\} | Fetch by unique uuid |
| GET /ws/rest/v1/location | Fetch all non-retired |
| POST /ws/rest/v1/location | Create 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\}?!purge | Delete this object from the database |
| DELETE /ws/rest/v1/location/\{uuid\}?purge | Delete this object from the database |
Representations
| GET ref | GET default | GET full | POST create | POST 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
| url | description |
|---|---|
| GET /ws/rest/v1/location/\{parentUuid\}/attribute/\{uuid\} | Fetch by unique uuid |
| GET /ws/rest/v1/location/\{parentUuid\}/attribute | Fetch all non-retired |
| POST /ws/rest/v1/location/\{parentUuid\}/attribute | Create 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\}?!purge | Delete this object from the database |
| DELETE /ws/rest/v1/location/\{parentUuid\}/attribute/\{uuid\}?purge | Delete this object from the database |
Representations
| GET ref | GET default | GET full | POST create | POST update |
|---|---|---|---|---|
| uuid display links | uuid | uuid display value attributeType voided auditInfo links resourceVersion | value attributeType | value attributeType |
LocationAttributeType
URLs
| url | description |
|---|---|
| GET /ws/rest/v1/locationattributetype?q | Fetch all non-retired that match this parameter |
| GET /ws/rest/v1/locationattributetype/\{uuid\} | Fetch by unique uuid |
| GET /ws/rest/v1/locationattributetype | Fetch all non-retired |
| POST /ws/rest/v1/locationattributetype | Create 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\}?!purge | Delete this object from the database |
| DELETE /ws/rest/v1/locationattributetype/\{uuid\}?purge | Delete this object from the database |
Representations
| GET ref | GET default | GET full | POST create | POST 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
| url | description |
|---|---|
| GET /ws/rest/v1/provider?q | Fetch all non-retired that match this parameter |
| GET /ws/rest/v1/provider/\{uuid\} | Fetch by unique uuid |
| GET /ws/rest/v1/provider | Fetch all non-retired |
| POST /ws/rest/v1/provider | Create 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\}?!purge | Delete this object from the database |
| DELETE /ws/rest/v1/provider/\{uuid\}?purge | Delete this object from the database |
Representations
| GET ref | GET default | GET full | POST create | POST 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
| url | description |
|---|---|
| GET /ws/rest/v1/provider/\{parentUuid\}/attribute/\{uuid\} | Fetch by unique uuid |
| GET /ws/rest/v1/provider/\{parentUuid\}/attribute | Fetch all non-retired |
| POST /ws/rest/v1/provider/\{parentUuid\}/attribute | Create 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\}?!purge | Delete this object from the database |
| DELETE /ws/rest/v1/provider/\{parentUuid\}/attribute/\{uuid\}?purge | Delete this object from the database |
Representations
| GET ref | GET default | GET full | POST create | POST 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
| url | description |
|---|---|
| GET /ws/rest/v1/providerattributetype?q | Fetch all non-retired that match this parameter |
| GET /ws/rest/v1/providerattributetype/\{uuid\} | Fetch by unique uuid |
| GET /ws/rest/v1/providerattributetype | Fetch all non-retired |
| POST /ws/rest/v1/providerattributetype | Create 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\}?!purge | Delete this object from the database |
| DELETE /ws/rest/v1/providerattributetype/\{uuid\}?purge | Delete this object from the database |
Representations
| GET ref | GET default | GET full | POST create | POST 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 |