Required parameters are marked with "*"

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

Purpose*

This method allows to update existing contract employee in DB

Specification*

Link	https://uaehealthapi.docs.apiary.io/#reference/private.-contracts/private-contract-employees/private.-update-contract-employee
Resource	/api/admin/contract_employees/{{id}}
Scope	private_contracts:write
Components	Contracts
Microservices	API paragraph not found
Protocol type	REST
Request type	PUT
Sync/Async	Sync

Logic*

API paragraph not found

Input parameters

Input parameter	Values	Type	Description	Example
id		String	Contract emplyee identifier	`b075f148-7f93-4fc2-b2ec-2d81b19a9b7b`

Request structure*

See on Apiary

Example:

Request 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"
}

Authorize*

Verify the validity of api-key
1. Return 401 in case validation fails
Verify the validity of token
1. Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'private_contracts:write')
1. Return 403 in case invalid scope(s)

Request to process the request using a token in the headers

Headers*

Наприклад:

Content-Type:application/json
api-key:c2778f3064753ea70de870a53795f5c9

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
$.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

2. Update record in DB

3. Audit log (trigger logic)

Response structure*