/
API Structure: Providers
API Structure: Providers
- Utsav Ashish Koju
Owned by Utsav Ashish Koju
Dec 11, 2023
2 min read
Loading data...
This endpoint retrieves a list of providers working under a provided facility / orgunit.
URL: api/v2/providers
Method: GET
Authorization: Managed via Spring Framework Security (See: Link)
Note:
For PSI implementation, authorization is handled by OpenHIM, and Spring Boot security is disabled by default.
Request Prameters
Parameter | dhis2 Attribute | Description |
|---|---|---|
organisationunit.uid |
| OrgUnit UID for the parent. |
URL (for GET request):
https://{{host}}/api/v2/locator??organisationunit.uid={{ancestorUid}}
Response (in DHIS2)
{
"pager": {...},
"organisationUnits": [
{
"name": "Nurse Doe Junior (09-04-01-03)",
"description": "\nNurse Doe is a highly skilled specialist nurse who excels in critical care nursing, providing expert care to patients in intensive care units. With a strong dedication to patient advocacy and a deep understanding of advanced medical technologies, she plays a pivotal role in delivering exceptional care to the most critically ill individuals. Nurse Doe is the son of John and Jane Doe.",
"shortName": "Nurse Doe Junior",
"code": "09-04-01-03",
"parentId": "AgUWbKinYlO",
"image": "sdk7XGlIEXO",
"id": null
},
{
"name": "Dr. Jane Doe (09-04-01-02)",
"description": "Jane Doe is a highly regarded specialist doctor with extensive expertise in cardiology, known for his exceptional skills in diagnosing and treating heart-related conditions. Patients seek his care for his personalized and compassionate approach to cardiology, making him a trusted figure in the field. She is John Doe's wife.",
"shortName": "Dr. Jane Doe",
"code": "09-04-01-02",
"parentId": "AgUWbKinYlO",
"image": "KfVxU5IUU6X",
"id": null
},
{
"name": "Dr. John Doe (09-04-01-01)",
"description": "John Doe is a highly regarded specialist doctor with extensive expertise in cardiology, known for his exceptional skills in diagnosing and treating heart-related conditions. Patients seek his care for his personalized and compassionate approach to cardiology, making him a trusted figure in the field.",
"shortName": "Dr. John Doe",
"code": "09-04-01-01",
"parentId": "AgUWbKinYlO",
"image": "wMcJYRwSdcS",
"id": null
}
]
}