| Table of Contents | ||||
|---|---|---|---|---|
|
Required parameters are marked with "*"
Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.
Purpose*
This method allows to get all existing contract divisions 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 | ||||
|---|---|---|---|---|
|
1.0 | |
Date of release | |
|---|---|
Link | |
Resource | /api/admin/contract_divisions |
Scope | private_contracts:read |
Components | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription |
Microservices | Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC |
Protocol type | Тип протоколу, який використовується запитом, наприклад: SOAP | REST |
Request type | GET |
Sync/Async | Метод є синхронним чи асинхронним? |
Logic*
API paragraph not foundThis method allows to get all existing contract divisions for contracts with GB_CBP type through the NHS IT system
Filters
Filter | Values | Type | Description | Example |
|---|---|---|---|---|
id | String | Contract division identifier |
| |
contract_id | String | Contract identifier |
| |
division_id | String | Division identifier |
| |
is_active | Boolean | wether contract divisions is active |
| |
page | Number | Page number |
| |
page_size | Number | A limit on the number of objects to be returned. Maximum: 500 |
|
...
Request to process the request using a token in the headers
Headers*
Наприклад:
Content-Type:application/json
api-key:c2778f3064753ea70de870a53795f5c9
...