Versions Compared

Key

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

Purpose

This method allows to get all existing in legal entity contracts with GB_CBP type through the MIS

Specification

Apiary

Page Properties
idAPI_Specification

Link

Apiary

Посилання на Apiary

...

або Swagger

Resource

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

Scope

contract:read

Scope для доступу

Components

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

Microservices

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

Protocol type

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

Request type

GET

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

Sync/Async

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

Public/Private/Internal

Public

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

Logic

  1. Only authenticated and authorized user can use this service

  2. Deleted records won't be shown in response

Request structure

See Apiary

Authorize

  1. Verify the validity of api-key

    1. Return 401 in case validation fails

  2. Verify the validity of token

    1. Return 401 in case validation fails

  3. Check scopes in order to perform this action (scope = 'contract:read')

    1. Return 403 in case invalid scope(s)

...

Headers

Request data validation

Processing

  1. Search contracts in DB according to requested query parameters

    1. If contractor_legal_entity_id from contract according to requested parameters not equal client_id from token, show 404 Not found instead

  2. Exclude deleted records (is_active = false)

Response structure

See Apiary

Expand
titleResponse example
Code Block
111

Post-processing processes

HTTP status codes