Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

...

Purpose

...

This method allows to update existing contract employee in DB

Specification

...

Page Properties
Project Name
COVID-certificate
Project abreviation
SVC
Developer
Розробник методу API. Наприклад, Edenlab
Project Manager
@Єлизавета Гессен-Дармштадська
Tech Lead
@Іоанн Воїнов
Product Owner
@Нікодім Святогорцев
Вusiness analyst
@Пантелеймон Нікомедійський
Status
Status
colour Green
title APPROVED
Version
1.0
Date of release
22 Jun 2022
Link
https://uaehealthapiehealthmisapi1.docs.apiary.io/#reference/private.-contracts/private-contract-employees/private.-update-contract-employee
Resource
/api/admin/contract_employees/{{id}}
Scope
private_contracts:write
Components
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionContracts
Microservices
Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found
Protocol type
Тип протоколу, який використовується запитом, наприклад: SOAP | REST
Request type
PUT
Sync/Async
Метод є синхронним чи асинхронним?Sync
Public/Private/Internal
Private

Logic

...

WS update some system attributes of contract employee

Input parameters

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

Request structure

...

See on Apiary

Example:

Expand

title	Request example

Code Block

{
  "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
Return 401 in case validation fails
Verify the validity of token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'private_contracts:write')
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

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

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
...
3. Audit log (trigger logic)

Response structure

...

See on Apiary

Example:

Expand

title	Response example

Code Block

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "8be63914-a278-470b-b868-1af5b9087332",
    "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",
    "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"
  }
}

Page Properties
Project Name	COVID-certificate
Project abreviation	SVC
Developer	Розробник методу API. Наприклад, Edenlab
Project Manager	@Єлизавета Гессен-Дармштадська
Tech Lead	@Іоанн Воїнов
Product Owner	@Нікодім Святогорцев
Вusiness analyst	@Пантелеймон Нікомедійський
Status

Link	https://uaehealthapiehealthmisapi1.docs.apiary.io/#reference/private.-contracts/private-contract-employees/private.-update-contract-employee
Resource	/api/admin/contract_employees/{{id}}
Scope	private_contracts:write
Components	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionContracts
Microservices	Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found
Protocol type	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	PUT
Sync/Async	Метод є синхронним чи асинхронним?Sync
Public/Private/Internal	Private

Versions Compared

Old Version 3

New Version Current

Key

Required parameters are marked with "*"

Purpose

This method allows to update existing contract employee in DB

Specification

Logic

WS update some system attributes of contract employee

Input parameters

Request structure

Authorize

Headers

Наприклад:
Content-Type:application/json
api-key:c2778f3064753ea70de870a53795f5c9

Validate request*

Request data validation

Validate contract employee

Validate foreign keys

Validate request

Processing

Update system attributes
Attribute
Value
updated_at
now() timestamp
updated_by
User from token
...
3. Audit log (trigger logic)

Response structure

Post-processing processes*

HTTP status codes

HTTP status code
Message
What caused the error
200

...

Page Comparison

Versions Compared

Old Version 3

New Version Current

Key

Required parameters are marked with "*"

Purpose

This method allows to update existing contract employee in DB

Specification

Logic

WS update some system attributes of contract employee

Input parameters

Request structure

Authorize

Headers

Наприклад:Content-Type:application/jsonapi-key:c2778f3064753ea70de870a53795f5c9

Validate request*

Request data validation

Validate contract employee

Validate foreign keys

Validate request

Processing

Update system attributesAttributeValueupdated_atnow() timestampupdated_byUser from token...3. Audit log (trigger logic)

Response structure

Post-processing processes*

HTTP status codes

HTTP status codeMessageWhat caused the error 200 ...

Наприклад:
Content-Type:application/json
api-key:c2778f3064753ea70de870a53795f5c9

Update system attributes
Attribute
Value
updated_at
now() timestamp
updated_by
User from token
...
3. Audit log (trigger logic)

HTTP status code
Message
What caused the error
200

...