ЕСОЗ - публічна документація

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 18 Current »

Purpose

Use this method to resend sms with OTP-code on previously created merge request (patient`s authentification method is OTP).

Specification

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

Patient registry

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

il/api

mpi/api

fe/admin-web

Перелік мікросервісів, які використовує метод 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 Resend Authorization OTP on Person Request, but with next differences:

  1. Checks merge_request:write scope on Authorization (instead of scope person_request:write)

  2. 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

See on Apiary

Authorize

  1. Verify the validity of access token

    • Check user scope merge_request:write in order to perform this action.

Headers

Content-Type:application/json

Authorization:Bearer {{access_token}}

Api-key:{{secret}}

Request data validation

  1. Validate auth method. Person must has auth_method.type = OTP or THIRD_PERSON( where third_person.auth_method.type = OTP)

  2. Check that merge_request.status = NEW.

Processing

Process is similar to Resend Authorization OTP on Person Request, but with next difference:

  • Saves to il.merge_requests in field authentication_method_current that auth_method_type that person selected.

Response structure

See on Apiary

Example:

 Response example
{
  "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
  }
}

HTTP status codes

HTTP status code

Message

What caused the error

 200

 Response

 

  • No labels