...

Required parameters are marked with "*"

...

Purpose*

Необхідно зазначити призначення методу.

Наприклад: This method allows to receive active person declarations issued by the current legal entity (based on access_token)

Specification*

...

Link

...

Посилання на Apiary або Swagger

...

Resource

...

Наприклад: /api/persons/create

...

Scope

...

Зазначається потрібний scope

...

Components

...

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

...

Microservices

...

Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC

...

Protocol type

...

Тип протоколу, який використовується запитом, наприклад: SOAP | REST | JSON

...

Request type

...

Тип HTTP методу, який використовується запитом, наприклад: POST | GET…

...

Sync/Async

...

Метод є синхронним чи асинхронним?

Logic*

Потрібно по пунктах описати логіку методу API або додати діаграму

Preconditions

Які передумови мають бути виконані системою/користувачем. Наприклад:

створений запис в MedicationRequest;
рецепт відпущений (COMPLETED)

Global and configuration parameters

Потрібно вказати глобальні та конфігураційні параметри.

Наприклад:

...

Variable

...

Values

...

Description

...

CARE_PLAN_<category>_ICD10_AM_CONDITIONS_ALLOWED

...

Values that matches with dictionaryeHealth/ICD10_AM/condition_codes

Example: “E10.32, E11.92”

...

Allowed diagnoses for specified care plan category. Diagnoses should match with eHealth/ICD10_AM/condition_codes dictionary, <category> - is a value from dictionary eHealth/care_plan_categories in uppercase

_{(Example: CARE_PLAN_CLASS_1_ICD10_AM_CONDITIONS_ALLOWED)}

Input parameters

Потрібно вказати вхідні параметри, наприклад:

...

Input parameter

...

Values

...

Type

...

Description

...

Example

...

asyncJobId

...

String

...

Async Job Object ID

Filters

Потрібно вказати фільтри. Наприклад:

...

Filter

...

Values

...

Type

...

Description

...

Example

...

id

...

String

...

7f93-4fc2-b2ec-2d81b19a9b7b (string, required)

...

d290f1ee-6c54-4b01-90e6-d701748f0851

Request structure*

See on Apiary

Example:

...

Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

This WS is designed to change status of contract request to DECLINED by NHS ADMIN SIGNER. NHS employee can change status of contract request through Admin portal. If NHS Admin wants to decline contract request he/she need to enter a reason.

Specification*

Page Properties

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-contracts/contract-request/private.-decline-contract-request-by-nhs
Resource	/api/contract_requests/{{id}}/actions/decline
Scope	contract_request:update
Components	API paragraph not found
Microservices	API paragraph not found
Protocol type	REST
Request type	PATCH
Sync/Async	Sync

Logic*

Contract request only in status IN_RPOCESS could be declined. To decline contract next fields must be signed by NHS employee and sent by same NHS employee in base64 format (all fields below are required): In DS EDRPOU/DRFO must be equal to contractor_legal_entity.edrpou

Code Block

{
"id":"09106b70-18b0-4726-b0ed-6bda1369fd52",
"contractor_legal_entity": {
      "id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "name": "Клініка Ноунейм",
      "edrpou": "32323454"
    },
"next_status": "DECLINED",
"status_reason": "Не відповідає попереднім домовленостям",
"text": "consent_text"
}

Input parameters

Input parameter	Values	Type	Description	Example
id		String		`b075f148-7f93-4fc2-b2ec-2d81b19a9b7b`

Request structure*

See on Apiary

Example:

Expand

title	Request example

Code Block

