Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Purpose

This WS allows to get detailed LE Reorganization Job info from Admin panel.

...

Page Properties
idAPI_Specification

Link

API paragraph not foundПосилання на Apiary або Swagger

Resource

API paragraph not foundПосилання на ресурс, наприклад: /api/persons/create

Scope

legal_entity_merge_job:read

Scope для доступу

Components

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

Microservices

API paragraph not foundПерелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

API paragraph not found

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

API paragraph not foundТип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

API paragraph not found

Метод є синхронним чи асинхронним?

Public/Private/Internal

Private

Потрібно зазначити тип методу за ступенем доступності

Expand
titlelegalEntityReorganizationJobQuery
Code Block
languagegraphql
  "Reads a single `LegalEntityReorganizationJob` using its globally unique ID."
  legalEntityReorganizationJob(id: ID!): LegalEntityReorganizationJob

...

Request structure

API paragraph not found

...

Authorize

  • Verify the validity of access token

    • in case of error - return 401 (“Invalid access token”) in case of validation fails

  • Verify that token is not expired

    • in case of error - return 401 (“Invalid access token”)

  • Check user scopes in order to perform this action (scope = 'legal_entity_merge_job:read')

    • return 403 (“Your scope does not allow to access this resource. Missing allowances: legal_entity_merge_job:read”) in case of invalid scope(s)

...

Headers

API paragraph not found

Request data validation

Validate legal entity

  • Extract client_id from token.

  • Check client scopes in order to perform this action (scope = 'legal_entity_merge_job:read')

    • in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: legal_entity_merge_job:read”)

  • Check legal entity status (status = ACTIVE)

    • In case of error - return 409 ('client_id refers to legal entity that is not active')

Request data validation

...

Processing

API paragraph not found

...