/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	[DRAFT] Resend Authorization OTP on Declaration Request [API-005-004-002-0084]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-005-004-002-0084
Microservices (namespace)	IL
Component	Declarations
Component ID	COM-005-004
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/declaration-requests/resend-authorization-otp-on-declaration-request
Resource	{{host}}/api/v3/declaration_requests/{{id}}/actions/resend_otp
Scope	otp:write
Protocol type	REST
Request type	POST
Sync/Async	Sync
Public/Private	Public

Purpose

Use this method to resend sms on previously created Declaration Request V3

Logic

N/A

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

	Input parameter	Mandatory	Type	Description	Example
1	id		String	Required	b075f148-7f93-4fc2-b2ec-2d81b19a9b7b
2

Request structure

See on API-specification

Example

Headers

Request data validation

N/A

Processing

N/A

Response structure examples

See on API-specification

Example

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "7d23bebb-1cf3-4221-bf21-18aada444756",
    "status": "NEW",
    "code_expired_at": "2017-07-10T12:20:16.300597Z",
    "active": true
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Description
1	Базові
2		200	Response
3		401	Unauthorized	Помилка підтвердження
4	Специфічні
5

Post-processing processes

N/A

Technical modules where the method is used

[DRAFT] Resend Authorization OTP on Declaration Request [API-005-004-002-0084]

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