REST API method / Метод REST API (настанова) (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-0034
Microservices (namespace)	IL
Component	Contracts
Component ID	COM-005-002
Link на API-специфікацію	https://uaehealthapi.docs.apiary.io/#reference/private.-contracts/private-contract-employees/private.-create-contract-employee
Resource	{{host}}/api/admin/contract_employees
Scope	private_contracts:write
Protocol type	REST
Request type	POST
Sync/Async	Sync
Public/Private	Private

Purpose

This method allows to create new contract employee record for existing contract with GB_CBP type through the NHS IT system

Logic

WS creating new 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	composition_id	M	String ($uuid) (path)	Composition object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
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

The following attributes must be validated

Validate employee_id
1. Check that employee exist and is_active = true
  1. in case of error return 404 error $.employee_id ('Employee is not found')
2. Check that employee_id correspond to contractor legal entity through employees.legal_entity_id=contracts.contractor_legal_entity_id
  1. in case of error return 422 error $.employee_id ('Employee is not correspond to contractor legal entity')
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 employee must be valid and consistent, i.e. all "foreign keys" must be valid

Processing

Set system attributes

Attribute	Value
id	Generate uuid
is_active	Const: true
inserted_at	now() timastamp
inserted_by	User from token
updated_at	now() timastamp
updated_by	User from token

Store to DB

Audit log (trigger logic)

Response structure examples