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 update existing contract divisions for contracts with GB_CBP type through the NHS IT system

...

Page Properties

Link

https://uaehealthapi.docs.apiary.io/#reference/private.-contracts/private-contract-divisions/private.-update-contract-division

Resource

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

Scope

private_contracts:write

Components

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

Microservices

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

Protocol type

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

Request type

PUT

Sync/Async

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

Logic*

This method allows to update existing contract divisions for contracts with GB_CBP type through the NHS IT system

...

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

  2. Contract division must be valid and consistent, i.e. all "foreign keys" must be valid

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' and is_active = true

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

  2. Validate division_id

    1. Check that division exist and is_active = true

      1. in case of error return 404 error $.division_id ('Division is not found')

    2. Check that division_id correspond to contractor legal entity through divisions.legal_entity_id=contracts.contractor_legal_entity_id

      1. in case of error return 409 error $.division_id ('Division is not correspond to contractor legal entity')

  3. Validate contract_id

    1. Check that contract exist and is_active = true and type = GB_CBP

      1. in case error return 409 error $.contract_id ('Contract must be an active and with GB_CBP type')

Validate request

  1. Only authenticated and authorized user can use this service

  2. Contract division must be valid and consistent, i.e. all "foreign keys" must be valid

Processing*

  1. Update system attributes

...