Table of Contents

...

Page Properties
idAPI_Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-contracts/contract-request/public.-initialize-contract-request

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

Resource

/api/contract_requests/{{contract_type}}

Посилання на ресурс, наприклад: /api/persons/create

Scope

contract_request:create

Scope для доступу

Components

Contracts

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

Microservices

API paragraph not found

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

Protocol type

REST

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

Request type

POST

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

API paragraph not found

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

Public/Private/Internal

Public

Потрібно зазначити тип методу за ступенем доступності

Logic

...

Input parameters

Input parameter

Values

Type

Description

Example

contract_type

API paragraph not found

API paragraph not found

API paragraph not foundcould be reimbursement or capitation

Request structure

API paragraph not found

...

Request to process the request using a token in the headers

Headers

Наприклад:

Content-Type:application/json

...

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

    • Return 403 in case invalid scope(s) "Your scope does not allow to access this resource. Missing allowances: contract_request:create"

Processing

...

Response structure

Set 

field

value

$id

contract_request.id

$statute_url

link to Storage for uploading contract_request_statute

$additional_document_url

link to Storage for uploading contract_request_additional_document_url

...