{
  "signed_content": "ew0KImlkIjoiMDkxMDZiNzAtMThiMC00NzI2LWIwZWQtNmJkYTEzNjlmZDUyIiwNCiJjb250cmFjdG9yX2xlZ2FsX2VudGl0eSI6IHsNCiAgICAgICJpZCI6ICJkZjlmNzBlZS00YjEyLTQ3NDAtYjBmNS1iYjVhZWExMTY4NjMiLA0KICAgICAgIm5hbWUiOiAi0JrQu9GW0L3RltC60LAg0J3QvtGD0L3QtdC50LwiLA0KICAgICAgImVkcnBvdSI6ICIzMjMyMzQ1NCINCiAgICB9LA0KInN0YXR1c19yZWFzb24iOiAi0J3QtSDQstGW0LTQv9C+0LLRltC00LDRlCDQv9C+0L/QtdGA0LXQtNC90ZbQvCDQtNC+0LzQvtCy0LvQtdC90L7RgdGC0Y/QvCINCiJ0ZXh0IjogInN0YXRpY190ZXh0Ig0KfQ==",
  "signed_content_encoding": "base64"
}

Authorize*

Request to process the request using a token in the headers

Headers*

Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Validation data request*

Validate request

Check that all fields are present in signed content
1. "id"
2. "contractor_legal_entity":
  1. "id"
  2. "name"
  3. "edrpou"
3. "next_status"
4. "status_reason"
5. "text"
Check next_status='DECLINED'
Validate contract request id.
1. Check contract_requests.id = $.id
  1. in case error return 404 ("Contract request with id=$id doesn't exist")
Validate contractor_legal_entity_id
1. Legal_entities.id = $.contractor_legal_entity.id and Legal_entities.status='ACTIVE' and is_active=true,
  1. in case error return 422 ("Legal entity in contract request should be active")
2. $contractor_legal_entity.edrpou in request=prm.legal_entities.edrpou
3. $contractor_legal_entity.name in request=prm.legal_entities.name

Validate token

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

Validate user

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)
Check user role = "NHS ADMIN SIGNER"
- in case error return 403 "User is not allowed to perform this action"

Validate scopes

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

Validate EDRPOU

Check that EDRPOU in Certificate details exists and not empty
1. in case of error return 422 error ('Invalid EDRPOU in DS')
Check that EDRPOU in Certificate details is equal to EDPOU in legal entity
1. Get client_id from token.
2. Find prm.legal_entities id by client_id
3. Compare EDRPOU in Certificate with legal_entities.edrpou
4. In case validation fails - generate 422 error
Check that SURNAME in Certificate details is equal to LAST_NAME in Party
1. Get user_id → user_parties.party_id → parties.last_name and compare to surname from DS
  1. Convert prm.parties.LAST_NAME and Certificate details.SURNAME to uppercase
  2. Compare prm.parties.LAST_NAME and Certificate details.SURNAME as Cyrillic letters
  3. In case validation fails - generate 422 error

Validate DRFO

Get parties.tax_id using party_users.party_id by user_id.
Compare DRFO in Certificate with party.tax_id
1. Convert DRFO and TAX_ID to uppercase
2. Compare DRFO and TAX_ID as Cyrillic letters
3. Convert DRFO to Cyrillic and compare as Cyrillic letters
In case validation fails - generate 422 error

Validate contract request status

Check contract_request.status=IN_PROCESS
- in case error return 422 - "Incorrect status of contract_request to modify it"

Digital signature

Decode content that is encrypted in an electronic digital signature.
Use Digital signature WS. Method checks digital signature and returns result.

Processing*

Save signed contract request to media storage

Get url for contract request upload.

Parameter	Source
action	'GET'
bucket	'CONTRACT_REQUEST'
resource_id	: CONTRACT_REQUEST_ID
resource_name	: CONTRACT_REQUEST_DECLINED
timestamp	:TIMESTAMP

Upload signed declaration to media storage

Add status to event manager

After status was changed (status = APPROVED, DECLINED, TERMINATED, NHS_SIGNED or SIGNED) - add new status to event_manager

field	value
`event_type`	`StatusChangeEvent`
`entity_type`	Contract_request
`entity_id`	$.id
`properties.status.new_value`	$.status
`event_time`	$.update_at
`changed_by`	$.`changed_by`

Response structure*

