Versions Compared

Key

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

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

This method allows to delete existing contract division for contract with type GB_CBP from DB through the NHS IT system

...

Page Properties

Link

https://ehealthmisapi1.docs.apiary.io/#reference/private.-contracts/private-contract-divisions/private.-delete-contract-division

Resource

/api/admin/contract_divisions/{{id}}

Scope

private_contracts:write

Components

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

Microservices

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

Protocol type

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

Request type

DELETE

Sync/Async

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

Logic*

API paragraph not found

...

Request to process the request using a token in the headers

Headers*

Наприклад:

  • Content-Type:application/json

  • api-key:c2778f3064753ea70de870a53795f5c9

Validate request*

  1. Only authenticated and authorized user can use this service

Request data validation*

The following attributes must be validated

  1. Validate id

    1. Check that contract_division record with id from URL exist and is_active = true

      1. in case of error return 404 error ('Contract division with such id is not found')

    2. Check that contract from contract_division.contract_id have type = 'GB_CBP'

      1. in case of error return 409 error ('Only contract divisions for contract with type GB_CBP can be deleted')

Validate request

  1. Only authenticated and authorized user can use this service

Processing*

  1. Update system attributes

...