Purpose
This WS allows to resend sms with OTP-code to the person’s verified phone. Used on approve merge request process in case OTP wasn’t delivered in first time.
Specification
Apiary
...
Specification
| Page Properties |
|---|
|
Link | https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/merge-request/resend-authorization-otp-on-merge-request | Посилання на Apiary або Swagger | Resource | /api/merge_requests/{{id}}/actions/resend_otp | Посилання на ресурс, наприклад: /api/persons/create | Scope | merge_request:write | Scope для доступу | Components | Merge request | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | API paragraph not found | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC | Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | POST | Тип запиту API, наприклад: GET, POST, PATCH… | Sync/Async | Sync | Метод є синхронним чи асинхронним? | Public/Private/Internal | Public | Потрібно зазначити тип методу за ступенем доступності |
|
Logic
Process is similar to IL.Resend Authorization method OTP on Person Request, but with next differences:
Checks merge_request:write scope on Authorization (instead of scope person_request:write)
Saves to il.merge_requests in field authentication_method_current that auth_method_type that person selected.
Input parameters
Input parameter | Values | Type | Description | Example |
|---|
id | | String | Identifier of the merge request. Required | 7c3da506-804d-4550-8993-bf17f9ee0404 |
Request structure
API paragraph not found
Authorize
API paragraph not found
Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
api-key:uXhEczJ56adsfh3Ri9SUkc4en
Request data validation
API paragraph not found
Processing
API paragraph not found
Response structure
See on Apiary
Example:
| Expand |
|---|
|
| Code Block |
|---|
{
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
},
"data": {
"id": "7d23bebb-1cf3-4221-bf21-18aada444756",
"status": "NEW",
"code_expired_at": "2017-07-10T12:20:16.300597Z",
"active": true
}
} |
|
Post-processing processes
API paragraph not found
HTTP status codes
| Page Properties |
|---|
|
HTTP status code | Message | What caused the error |
|---|
200 | Response | |
|