1 Purpose
2 Specification
3 Preconditions
4 Logic
5 Filters
6 Authorize
7 Headers
8 Request data validation
9 Processing
10 Response structure
11 HTTP status codes

Purpose

This WS is designed to search (get list) of Employee roles.

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/employee-roles/get-employee-roles	Посилання на Apiary або Swagger
Resource	/api/employee_roles	Посилання на ресурс, наприклад: /api/persons/create
Scope	employee_role:read	Scope для доступу
Components	Employees	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	il/api	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public	Потрібно зазначити тип методу за ступенем доступності

Preconditions

If an employee has an active role

Logic

Only authenticated and authorized user can use this service
Service returns only employee roles related to the same legal entity as the user

Filters

See on Apiary

Authorize

Verify the validity of access token
1. Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'employee_role:read')
1. Return 403 in case invalid scope(s)

Headers

Наприклад:

Content-Type:application/json

Request data validation

API paragraph not found

Processing

Extract client_id from token
Return entries filtered by client_id and query params

Response structure

Service returns only employee roles related to the same legal entity as the user

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "7c3da506-804d-4550-8993-bf17f9ee0402",
      "healthcare_service_id": "98b6ed10-17b4-44f1-892c-7514f66bf505",
      "employee_id": "9d229fcb-6a77-4574-99a5-30729aa518fd",
      "start_date": "2019-04-20T19:14:13Z",
      "end_date": "2017-12-20T19:14:13Z",
      "status": "ACTIVE",
      "is_active": true,
      "inserted_at": "2017-04-20T19:14:13Z",
      "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
      "updated_at": "2017-04-20T19:14:13Z",
      "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
201	Response
401		Invalid access token
403		Invalid scope(s)

E-Health

Get employee roles