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

[DRAFT] Create Legal Entity [API-005-009-002-0184]

Owned by Kateryna Yakovleva

Last updated: yesterday at 8:11 PM by Anastasiia Prokhorova (SoE eHealth)

1 min read

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

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

1 Properties of a REST API method document
2 Purpose
3 Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
10 Processing
11 Response structure examples
12 HTTP status codes
13 Post-processing processes
14 Technical modules where the method is used

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-009-002-0184
Microservices (namespace)	IL
Component	Legal Entities
Component ID	COM-005-009
Link на API-специфікацію
Resource	{{host}}/legal_entities
Scope
Protocol type	REST
Request type	POST
Sync/Async	Sync
Public/Private	Private

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1
2

Request structure

See on API-specification

Headers

Request data validation

Processing

Response structure examples

See on API-specification

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2
3
4	Специфічні
5

Post-processing processes

Technical modules where the method is used

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