Required parameters are marked with "*"

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

Purpose*

This method allows to get existing contract divisions by its id for contracts with GB_CBP type through the NHS IT system

Specification*

Link	https://uaehealthapi.docs.apiary.io/#reference/private.-contracts/private-contract-divisions/private.-get-contract-division-by-id
Resource	/api/admin/contract_divisions/{{id}}
Scope	private_contracts:read
Components	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC
Protocol type	REST
Request type	GET
Sync/Async	Sync

Logic*

This method allows to get existing contract divisions by its id for contracts with GB_CBP type through the NHS IT system

Input parameters

Input parameter	Values	Type	Description	Example
id		String	Contract division identifier	`b075f148-7f93-4fc2-b2ec-2d81b19a9b7b`

Request structure*

API paragraph not found

Authorize*

Verify the validity of api-key
1. Return 401 in case validation fails
Verify the validity of token
1. Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'private_contracts:read')
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*

Validate request

Only authenticated and authorized user can use this service
Deleted records won't be shown in response

Processing*

Show requested contract divisions for contracts with type = GB_CBP

Response structure*

See on Apiary

Example:

Response example

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "8be63914-a278-470b-b868-1af5b9087332",
    "division_id": "4b6b3b53-282a-415b-8f88-f1c7ab65f4a3",
    "contract_id": "71e51746-cc88-46e1-95ab-19cc5911d74c",
    "is_active": true,
    "inserted_at": "2017-04-20T19:14:13Z",
    "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
    "updated_at": "2017-04-20T19:14:13Z",
    "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
  }
}

Post-processing processes*