Versions Compared

Old Version 4

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

compared with

New Version 5

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
REST API method / Метод REST API (настанова) (
Info
Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the 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-002-0052

Microservices (namespace)

IL

Component

Contracts

Component ID

COM-005-002

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-contracts/contract-request/public.-get-contract-request-printout-content

Resource

{{host}}/api/contract_requests/{{contract_type}}/{{id}}/printout_content

Scope

contract_request:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

...

This method is designed to get printout content by contract request id. In order to sign contract it's need to invoke Get Contract Request Details and Get Contract Request Printout Content and sign whole data.

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

...

parameters

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

contract request identifier

d290f1ee-6c54-4b01-90e6-d701748f0851

2

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example

Expand
titleExample
Code Block
...
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
Authorize
Request to process the request using a token in the headers
Validate request
Request mapping:
...
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": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "printout_content": "Contract request content"
  }
}
...
Only for active MPI record can be created medication request!
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
3
401
Unauthorized
Помилка підтвердження
4
403
Client is not active
54
403
user is not active
65
403
Your scope does not allow to access this resource. Missing allowances: contract_requests:read
76
403
User is not allowed to perform this action
87
404
Contract request with id=$id doesn't exist
9
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
108
409
Incorrect status of contract_request to generate printout form
119
Специфічні
12
422
10
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"
...