See on Apiary

Example:

Expand

title	Response example

Code Block
{ "meta": { "

coding

code":

[

201,

{ "system

"url": "

eHealth/composition_categories

https://example.com/resource",

code

type": "

LIVE_BIRTH

object",
    "request_id":

}

"req-adasdoijasdojsda"

]

},
  "

type

data": {
    "

coding

id":

[

"09106b70-18b0-4726-b0ed-6bda1369fd52",

{

  "contract_type": "CAPITATION",

system

contractor_legal_entity":

"eHealth/composition_types",

{
      "

code

id": "

NEWBORN"

df9f70ee-4b12-4740-b0f5-bb5aea116863",

}

"name": "Клініка Ноунейм",

]

},

event

edrpou":

[

"32323454",

{

   "addresses": [

"code":

    {
          "

coding

type":

[

"RESIDENCE",

{

"country": "UA",

system

area": "

eHealth/composition_events

Житомирська",

code

region": "

COMPOSITION_VALIDITY_PERIOD

Бердичівський",

}

"settlement": "Київ",

]

  "settlement_type": "CITY",

},

period

settlement_id": "b075f148",

{

start

street_type": "

2020-06-26T15:22:53.403Z

STREET",
          "

end

street": "

2020-07-26T15:22:53.403Z"

вул. Ніжинська",

}

"building": "15",

],

"subject":

{

    "apartment": "

type": {

23",
          "

coding

zip":

[

"02090"

{

}
      ]

"system": "eHealth/composition"

 },
    "contractor_owner": {
      "

code

id": "

string"

b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "party": {

}

]

"first_name": "Петро",
        "

text

last_name": "

string

Іванов",

},

value

second_name": "

e49abc30-6d17-11ea-b83c-673680173afa

Миколайович"
      }

,

"encounter": {

 },
    "

type

contractor_base":

{

 "на підставі закону про Медичне обслуговування населення",
    "

coding

contractor_payment_details":

[

{
      "bank_name": "Банк

{

номер 1",

system

MFO": "

eHealth/composition

351005",

"code

"payer_account": "

string

32009102701026"
    },

}

 "contractor_rmsp_amount": 50000,

],

"contractor_divisions": [

"text": "string"

},

value

id": "

e49abc30

2922a240-

6d17

63db-

11ea

404e-

b83c

b730-

673680173afa

09222bfeb2dd"

}

"author":

{

type

name":

{

"Бориспільське відділення Клініки Ноунейм",
        "

coding

addresses": [
          {
            "

system

type": "

eHealth/composition

RESIDENCE",
            "

code

country": "

string

UA",

}

    "area": "Житомирська",

],

text

region": "

string

Бердичівський",

},

value

settlement": "

e49abc30-6d17-11ea-b83c-673680173afa"

Київ",

},

"section":

{

focus

settlement_type":

{

"CITY",

"type":

{

     "settlement_id": "b075f148",

"coding":

[

{

"street_type": "STREET",
            "

system

street": "

eHealth/composition

вул. Ніжинська",
            "

code

building": "

string

15",

}

  "apartment": "23",

],

text

zip": "

string

02090"
          }

,

"value": "e49abc30-6d17-11ea-b83c-673680173afa"

],

}

},

extension

phones": [

{

"valueCode":

"AUTHORIZE_WITH",

valueUuid

type": "

3fa85f64-5717-4562-b3fc-2c963f66afa6"

MOBILE",

},

{

valueCode

number": "

IS_ACCIDENT",

+380503410870"

"valueBoolean":

true

},

],

{

valueCode

email": "

TREATMENT_VIOLATION

email@example.com",

"valueString":

late

working_

arrival

hours":

},

{

valueCode

mon":

"TREATMENT_VIOLATION_DATE",

"valueDate":

"2020-12-12"

},

{

"valueCode":

IS_INTOXICATED

08.00",

"valueBoolean": true

},

"12.00"

