Versions Compared

Old Version 2

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Oleksandr Zhuk (SoE eHealth)

Saved on

Key

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

Required parameters are marked with "*"

...

Purpose

...

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

Note that record won't be permanently deleted. It will be marked is_active = false and will be unavailable

Specification

...

Page Properties

Project Name

COVID-certificate

Project abreviation

SVC

Developer

Розробник методу API. Наприклад, Edenlab

Project Manager

@Єлизавета Гессен-Дармштадська

Tech Lead

@Іоанн Воїнов

Product Owner

@Нікодім Святогорцев

Вusiness analyst

@Пантелеймон Нікомедійський

Status

Status
colourGreen
titleAPPROVED

Version

1.0

Date of release

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

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

Microservices

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

Protocol type

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

Request type

DELETE

Sync/Async

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

Logic*

API paragraph not found

Input parameters

Потрібно вказати вхідні параметри запиту. Наприклад, для GET /patients/composition/job/{{asyncJobId}} вхідний параметр:

Sync

Public/Private/Internal

Private

Logic

WS sets is_active = false and the contract divission will be unavailable

Input parameters

Input parameter

Values

Type

Description

Example

id

String

Contract division identifier

b075f148-7f93-4fc2-b2ec-2d81b19a9b7b

...

API paragraph not found

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 = 'private_contracts:write')

    1. Return 403 in case invalid scope(s)

Request to process the request using a token in the headers

Headers

...

Наприклад:

  • Content-Type:application/json

  • api-key:c2778f3064753ea70de870a53795f5c9

Validate request*

...

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

Attribute

Value

is_active

Const: false

updated_at

now() timastamp

updated_by

User from token

Response structure

...

See on Apiary

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {}
}

...

API paragraph not found
HTTP status codes
...
HTTP status code
Message
What caused the error
 200
 
 
...