Web Service Resources
It describes the URLs/resources published by the REST Module.
For more information on conventions, authentication, and setup, see the main Rest Web Service page.
Person
URLs
url | description |
|---|---|
GET /ws/rest/v1/person | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/person/{uuid} | Fetch by unique uuid |
POST /ws/rest/v1/person | Create with properties in request |
POST /ws/rest/v1/person/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/person/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/person/{uuid}?purge | Delete this object from the database |
PersonAddress
URLs
url | description |
|---|---|
GET /ws/rest/v1/person/{parentUuid}/address/{uuid} | Fetch by unique uuid |
GET /ws/rest/v1/person/{parentUuid}/address | Fetch all non-retired |
POST /ws/rest/v1/person/{parentUuid}/address | Create with properties in request |
POST /ws/rest/v1/person/{parentUuid}/address/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/person/{parentUuid}/address/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/person/{parentUuid}/address/{uuid}?purge | Delete this object from the database |
PersonAttribute
URLs
url | description |
|---|---|
GET /ws/rest/v1/person/{parentUuid}/attribute/{uuid} | Fetch by unique uuid |
GET /ws/rest/v1/person/{parentUuid}/attribute | Fetch all non-retired |
POST /ws/rest/v1/person/{parentUuid}/attribute | Create with properties in request |
POST /ws/rest/v1/person/{parentUuid}/attribute/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/person/{parentUuid}/attribute/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/person/{parentUuid}/attribute/{uuid}?purge | Delete this object from the database |
PersonAttributeType
URLs
url | description |
|---|---|
GET /ws/rest/v1/personattributetype | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/personattributetype/{uuid} | Fetch by unique uuid |
POST /ws/rest/v1/personattributetype | Create with properties in request |
POST /ws/rest/v1/personattributetype/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/personattributetype/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/personattributetype/{uuid}?purge | Delete this object from the database |
PersonName
URLs
url | description |
|---|---|
GET /ws/rest/v1/person/{parentUuid}/name/{uuid} | Fetch by unique uuid |
GET /ws/rest/v1/person/{parentUuid}/name | Fetch all non-retired |
POST /ws/rest/v1/person/{parentUuid}/name | Create with properties in request |
POST /ws/rest/v1/person/{parentUuid}/name/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/person/{parentUuid}/name/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/person/{parentUuid}/name/{uuid}?purge | Delete this object from the database |
Provider
URLs
url | description |
|---|---|
GET /ws/rest/v1/provider | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/provider/{uuid} | Fetch by unique uuid |
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 | Retire/Void this object |
DELETE /ws/rest/v1/provider/{uuid}?purge | Delete this object from the database |
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 | Retire/Void this object |
DELETE /ws/rest/v1/provider/{parentUuid}/attribute/{uuid}?purge | Delete this object from the database |
ProviderAttributeType
URLs
url | description |
|---|---|
GET /ws/rest/v1/providerattributetype | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/providerattributetype/{uuid} | Fetch by unique uuid |
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 | Retire/Void this object |
DELETE /ws/rest/v1/providerattributetype/{uuid}?purge | Delete this object from the database |
Role
URLs
url | description |
|---|---|
GET /ws/rest/v1/role | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/role/{uuid} | Fetch by unique uuid |
POST /ws/rest/v1/role | Create with properties in request |
POST /ws/rest/v1/role/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/role/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/role/{uuid}?purge | Delete this object from the database |
User
URLs
url | description |
|---|---|
GET /ws/rest/v1/user | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/user/{uuid} | Fetch by unique uuid |
POST /ws/rest/v1/user | Create with properties in request |
POST /ws/rest/v1/user/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/user/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/user/{uuid}?purge | Delete this object from the database |
Visit
URLs
url | description |
|---|---|
GET /ws/rest/v1/visit | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/visit/{uuid} | Fetch by unique uuid |
POST /ws/rest/v1/visit | Create with properties in request |
POST /ws/rest/v1/visit/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/visit/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/visit/{uuid}?purge | Delete this object from the database |
VisitAttribute
URLs
url | description |
|---|---|
GET /ws/rest/v1/visit/{parentUuid}/attribute/{uuid} | Fetch by unique uuid |
GET /ws/rest/v1/visit/{parentUuid}/attribute | Fetch all non-retired |
POST /ws/rest/v1/visit/{parentUuid}/attribute | Create with properties in request |
POST /ws/rest/v1/visit/{parentUuid}/attribute/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/visit/{parentUuid}/attribute/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/visit/{parentUuid}/attribute/{uuid}?purge | Delete this object from the database |
VisitAttributeType
URLs
url | description |
|---|---|
GET /ws/rest/v1/visitattributetype | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/visitattributetype/{uuid} | Fetch by unique uuid |
POST /ws/rest/v1/visitattributetype | Create with properties in request |
POST /ws/rest/v1/visitattributetype/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/visitattributetype/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/visitattributetype/{uuid}?purge | Delete this object from the database |
VisitType
URLs
url | description |
|---|---|
GET /ws/rest/v1/visittype | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/visittype/{uuid} | Fetch by unique uuid |
POST /ws/rest/v1/visittype | Create with properties in request |
POST /ws/rest/v1/visittype/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/visittype/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/visittype/{uuid}?purge | Delete this object from the database |
Encounter
URLs
url | description |
|---|---|
GET /ws/rest/v1/encounter | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/encounter/{uuid} | Fetch by unique uuid |
POST /ws/rest/v1/encounter | Create with properties in request |
POST /ws/rest/v1/encounter/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/encounter/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/encounter/{uuid}?purge | Delete this object from the database |
EncounterType
URLs
url | description |
|---|---|
GET /ws/rest/v1/encountertype | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/encountertype/{uuid} | Fetch by unique uuid |
POST /ws/rest/v1/encountertype | Create with properties in request |
POST /ws/rest/v1/encountertype/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/encountertype/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/encountertype/{uuid}?purge | Delete this object from the database |
Obs
URLs
url | description |
|---|---|
GET /ws/rest/v1/obs | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/obs/{uuid} | Fetch by unique uuid |
POST /ws/rest/v1/obs | Create with properties in request |
POST /ws/rest/v1/obs/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/obs/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/obs/{uuid}?purge | Delete this object from the database |
Location
URLs
url | description |
|---|---|
GET /ws/rest/v1/location | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/location/{uuid} | Fetch by unique uuid |
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 | Retire/Void this object |
DELETE /ws/rest/v1/location/{uuid}?purge | Delete this object from the database |
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 | Retire/Void this object |
DELETE /ws/rest/v1/location/{parentUuid}/attribute/{uuid}?purge | Delete this object from the database |
LocationAttributeType
URLs
url | description |
|---|---|
GET /ws/rest/v1/locationattributetype | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/locationattributetype/{uuid} | Fetch by unique uuid |
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 | Retire/Void this object |
DELETE /ws/rest/v1/locationattributetype/{uuid}?purge | Delete this object from the database |
LocationTag
URLs
url | description |
|---|---|
GET /ws/rest/v1/locationtag | Fetch all non-retired that match any specified parameters otherwise fetch all non-retired |
GET /ws/rest/v1/locationtag/{uuid} | Fetch by unique uuid |
POST /ws/rest/v1/locationtag | Create with properties in request |
POST /ws/rest/v1/locationtag/{uuid} | Edit with given uuid, only modifying properties in request |
DELETE /ws/rest/v1/locationtag/{uuid}?!purge | Retire/Void this object |
DELETE /ws/rest/v1/locationtag/{uuid}?purge | Delete this object from the database |