| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| 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 | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
This web service allows to initialize the contract request creation by generating links for the contract_request documents upload.
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)N/A
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 ConfluenceN/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | contract_type | CAPITATION or REIMBURSEMENT | String | Required |
|
| 2 |
Request structure
See on API-specification
| Expand | ||
|---|---|---|
| ||
|
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
|
Headers
Request data validation
Authorize
Request to process the request using a token in the headers
Validate token
Verify the validity of access token
Return 401 in case validation fails
Check if token is not expired
in case error return 401 - "Token is expired"
Validate user
extract user_id from token
...
Check if user is active
in case error return 403 - (user is not active)
check legal_entity is active
in case error return 403 - (Client is not active)
Check user role is "OWNER"
in case error return 403 "User is not allowed to perform this action"
Validate scopes
Check user scopes in order to perform this action (scope = 'contract_request:create')
Return 403 in case invalid scope(s) "Your scope does not allow to access this resource. Missing allowances: contract_request:create"
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST APIN/A
Response structure examples
Set
field | value |
|---|---|
$id | contract_request.id |
$statute_url | link to Storage for uploading contract_request_statute |
$additional_document_url | link to Storage for uploading contract_request_additional_document_url |
See on API-specification
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 | Response |
| ||
| 3 | 401 | Access token validation failed | |||
| 4 | 401 | Error |
| ||
| 5 | 401 | Token is expired | |||
| 6 | 403 | Client is not active | |||
| 7 | 403 | Error | |||
| 8 | 403 | Your scope does not allow to access this resource. Missing allowances: contract_request:create | |||
| 9 | 403 | User is not allowed to perform this action | |||
| 10 | 403 | User is not active | |||
| 11 | Специфічні | ||||
| 12 | |||||
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
| Page Properties Report | ||||
|---|---|---|---|---|
|
...