Versions Compared

Old Version 5

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

compared with

New Version 6

changes.mady.by.user Oksana Demchenko

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методу]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-005-002-001-0037

Microservices (namespace)

IL

Component

Contracts

Component ID

COM-005-002

Link на API-специфікацію

Resource

{{host}}/api/admin/contract_employees/{{id}}

Scope

private_contracts:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Private

Purpose

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

Logic

WS returns list of contract employee by id

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

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

Contract emplyee identifier

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

2

Request structure

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

Description of the REST API request structure, example

Expand
titleExample
Code Block
Headers
Key
Value
Mandatory
Description
Example
1
Content-Type
application/json
M
Тип контенту
Content-Type:application/json
2
Authorization
Bearer c2778f3064753ea70de870a53795f5c9
M
Перевірка користувача
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
3
Request data validation
Validate request
  1. Only authenticated and authorized user can use this service
  2. Deleted records won't be shown in response
Processing
  1. Show requested contract employees for contracts with type = GB_CBP
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
 Expand
titleExample
 Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "8be63914-a278-470b-b868-1af5b9087332",
    "staff_units": 1,
    "declaration_limit": 2000,
    "employee_id": "ce050c01-f4a5-4d5f-85d6-7e41d41146bf",
    "division_id": "62d0a654-2e7f-40fb-b1bb-8a38cdc3f701",
    "contract_id": "6bb64748-7707-4be8-86e0-56cfb08e9b88",
    "start_date": "2018-04-20T19:14:13Z",
    "end_date": "2019-04-20T19:14:13Z",
    "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"
  }
}
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
3
401
Unauthorized
Помилка підтвердження
4
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
5
Специфічні
6
422
Only for active MPI record can be created medication request!
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
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...