Versions Compared

Key

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

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

This method allows to update existing contract divisions for contracts with GB_CBP type through the NHS IT system

...

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

https://uaehealthapi.docs.apiary.io/#reference/private.-contracts/private-contract-divisions/private.-update-contract-division

Resource

/api/admin/contract_divisions/{{id}}

Scope

private_contracts:write

Components

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

Microservices

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

Protocol type

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

Request type

PUT

Sync/Async

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

Logic*

API paragraph not found

Input parameters

Потрібно вказати вхідні параметри запиту. Наприклад, для GET /patients/composition/job/{{asyncJobId}} вхідний параметр:

Input parameter

Values

Type

Description

Example

id

String

01f37f5-52c8-477e-aba5-a1d01876d210

что делать с атрибутами?? оставлять или вообще их не писать? ---->

division_id

string

Employee identifier

4b6b3b53-282a-415b-8f88-f1c7ab65f4a3

что делать с атрибутами?? оставлять или вообще их не писать? ---->

contract_id

string

Division identifier

71e51746-cc88-46e1-95ab-19cc5911d74c

Request structure*

See on Apiary

...

Request to process the request using a token in the headers

Headers*

Наприклад:

  • Content-Type:application/json

  • api-key:c2778f3064753ea70de870a53795f5c9

...

Post-processing processes*

Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо

HTTP status codes*

HTTP status code

Message

What caused the error

 200

 

 

...