Properties of a REST API method document

Document type	Метод REST API
Document title	[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-005-010-006-0208
Microservices (namespace)	IL
Component	Patient Cabinet
Component ID	COM-005-010
Link на API-специфікацію
Resource	{{host}}/private/cabinet/email_validation
Scope
Protocol type	REST
Request type	POST
Sync/Async	Sync
Public/Private	Private

Purpose

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

{
  "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

	Input parameter	Mandatory	Type	Description	Example
1
2

Request structure

See on API-specification

Headers

Request data validation

N/A

Processing

N/A

Response structure examples

See on API-specification

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InNwLnZpcm55QGdtYWlsLmNvbSIsInRpbWVzdGFtcCI6IjIwMTgtMDItMjggMTA6Mzg6MDAifQ.LJRLTqK-zf9gxDNMONcI8cMCSYosDtmAIZqhzZUdhz4"
  }
}

{
  "meta": {
    "code": 409,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "error": {
    "type": "conflict",
    "message": "User with this email already exists"
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description

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

Post-processing processes

N/A

Technical modules where the method is used

Название	ID ТМ	Статус

Название	ID ТМ	Статус
RC-V.2.1 [TM-011] Відхилення ЕР фармацевтом	TM0112
RC-V.2.1 [TM-011] Відхилення ЕР фармацевтом

[DRAFT] Email Validation [API-005-010-006-0208]

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used