Versions Compared

Key

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

Required parameters are marked with "*"

...

Purpose

...

API paragraph not found

Specification

...

Developer
Page Properties

Project Name

COVID-certificate

Project abreviation

SVC

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

Project Manager

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

Tech Lead

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

Product Owner

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

Вusiness analyst

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

Status

Status
colourGreen
titleAPPROVED

Version

1.0

Date of release

Link

https://ehealthmisapi1.docs.apiary.io/#reference/private.-contracts/private-contract-employees/private.-generate-url-to-media-storage

Resource

/api/admin/contracts/media_storage/generate_url

Scope

private_contracts:write

Components

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

Microservices

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

Protocol type

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

Request type

POST

Sync/Async

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

...

Sync

Public/Private/Internal

Private

Logic

API paragraph not found

Filters нужно ли вписывать атрибуты?

...

Filter

...

Values

...

Type

...

Description

...

Example

...

status

...

String

...

Optional

...

Request structure

...

See on Apiary

Example:

Expand
titleRequest example
Code Block
{
  "action": "PUT",
  "resource_id": "f7f817b2-3134-4625-b87d-e2d7fc8e9b90",
  "resource_name": "signed_contract"
}

Authorize

...

Request to process the request using a token in the headers

Headers

...

Наприклад:

  • Content-Type:application/json

  • api-key:c2778f3064753ea70de870a53795f5c9

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": {
    "url": "https://example.com/upload_url"
  }
}

Post-processing processes

...

API paragraph not found

HTTP status codes

...

HTTP status code

Message

What caused the error

 200

 

 

...