/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
Properties of a REST API method document
Purpose
This method is designed to obtain all Employees of the legal entity.
Logic
N/A
Configuration parameters
N/A
Dictionaries
EMPLOYEE_TYPE
SPECIALITY_TYPE
SPECIALITY_LEVEL
SPEC_QUALIFICATION_TYPE
POSITION
+DIVISION_TYPE
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | |||||
2 |
Request structure
See on API-specification
Headers
Request data validation
Authorize
Verify the validity of access token
Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
in case of error - return (401, 'Invalid access token')
Check user scopes in order to perform this action (scope = 'employee:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: employee:read') in case of invalid scope(s)
Processing
Service returns specified Employees related to the legal entity from token:
Get Employees from
prm.employees
Filter by medication_request_id and patient_id and status (optional)
Filter list above by submitted search parameters
Render a response according to specification with found Employees
Return empty array if no data found.
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
---|---|---|---|---|---|
1 | Базові | ||||
2 | 200 | Response |
| ||
3 | 401 | Invalid access token |
| ||
4 | 403 | Your scope does not allow to access this resource. Missing allowances: employee:read |
| ||
5 | Специфічні | ||||
6 |
Post-processing processes
N/A