Table of Contents | ||||
---|---|---|---|---|
|
Required parameters are marked with "*"
...
Purpose*
This web service is designed to obtain full information about capitation or reimbursement contract by NHS employee(private API) or MSP employee(public API).
Contract type should be declared in the URL.
Specification*
...
Project Name
...
COVID-certificate
...
Project abreviation
...
SVC
...
Developer
...
Розробник методу API. Наприклад, Edenlab
...
Project Manager
...
Tech Lead
...
Product Owner
...
Вusiness analyst
...
Status
Status | ||||
---|---|---|---|---|
|
...
Version
...
1.0
...
Date of release
...
...
Link
...
...
Resource
...
/api/contracts/{{contract_type}}/{{id}}
...
Scope
...
contract:read
...
Components
...
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
...
Microservices
...
Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC
...
Protocol type
...
Тип протоколу, який використовується запитом, наприклад: SOAP | REST
...
Request type
...
GET
...
Sync/Async
...
Метод є синхронним чи асинхронним?
Logic*
This method is designed to get full information of contract by id
Input parameters
Потрібно вказати вхідні параметри запиту. Наприклад, для GET /patients/composition/job/{{asyncJobId}} вхідний параметр:
...
Input parameter
...
Values
...
Type
...
Description
...
Example
...
id
...
String
...
contract identifier
...
d290f1ee-6c54-4b01-90e6-d701748f0851
Request structure*
See on Apiary Удалить пример кода или нет? в апи его нет
Example:
...
title | Request example |
---|
...
Table of Contents | ||||
---|---|---|---|---|
|
Required parameters are marked with "*"
Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.
Purpose*
This web service is designed to obtain full information about capitation or reimbursement contract by NHS employee(private API) or MSP employee(public API).
Contract type should be declared in the URL.
Specification*
Page Properties | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic*
This method is designed to get full information of contract by id
Input parameters
Потрібно вказати вхідні параметри запиту. Наприклад, для GET /patients/composition/job/{{asyncJobId}} вхідний параметр:
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
id | String | contract identifier |
|
Request structure*
API paragraph not found
Authorize*
Вимоги до авторизації: яким чином надається доступ до використання методу
Request to process the request using a token in the headers
Headers*
Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Validate request*
Наприклад: Удалить пример кода или нет? в апи его нет
Validate request using JSON schema
In case validation failed - generate 422 error
...
title | JSON schema |
---|
...
Request to process the request using a token in the headers
Headers*
Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Validate request*
API paragraph not found
Request data validation*
Validate token
...
Validate contract id. Check contract.id = $.id
in case error return 404 ("Contract with id=$id doesn't exist")
Parameters that are used when processing the request
Configuration parameters
Наприклад: Доступ до методу визначається скоупом covid_certificate:get . Дозвіл на даний скоуп визначається адміністратором Системи шляхом конфігурування скоупів в контексті клієнтів і ролей.
Dictionaries
...
Processing*
Потрібно описати процеси, які відбуваються з даними
1. Using global parameters
Потрібно викликати глобальні параметри (Global parameters), щоб отримати наведені нижче параметри
Response structure*
See on Apiary
...
Expand | ||
---|---|---|
| ||
|
Responses
In response show ops.contracts.id+ops.contractor_employees.id and end_date is null
Post-processing processes*
Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 |
|
|