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

Deactivate Black list user

Owned by Serhii Boldin (SoE eHealth)
Last updated: Dec 17, 2022
1 min read

Purpose

This method is used by NHS Admin to deactivate user in black list.

 

Specification

Link

API paragraph not found

Resource

/api/black_list_users/{{id}}/actions/deactivate

Scope

bl_user:deactivate

Components

API paragraph not found

Microservices

API paragraph not found

Protocol type

REST

Request type

PATCH

Sync/Async

Sync

Public/Private/Internal

Internal

 

Logic

This method is used by NHS Admin to deactivate user in black list.

 

Input parameters

Input parameter

Values

Type

Description

Example

Input parameter

Values

Type

Description

Example

id

 

String

 

d290f1ee-6c54-4b01-90e6-d701748f0851

 

Request structure

API paragraph not found

 

Authorize

Request to process the request using a token in the headers

 

Headers

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer c2778f3064753ea70de870a53795f5c9

 

Request data validation

API paragraph not found

 

Processing

API paragraph not found

 

Response structure

See on Apiary

Example:

{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": { "id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "tax_id": "3126509816", "is_active": true, "parties": [ { "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b", "first_name": "Петро", "last_name": "Іванов", "second_name": "Миколайович", "birth_date": "1991-08-19" } ], "inserted_at": "2017-04-20T19:14:13Z", "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e", "updated_at": "2017-04-20T19:14:13Z", "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd" } }

 

{ "meta": { "code": "409", "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "error": { "message": "User is not in a black list" } }

 

Post-processing processes

API paragraph not found

 

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

 200

 

 

 409

 

 

 

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