Versions Compared

Old Version 2

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Oleksandr Zhuk (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

...

...

Purpose

...

This method allows to get all existing contract employees for contracts with GB_CBP type through the NHS IT system

Specification

...

@Єлизавета Гессен-Дармштадська
Page Properties

Project Name

COVID-certificate

Project abreviation

SVC

Developer

Розробник методу API. Наприклад, Edenlab

Project Manager

Tech Lead

@Іоанн Воїнов

Product Owner

@Нікодім Святогорцев

Вusiness analyst

@Пантелеймон Нікомедійський

Status

Status
colourGreen
titleAPPROVED

Version

1.0

Date of release

Link

private_contracts:read

Resource

/api/admin/contract_employees

Scope

https://uaehealthapiehealthmisapi1.docs.apiary.io/#reference/private.-contracts/private-contract-employees/private.-get-contract-employees

Resource

Components

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC

Protocol type

Тип протоколу, який використовується запитом, наприклад: SOAP | /api/admin/contract_employees

Scope

private_contracts:read

Components

Contracts

Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Метод є синхронним чи асинхронним?Sync

Public/Private/Internal

Private

Logic

...

WS returns list of contract employees

Filters

Filter

Values

Type

Description

Example

id

String

Contract division identifier

b075f148-7f93-4fc2-b2ec-2d81b19a9b7b

employee_id

String

Employee identifier

da1c07c3-1104-45a3-9a8c-04ffd898da6a

division_id

String

Division identifier

f93ac873-b999-47d2-a945-32e7f582eed0

contract_id

String

Contract identifier

82286646-ee07-4d89-929d-29287c367e8a

is_active

Boolean

wether contract employees is active

true

page

Number

Page number

2

page_size

Number

A limit on the number of objects to be returned. Maximum: 500

50

Request structure*

API paragraph not found

Authorize

...

  1. Verify the validity of api-key

    1. Return 401 in case validation fails

  2. Verify the validity of token

    1. Return 401 in case validation fails

  3. Check scopes in order to perform this action (scope = 'private_contracts:read')

    1. Return 403 in case invalid scope(s)

Request to process the request using a token in the headers

Headers

...

Наприклад:

  • Content-Type:application/json

  • api-key:c2778f3064753ea70de870a53795f5c9

Request data validation

Validate request

...

  1. Only authenticated and authorized user can use this service

  2. Deleted records won't be shown in response

...

Request data validation*

...

Processing

...

  1. Search contract employees for contracts with type = GB_CBP in DB according to requested query parameters

  2. Render a response

Response structure

...

See on Apiary

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "8be63914-a278-470b-b868-1af5b9087332",
      "staff_units": 1,
      "declaration_limit": 2000,
      "employee_id": "ce050c01-f4a5-4d5f-85d6-7e41d41146bf",
      "division_id": "62d0a654-2e7f-40fb-b1bb-8a38cdc3f701",
      "contract_id": "6bb64748-7707-4be8-86e0-56cfb08e9b88",
      "start_date": "2018-04-20T19:14:13Z",
      "end_date": "2019-04-20T19:14:13Z",
      "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
  }
}

Post-processing processes*

API paragraph not found

HTTP status codes

...

HTTP status code

Message

What caused the error

 200

 

 

...