Versions Compared

Old Version 1

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Oksana Demchenko

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

...

...

Purpose

...

Update global parameters for declarations.

Specification

...

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

Project Name

COVID-certificate

Project abreviation

SVC

Developer

Розробник методу API. Наприклад, Edenlab

Project Manager

@Єлизавета Гессен-Дармштадська

Tech Lead

@Іоанн Воїнов

Product Owner

@Нікодім Святогорцев

Вusiness analyst

@Пантелеймон Нікомедійський

Status

Status
colourGreen
titleAPPROVED

Version

1.0

Date of release

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-global-parameters-and-products/global-parameters/put-global-parameters

Resource

/global_parameters

Scope

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

Components

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

Microservices

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

Protocol type

Link

eHealth API · Apiary

Resource

/global_parameters

Scope

global_parameters:write

Components

Configuration

Microservices

API paragraph not found

Protocol type

REST

Request type

PUT

Sync/Async

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

...

Sync

Public/Private/Internal

Internal

Preconditions

Logic

Method updates global parameters for declarations.

Filters Надо ли использовать атрибуты?

...

Filter

...

Values

...

Type

...

Description

...

Example

...

Global and configuration parameters

Request structure

See on Apiary

Example:

Expand
titleRequest example
Code Block
{
  "declaration_term": "30",
  "declaration_request_expiration": "30",
  "employ_request_expiration": "30",
  "verification_request_expiration": "30",
  "adult_age": "18",
  "billing_date": "2"
}

Authorize

...

Request to process the request using a token in the headers

Headers

...

Наприклад:

Content-Type:application/json

Validate request*

API paragraph not found

Request data validation

...

API paragraph not found

Processing

...

API paragraph not found

Response structure

...

See on Apiary

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "declaration_term": "30",
    "declaration_request_expiration": "30",
    "employ_request_expiration": "30",
    "verification_request_expiration": "30",
    "adult_age": "18",
    "billing_date": "2"
  }
}

Post-processing processes

...

API paragraph not found

HTTP status codes

...

HTTP status code

Message

What caused the error

 200

 

 

Backward compatibility

API paragraph not found