Properties of a REST API method document

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)This method allows to delete existing 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

Logic

WS sets is_active = false and the contract will be unavailable

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input parameters

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

Headers

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

...

The following attributes must be validated

1. Validate id

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

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

   2. Check that contract with such id have type = 'GB_CBP'

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

2. Validate contract divisions. There should not be any active records

   1. in case of error return 409 error ('Contract can not be deleted because it has active divisions')

3. Validate contract employees. There should not be any active records

   1. in case of error return 409 error ('Contract can not be deleted because it has active employees')

Validate request

1. Only authenticated and authorized user can use this service

2. Contract with active child entities couldn't be deleted

Processing

1. Update system attributes

Response structure examples

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API response structure, example

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

HTTP status codes

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

...