Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This WS is designed to search employees by legal_entity_id. 

  1. Verify the validity of access token
  2. Check user scopes in order to perform this action
  3. Search employees by filters in ws url:
    1. required filters
      1. legal_entity_id (MSP id)
    2. optional filters: 
      1. status (employees status ACTIVE, INACTIVE). By default used ACTIVE
      2. 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 page)
  4. If according to filters employees are not found, WS returns empty data array.

WS returns shortened details, which consist of:

  • employee and party objects

...

  • for DOCTOR and PHARMACIST - additional returns specialities information
  • pagination data - for tecnical info.