REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

Properties of a REST API method document

Document type	Метод REST API
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-0038
Microservices (namespace)	IL
Component	Contracts
Component ID	COM-005-002
Link на API-специфікацію
Resource	{{host}}/api/admin/contract_employees/{{id}}
Scope	private_contracts:write
Protocol type	REST
Request type	DELETE
Sync/Async	Sync
Public/Private	Private

Purpose

This method allows to delete existing contract employees for contract with type GB_CBP from DB through the NHS IT system

Note that record won't be permanently deleted. It will be marked is_active = false and will be unavailable

Logic

WS sets is_active = false and the contract employee will be unavailable

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
1	id		String	Contract emplyee identifier	`b075f148-7f93-4fc2-b2ec-2d81b19a9b7b`
2

Request structure

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

Description of the REST API request structure, example

Example

Headers

	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

Validate id
1. Check that contract_employee record with id from URL exist and is_active = true
  1. in case of error return 404 error ('Contract employee with such id is not found')
2. Check that contract from contract_employees.contract_id have type = 'GB_CBP'
  1. in case of error return 409 error ('Only contract employees for contract with type GB_CBP can be deleted')

Validate request

Only authenticated and authorized user can use this service

Processing

Update system attributes

Attribute	Value
is_active	Const: false
updated_at	now() timastamp
updated_by	User from token

Response structure examples

Description of the REST API response structure, example