/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
...
Properties of a REST API method document
Document type | Метод REST API | |
|---|---|---|
Document title | [Document status] REST API [Назва методу] [ID методуDRAFT] Email Validation [API-005-010-006-0208] | |
Guideline ID | GUI-0011 | |
Author | @ | |
Document version | 1 | |
Document status | DRAFT | |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) | |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) | |
Method API ID | API-001005-001010-001006-00010208 | |
Microservices (namespace) | MPIIL | |
Component | AuthPatient Cabinet | |
Component ID | COM-001005-001010 | |
Link на API-специфікацію | ||
Resource | {{host}}//api.ehealth.gov.ua/api/patients/id/encounter_packageprivate/cabinet/email_validation | |
Scope | ||
Protocol type | REST | |
Request type | POST | |
Sync/Async | Sync | |
Public/Private | Private |
Purpose
Describe the purpose of the API method, add Key points (if necessary)
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
Provides a list of links to dictionaries that are available in Confluence
Input parameters
Description of input parameters
Method allows to verify Email and check whether the link we sent is the same as we received
Logic
Method allows to verify Email and check whether the link we sent is the same as we received
| Code Block |
|---|
{
"email": "example@gmail.com",
"timestamp": "2018-02-28 10:38:00"
}
|
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 |
|
|
|
|
|
| 2 |
|
|
|
|
|
...
| Expand | ||
|---|---|---|
| ||
|
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Request data validation
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST APIHeaders
Request data validation
N/A
Processing
N/A
Response structure examples
See on API-specification
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 |
| 200 |
|
|
|
| 3 |
| 409 |
|
|
|
| 4 | Специфічні | ||||
| 5 |
|
|
|
|
|
Post-processing processes
Description of actions performed on data after processingN/A
Technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||