Table of Contents

minLevel	1
maxLevel	7

Purpose

This method is used by NHS_admin to verify declarations that have been created with offline authorization.

Specification

Page Properties

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/declarations/verify-declaration	Посилання на Apiary або Swagger
Resource	/api/declarations/{{id}}/actions/approve	Посилання на ресурс, наприклад: /api/persons/create
Scope	declaration:approve	Scope для доступу
Components	Declarations	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	API paragraph not found	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	PATCH	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public	Потрібно зазначити тип методу за ступенем доступності

Logic

API paragraph not found

Preconditions

API paragraph not found

Global and configurable parameters

No

Input parameters

Input parameter	Values	Type	Description	Example
id		String	Required	d290f1ee-6c54-4b01-90e6-d701748f0851

Filters

API paragraph not found

Dictionaries

API paragraph not found

Request structure

API paragraph not found

Authorize

Verify the validity of access token
Check user scope declaration:approve in order to perform this action
1. In case error - return 401 error.

Headers

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

Validate transition

Validate transitionю Allowed transitions:

...

If not passed, Return Error 403 message "Invalid transition"

Processing

Update Declaration status

$declaration.status = active

...

$declaration.updated_at = timestamp

Response structure

...

Example:

Expand

title	Response example

Code Block
{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": {} }

Post-processing processes

API paragraph not found

HTTP status codes

Page Properties

HTTP status code	Message	What caused the error
200	Response
401	Invalid access token Error	2. Check of the user`s scope failed
403	Invalid transition

Backward compatibility

API paragraph not found

Versions Compared

Old Version 4

New Version 5

Key

Purpose

Specification

Logic

Preconditions

Global and configurable parameters

Input parameters

Filters

Dictionaries

Request structure

Authorize

Headers

Request data validation

Validate transition

Processing

Update Declaration status

Response structure

Example:
Expand
title Response example
Code Block
{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": {} }

Post-processing processes

HTTP status codes

Backward compatibility

Page Comparison

Versions Compared

Old Version 4

New Version 5

Key

Purpose

Specification

Logic

Preconditions

Global and configurable parameters

Input parameters

Filters

Dictionaries

Request structure

Authorize

Headers

Request data validation

Validate transition

Processing

Update Declaration status

Response structure

Example: ExpandtitleResponse example Code Block{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": {} }

Post-processing processes

HTTP status codes

Backward compatibility

Example:
Expand
title Response example
Code Block
{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": {} }