{

"valueCode": "IS_FOREIGN_TREATMENT",

],

"valueBoolean":

true

},

{

"valueCode":

IS_FORCE_RENEW

14.00",

"valueBoolean": true

        "18.00"

}

Authorize*

Вимоги до авторизації: яким чином надається доступ до використання методу

Request to process the request using a token in the headers

Headers*

Наприклад:

Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
api-key:uXhEczJ56adsfh3Ri9SUkc4en

Validate request*

Наприклад:

Validate request using JSON schema
1. In case validation failed - generate 422 error

Code Block

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "verification_code": {
      "type": "string"
    }
  },
  "required": [
    "verification_code"
  ],
  "additionalProperties": false
}

Validation data request*

Валідація даних

Parameters that are used when processing the request

Configuration parameters

Наприклад: Доступ до методу визначається скоупом covid_certificate:get . Дозвіл на даний скоуп визначається адміністратором Системи шляхом конфігурування скоупів в контексті клієнтів і ролей.

Dictionaries

Потрібно вказати словники, які використовує метод API

Processing*

Потрібно описати процеси, які відбуваються з даними

1. Using global parameters

Потрібно викликати глобальні параметри (Global parameters), щоб отримати наведені нижче параметри

Response structure*

See on Apiary

Example:

Code Block

{ "data": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "status": "PENDING", "eta": "string", "doneAt": "string", "links": [ {

"entity": "eHealth/composition",

 ],
          "

href": "composition/0daaad78-6cfb-11ea-9cd6-afab698838bc",

error

12.00"

:

"string"

}

} }

Post-processing processes*

Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо

HTTP status codes

...

HTTP status code

...

Message

...

What caused the error

Backward compatibility

Сумісність з попередніми версіями методу

Purpose

This WS is designed to change status of contract request to DECLINED by NHS ADMIN SIGNER. NHS employee can change status of contract request through Admin portal. If NHS Admin wants to decline contract request he/she need to enter a reason.

Design

TBD

Specification

apiary

json schema

Request

status_reason

Validation

Validate token

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

Validate user

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)
Check user role = "NHS ADMIN SIGNER"
- in case error return 403 "User is not allowed to perform this action"

Validate scopes

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

Digital signature

Decode content that is encrypted in an electronic digital signature.
Use Digital signature WS. Method checks digital signature and returns result.

Validate EDRPOU

Check that EDRPOU in Certificate details exists and not empty
1. in case of error return 422 error ('Invalid EDRPOU in DS')
Check that EDRPOU in Certificate details is equal to EDPOU in legal entity
1. Get client_id from token.
2. Find prm.legal_entities id by client_id
3. Compare EDRPOU in Certificate with legal_entities.edrpou
4. In case validation fails - generate 422 error
Check that SURNAME in Certificate details is equal to LAST_NAME in Party
1. Get user_id → user_parties.party_id → parties.last_name and compare to surname from DS
  1. Convert prm.parties.LAST_NAME and Certificate details.SURNAME to uppercase
  2. Compare prm.parties.LAST_NAME and Certificate details.SURNAME as Cyrillic letters
  3. In case validation fails - generate 422 error

Validate DRFO

Get parties.tax_id using party_users.party_id by user_id.
Compare DRFO in Certificate with party.tax_id
1. Convert DRFO and TAX_ID to uppercase
2. Compare DRFO and TAX_ID as Cyrillic letters
3. Convert DRFO to Cyrillic and compare as Cyrillic letters
In case validation fails - generate 422 error

Validate request

Check that all fields are present in signed content
1. "id"
2. "contractor_legal_entity":
  1. "id"
  2. "name"
  3. "edrpou"
3. "next_status"
4. "status_reason"
5. "text"
Check next_status='DECLINED'
Validate contract request id.
1. Check contract_requests.id = $.id
  1. in case error return 404 ("Contract request with id=$id doesn't exist")
