Purpose

This method is designed to obtain all Employees of the legal entity.

Specification

Logic

...

Verify the validity of access token

...

Input parameters

See on Apiary

Filters

See on Apiary

1. Search employees by filters in ws url:

   1. required filters

      1. legal_entity_id (MSP id), 

   2. optional filters: 

      1. status (employees status APPROVED, DISMISSED, REORGANIZED). By default used APPROVED

      2. employee_type (employees type DOCTOR, HR, ACCOUNTANT, PHARMACIST, etc). By default returned all types of employees.

      3. limit (limit response size - quantity of employee objects). By default returned 50 objects.

      4. starting_after (cursor to fetch next page)

      5. ending_before (cursor to fetch previous pageno_tax_id (filer employees with or w/o tax_id).

      6. tax_id (filter employees by tax_id)

      7. party_id (filter employees by party)

      8. edrpou (filter employees by legal_entity edrpou)

      9. division_id (filter employees by division)

      10. page (Page number)

      11. page_size (A limit on the number of objects to be returned, between 1 and 300. Default: 50)

2. If according to filters employees are not found, WS returns empty data array.

...

• employee and party objects

• for DOCTOR and PHARMACIST - additional returns specialities information

• pagination data - for tecnical info.

Input parameters

See on Apiary

Filters

...

Dictionaries

• EMPLOYEE_TYPE

• SPECIALITY_TYPE

• SPECIALITY_LEVEL

• SPEC_QUALIFICATION_TYPE

• POSITION

• +DIVISION_TYPE

Authorize

Request to process the request using a token in the headers

Headers

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

• 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)

Headers

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

-

Processing

Service returns specified Employees related to the legal entity from token:

1. Get Employees from prm.employees

   1. Filter by search paramsmedication_request_id and patient_id and status (optional)

2. Filter list above by submitted search parameters

3. Render a response according to specification with found Employees

   1. Return empty array if no data found.

...