ЕСОЗ - публічна документація

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Current »

/wiki/spaces/EN/pages/17591304241 (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-004-002-0078

Microservices (namespace)

IL

Component

Declarations

Component ID

COM-005-004

Link на API-специфікацію

https://ehealthmisapi1.docs.apiary.io/#reference/deprecated-methods/legal-entities/reject-declaration-request-deprecated

Resource

{{host}}/api/declaration_requests/{{id}}/actions/reject

Scope

declaration_request:write

Protocol type

REST

Request type

PATH

Sync/Async

Sync

Public/Private

Public

Purpose

Use this method to reject previously created Declaration Request

Key features

  1. Only authenticated and authorized user can reject declaration request

  2. New and Approved declaration request can be rejected (/wiki/spaces/PCAB/pages/17513775491 )

  3. Declaration request can be rejected only by the employee who works in the same legal entity in which the request was created

  4. Declaration requests created by patient via PIS and assigned to legal entity could be rejected by legal entity as well

Logic

Update declaration request

  1. Change entity status in IL_DB.declaration_request to REJECTED

  2. Set status_reason:

    1. If channel = MIS - set status_reason to doctor_reject

    2. If channel = PIS - set status_reason to doctor_rejected_over_limit

  3. Set updated_at - now() (Current date-time)

  4. Set updated_by - user_id (Extract user from token)

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

Input parameter

Mandatory

Type

Description

Example

1

2

Request structure

See on API-specification

 Example
 

Headers

Key

Value

Mandatory

Description

Example

1

2

3

Request data validation

Authorization

  • Verify the validity of access token

    • in case of error - return 401 (“Invalid access token”) in case of validation fails

  • Verify that token is not expired

    • in case of error - return 401 (“Invalid access token”)

  • Check user scopes in order to perform this action (scope = 'declaration_request:reject')

    • return 403 (“Your scope does not allow to access this resource. Missing allowances: declaration_request:reject”) in case of invalid scope(s)

Validation declaration request

  1. Check that declaration request with such ID exists in the system (is_active = true)

    1. In case of error - return 404

  2. Check that declaration request is allowed to be processed on LE (channel == MIS OR is_shareable == True)

    1. In case of error - return 403

  3. Check that declaration request belongs to the same legal entity as the user

    1. In case of error - return 403

Validate transition

  1. Check transition according to /wiki/spaces/PCAB/pages/17513775491

    1. In case of error - return 409 (“Invalid transition“)

Processing

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

Response structure examples

See on API-specification

 Example
 

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

201

 Response

 

3

401

 

Access token validation failed

4

401

Invalid access token

5

403

 

  • Invalid scopes

  • Check that declaration request belongs to the same legal entity as the user failed

6

403

Your scope does not allow to access this resource. Missing allowances: declaration_request:reject

7

404

 

Check that declaration request with such ID exists in the system (is_active = true) failed

8

409

Invalid transition

9

Специфічні

10

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

  • No labels