Required parameters are marked with "*"

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

Purpose*

This method allows to delete existing contract employees 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*

Logic*

API paragraph not found

Input parameters

Request structure*

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

Request data validation*

1. Validate id

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

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

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

      1. in case of error return 409 error ('Only contract employees 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

Response structure*

See on Apiary

Example:

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

Post-processing processes*

API paragraph not found

HTTP status codes*