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-0023
Microservices (namespace)	IL
Component	Contracts
Component ID	COM-005-002
Link на API-специфікацію
Resource	{{host}/api/contracts/{{contract_type}}/{{id}}/printout_content
Scope	contract:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Private

Purpose

This WS allows to extract Printout form by $contract_id from media storage

Logic

This method is designed to get printout content by contract id. After contract request was signed by both sides signed contract request with printout content was saved to the storage. This WS extract printout content from the storage.

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 identifier	`d290f1ee-6c54-4b01-90e6-d701748f0851`
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 token

Verify the validity of access token
- Return 401 in case validation fails
token is not expired
- in case error return 401

Validate scopes

Check user scopes in order to perform this action (scope = 'contract:read')
1. Return 403 in case invalid scope(s) -"Your scope does not allow to access this resource. Missing allowances: contract:read"

Validate employee

extract user_id from token

extract client_id from token

Check if user is active
- in case error return 403 - "user is not active"
Check nhs_legal_entity is active
- in case error return 403 - "Client is not active"

Validate context

extract client_id from token. LE employee can see only this legal entities contracts. NHS employee can see any contracts.

if TOKENS_TYPES_PERSONAL
- Check client_id = contracts.contractor_legal_entity_id
  - in case error return 403 "User is not allowed to perform this action"

Validate data

Validate contract id. Check contracts.id = $.id
- in case error return 404 ("Contract with id=$id doesn't exist")

Extract Printout form

search contracts in media storage by contract_request_id
decode base64
return "printout_content"

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

Description of the REST API response structure, example