Properties of a REST API method document

Document type
Document name
Guideline ID
Author
Document version
Document status
Date of creation
Method ID
Microservices (namespace)	MPI
Components
Link ApiAry	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-details
Resource
Scope
Protocol type
Request type
Sync/Async
Public/Private/Internal

Purpose

Logic

Key points

It provides important information about the main aspects of this method. It offers specific key points that are important for understanding and using this method

Input parameters

Input parameter	Values	Type	Description	Example

Request structure

Request example

Insert request code

Authorize

Headers

Request data validation

Dictionaries

Processing

Service Logic

Response structure

Example:

Response example. Code: 200

Insert answer code

Response example. Code: 403

Insert answer code

HTTP status codes

HTTP status code	Message	What caused the error

Technical modules where the method is used

DRAFT-V.5.1 [AS-API-001-001-001-0003] Create drug