Validate contractor_legal_entity_id
1. Legal_entities.id = $.contractor_legal_entity.id and Legal_entities.status='ACTIVE' and is_active=true,
  1. in case error return 422 ("Legal entity in contract request should be active")
2. $contractor_legal_entity.edrpou in request=prm.legal_entities.edrpou
3. $contractor_legal_entity.name in request=prm.legal_entities.name

Validate contract request status

Check contract_request.status=IN_PROCESS
- in case error return 422 - "Incorrect status of contract_request to modify it"

Response

mapping

...

field

...

value

...

status

...

DECLINED

...

status_reason

...

$.status_reason

...

updated_at

...

now()

...

updated_by

...

$.user_id

...

nhs_signer_id

...

$.user_id

...

nhs_legal_entity_id

...

$.client_id

Save signed contract request to media storage

Get url for contract request upload.

...

Parameter

...

Source

...

Upload signed declaration to media storage

Add status to event manager

After status was changed (status = APPROVED, DECLINED, TERMINATED, NHS_SIGNED or SIGNED) - add new status to event_manager

...

field

...

value

...

event_type

...

StatusChangeEvent

...

entity_type

...

Contract_request

...

entity_id

...

$.id

...

properties.status.new_value

...

$.status

...

event_time

...

$.update_at

...

changed_by

...

      ],
          "fri": [
            [
              "08.00",
              "12.00"
            ]
          ]
        },
        "mountain_group": false
      }
    ],
    "contractor_employee_divisions": [
      {
        "employee": {
          "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
          "party": {
            "first_name": "Петро",
            "last_name": "Іванов",
            "second_name": "Миколайович"
          },
          "speciality": {
            "speciality": "THERAPIST",
            "speciality_officio": true,
            "level": "FIRST",
            "qualification_type": "AWARDING",
            "attestation_name": "Академія Богомольця",
            "attestation_date": "2017-02-28",
            "valid_to_date": "2020-02-28",
            "certificate_number": "AB/21331"
          }
        },
        "staff_units": 0.5,
        "declaration_limit": 2000,
        "division_id": "2922a240-63db-404e-b730-09222bfeb2dd"
      }
    ],
    "external_contractor_flag": true,
    "external_contractors": [
      {
        "legal_entity": {
          "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
          "name": "Клініка Ноунейм"
        },
        "contract": {
          "number": "1234567",
          "issued_at": "2018-01-01",
          "expires_at": "2019-01-01"
        },
        "divisions": [
          {
            "id": "2922a240-63db-404e-b730-09222bfeb2dd",
            "name": "Бориспільське відділення Клініки Ноунейм",
            "medical_service": "Послуга ПМД"
          }
        ]
      }
    ],
    "id_form": "PMD_1",
    "nhs_signer": {
      "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "party": {
        "first_name": "Петро",
        "last_name": "Іванов",
        "second_name": "Миколайович"
      }
    },
    "nhs_legal_entity": {
      "id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "name": "Клініка Ноунейм",
      "edrpou": "32323454",
      "addresses": [
        {
          "type": "RESIDENCE",
          "country": "UA",
          "area": "Житомирська",
          "region": "Бердичівський",
          "settlement": "Київ",
          "settlement_type": "CITY",
          "settlement_id": "b075f148",
          "street_type": "STREET",
          "street": "вул. Ніжинська",
          "building": "15",
          "apartment": "23",
          "zip": "02090"
        }
      ]
    },
    "nhs_signer_base": "на підставі наказу",
    "nhs_contract_price": 50000,
    "nhs_payment_method": "BACKWARD",
    "status": "NEW",
    "status_reason": "Не відповідає попереднім домовленостям",
    "issue_city": "Київ",
    "contract_number": "0000-9EAX-XT7X-3115",
    "contract_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
    "parent_contract_id": "22e416c4-5747-41cd-9f73-c3a85cdee885",
    "start_date": "2017-04-20",
    "end_date": "2017-04-20",
    "printout_content": "Contract request content",
    "previous_request_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
    "assignee_id": "22e416c4-5747-41cd-9f73-c3a85cdee885"
  }
}

