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

[DRAFT] Deactivate Medical program provision [API-005-003-001-0056]

Owned by Kateryna Yakovleva
Last updated: Nov 25, 2024 by Anastasiia Prokhorova (SoE eHealth)
3 min read

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/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-003-001-0056

Microservices (namespace)

IL

Component

Contracts|Medical program provision

Component ID

COM-005-003

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-contracts/medical-program-provision/deactivate-medical-program-provision

Resource

{{host}}/api/medical_program_provision/{{id}}/actions/deactivate

Scope

medical_program_provision:write

Protocol type

REST

Request type

PATCH

Sync/Async

Sync

Public/Private

Public

Purpose

This WS allows to deactivate division that provide a medical program within user’s legal entity

Key points

  1. This is a REST method.

  2. Only authenticated and authorized pharmacy owner with appropriate scope can create a Medical program provision.

  3. Method does not use DS.

  4. At once User can deactivate only one active Medical program provision with Divisions which belongs to it’s own Legal entity.

Logic

This method allows to deactivate division that provide a medical program within user's legal entity.

Service logic

  1. Update record with medical_program_provision_id according to Data model

    1. set is_active = false

    2. set deactivate_reason = MANUAL_DEACTIVATION (according to PROVISON_DEACTIVATE_REASON dictionary)

    3. set updated_at, updated_by

 

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

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

Medical program provision identifier

2060b523-b469-4fc5-89af-ddb5899d8efe

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Key

Value

Mandatory

Description

Example

Key

Value

Mandatory

Description

Example

1

Content-Type

application/json

M

Тип контенту

Content-Type:application/json

2

Authorization

Bearer F3GF124Df565FDS234SDF34

M

Перевірка користувача

Authorization:Bearer F3GF124Df565FDS234SDF34

3

api-key

aDGFDFGT46S5gFGD

 

 

api-key:aDGFDFGT46S5gFGD

Request data validation

Authorize

  • 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 = 'medical_program_provision:write')

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

Request to process the request using a token in the headers

Validate legal entity

  • Extract client_id from token.

  • Check client scopes in order to perform this action (scope = 'medical_program_provision:write')

    • in case of error - return 403 “Your scope does not allow to access this resource. Missing allowances: medical_program_provision:write”

  • Check legal entity status (status = ACTIVE, SUSPENDED)

    • In case of error - return 422 “Legal entity is not active”

Validate medical program provision

  1. Get medical_program_provision_id from URL:

    1. Check it exists:

      1. in case of error - return 404 “Medical program provision not found”

    2. Check it belongs to division of user’s legal entity:

      1. in case of error - return 409 “Medical program provision does not belong to user’s legal entity”

    3. Check it is active (is_active=true):

      1. in case of error - return 409 “Medical program provision is inactive”

 

Dictionaries

  • PROVISON_DEACTIVATE_REASON

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

{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": { "id": "3e34da3d-9b8c-4aaf-be8e-24a161279b6a", "contract_number": "0000-PAP5-M000", "medical_program_id": "04d5ea65-d6e7-44f8-9eef-f0d3c1121d2b", "division_id": "15caea3f-cac3-483c-a3da-5875eba96430", "is_active": false, "deactivate_reason": "MANUAL_DEACTIVATION", "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" } }

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

 

 

 

3

 

401

Invalid access token

 

 

4

 

403

Your scope does not allow to access this resource. Missing allowances: medical_program_provision:write

 

 

5

 

403

Your scope does not allow to access this resource. Missing allowances: medical_program_provision:write

 

 

6

 

404

Medical program provision not found

 

 

7

 

409

Medical program provision does not belong to user’s legal entity

 

 

8

 

409

Medical program provision is inactive

 

 

9

 

422

Legal entity is not active

 

 

10

Специфічні

11

 

 

 

 

 

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

 

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