Purpose

...

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

...

Page Properties
Link https://ehealthmisapi1.docs.apiary.io/#reference/private.-contracts/private-contracts/private.-delete-contract Resource /api/admin/contracts/{{id}} Scope private_contracts:write Components Contracts Microservices API paragraph not found Protocol type REST Request type DELETE Sync/Async Sync Public/Private/Internal Private

Logic

...

WS sets is_active = false and the contract will be unavailable

Input parameters

Request structure*

...

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

...

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

Attribute	Value
is_active	Const: false
updated_at	now() timestamp
updated_by	User from token

Response structure

...

See on Apiary

Example:

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

Post-processing processes*

...

HTTP status codes

...

HTTP status code	Message	What caused the error
200

...