Expand

title	Response example

Code Block

{
  "meta": {
    "code": 201,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
    "contract_type": "REIMBURSEMENT",
    "contractor_legal_entity": {
      "id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "name": "Клініка Ноунейм",
      "edrpou": "32323454",
      "addresses": [
        {
          "type": "RESIDENCE",
          "country": "UA",
          "area": "Житомирська",
          "region": "Бердичівський",
          "settlement": "Київ",
          "settlement_type": "CITY",
          "settlement_id": "b075f148",
          "street_type": "STREET",
          "street": "вул. Ніжинська",
          "building": "15",
          "apartment": "23",
          "zip": "02090"
        }
      ]
    },
    "contractor_owner": {
      "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "party": {
        "first_name": "Петро",
        "last_name": "Іванов",
        "second_name": "Миколайович"
      }
    },
    "contractor_base": "на підставі закону про Медичне обслуговування населення",
    "contractor_payment_details": {
      "bank_name": "Банк номер 1",
      "MFO": "351005",
      "payer_account": "32009102701026"
    },
    "id_form": "RMB-1",
    "nhs_signer": {
      "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "party": {
        "first_name": "Петро",
        "last_name": "Іванов",
        "second_name": "Миколайович"
      }
    },
    "nhs_legal_entity": {
      "id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "name": "Клініка Ноунейм",
      "edrpou": "32323454",
      "addresses": [
        {
          "type": "RESIDENCE",
          "country": "UA",
          "area": "Житомирська",
          "region": "Бердичівський",
          "settlement": "Київ",
          "settlement_type": "CITY",
          "settlement_id": "b075f148",
          "street_type": "STREET",
          "street": "вул. Ніжинська",
          "building": "15",
          "apartment": "23",
          "zip": "02090"
        }
      ]
    },
    "nhs_signer_base": "на підставі наказу",
    "nhs_contract_price": 50000,
    "nhs_payment_method": "BACKWARD",
    "status": "NEW",
    "status_reason": "Не відповідає попереднім домовленостям",
    "issue_city": "Київ",
    "contract_number": "0000-9EAX-XT7X-3115",
    "contract_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
    "parent_contract_id": "22e416c4-5747-41cd-9f73-c3a85cdee885",
    "start_date": "2017-04-20",
    "end_date": "2017-04-20",
    "printout_content": "Contract request content",
    "previous_request_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
    "assignee_id": "22e416c4-5747-41cd-9f73-c3a85cdee885",
    "medical_programs": [
      "3914a240-63db-404e-b730-09222bfeb2d0"
    ]
  }
}

Response mapping

field	value
status	DECLINED
status_reason	$.status_reason
updated_at	now()
updated_by	$.user_id
nhs_signer_id	$.user_id
nhs_legal_entity_id	$.client_id

Post-processing processes*

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error
200

Page Comparison

Versions Compared

Old Version 19

New Version 20

Key

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Preconditions

Global and configuration parameters

Input parameters

Filters

Request structure*

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Input parameters

Request structure*

Authorize*

Headers*

Validation data request*

Validate request

Validate token

Validate user

Validate scopes

Validate EDRPOU

Validate DRFO

Validate contract request status

Digital signature

Processing*

Save signed contract request to media storage

Add status to event manager

Response structure*

Authorize*

Headers*

Validate request*

Validation data request*

Parameters that are used when processing the request

Configuration parameters

Dictionaries

Processing*

1. Using global parameters

Response structure*

Post-processing processes*

HTTP status codes

Backward compatibility

Purpose

Design

Specification

Request

Validation

Validate token

Validate user

Validate scopes

Digital signature

Validate EDRPOU

Validate DRFO

Validate request

Validate contract request status

Response

Save signed contract request to media storage

Add status to event manager

Response mapping

Post-processing processes*

HTTP status codes