Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

1 Properties of a REST API method document
2 Purpose
3 Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
- 9.1 Validate request
10 Processing
11 Response structure examples
12 HTTP status codes
13 Post-processing processes
14 Technical modules where the method is used

Properties of a REST API method document

Document type	Метод REST API
Document title	[Document status] REST API [Назва методу] [ID методу]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-005-002-001-0030
Microservices (namespace)	IL
Component	Contracts
Component ID	COM-005-002
Link на API-специфікацію
Resource	{{host}}/api/admin/contract_divisions/{{id}}
Scope	private_contracts:write
Protocol type	REST
Request type	PUT
Sync/Async	Sync
Public/Private	Private

Purpose

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

Logic

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

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1	id		String		`01f37f5-52c8-477e-aba5-a1d01876d210`
2

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

{
  "division_id": "4b6b3b53-282a-415b-8f88-f1c7ab65f4a3",
  "contract_id": "71e51746-cc88-46e1-95ab-19cc5911d74c"
}

Headers

	Key	Value	Mandatory	Description	Example

	Key	Value	Mandatory	Description	Example
1	Content-Type	application/json	M	Тип контенту	Content-Type:application/json
2	Authorization	Bearer c2778f3064753ea70de870a53795f5c9	M	Перевірка користувача	Authorization:Bearer c2778f3064753ea70de870a53795f5c9
3

Request data validation

The following attributes must be validated

Validate id
1. Check that contract_division record with id from URL exist and is_active = true
  1. in case of error return 404 error ('Contract division with such id is not found')
2. Check that contract from contract_division.contract_id have type = 'GB_CBP' and is_active = true
  1. in case of error return 409 error ('Only contract divisions for contract with type GB_CBP can be updated')
Validate division_id
1. Check that division exist and is_active = true
  1. in case of error return 404 error $.division_id ('Division is not found')
2. Check that division_id correspond to contractor legal entity through divisions.legal_entity_id=contracts.contractor_legal_entity_id
  1. in case of error return 409 error $.division_id ('Division is not correspond to contractor legal entity')
Validate contract_id
1. Check that contract exist and is_active = true and type = GB_CBP
  1. in case error return 409 error $.contract_id ('Contract must be an active and with GB_CBP type')

Validate request

Only authenticated and authorized user can use this service
Contract division must be valid and consistent, i.e. all "foreign keys" must be valid

Processing

Update system attributes

Attribute	Value

Attribute	Value
updated_at	now() timastamp
updated_by	User from token

Update record in DB

Audit log (trigger logic)

Response structure examples

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API response structure, example

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "8be63914-a278-470b-b868-1af5b9087332",
    "division_id": "4b6b3b53-282a-415b-8f88-f1c7ab65f4a3",
    "contract_id": "71e51746-cc88-46e1-95ab-19cc5911d74c",
    "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"
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2	1000	404	Composition not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок
3		200
4		401	Unauthorized		Помилка підтвердження
5		404	Contract division with such id is not found
6		404	Division is not found
7		409	Contract must be an active and with GB_CBP type
8		409	Division is not correspond to contractor legal entity
9		409	Only contract divisions for contract with type GB_CBP can be updated
10	Специфічні
11		422	Only for active MPI record can be created medication request!

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

ЕСОЗ публічна документація

[DRAFT] Private. Update contract division [API-005-002-001-0030]