/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

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-0035
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	PUT
Sync/Async	Sync
Public/Private	Private

Purpose

This method allows to update existing contract employee in DB

Logic

WS update some system attributes of contract employee

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

{
  "staff_units": 1,
  "declaration_limit": 2000,
  "employee_id": "ce050c01-f4a5-4d5f-85d6-7e41d41146bf",
  "division_id": "62d0a654-2e7f-40fb-b1bb-8a38cdc3f701",
  "contract_id": "6bb64748-7707-4be8-86e0-56cfb08e9b88",
  "start_date": "2018-04-20T19:14:13Z",
  "end_date": "2019-04-20T19:14:13Z"
}

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 contract employee

Check that contract employee exists and is active

Attribute	Condition	Error
URL: {id}	Contract employee exists is_active = true	404, Not found

Validate foreign keys

The following attributes must be validated

Attribute	Condition	Error

Attribute	Condition	Error
$.contract_id	Contract exists is_active = true	409, Invalid contract id
$.division_id	Division exists is_active = true Relates to contractor legal entity	409, Invalid division id
$.employee_id	Employee exists is_active = true Relates to contractor legal entity	409, Invalid employee id

Validate request

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

Processing

Update system attributes

Attribute	Value
updated_at	now() timestamp
updated_by	User from token

Update record in DB

Audit log (trigger logic)

Response structure examples