Info |
---|
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
Describe the purpose of the API method, add Key points (if necessary)
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
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
This method must be used to update existing division in the system.
Note that different legal entity types can register specific division types and address types accordingly More details can be found here
Logic
Only authenticated and authorized user of this legal entity with appropriate scope can update division.
Division can be updated for RESIDENCE, REGISTRATION addresses types.
Division can be updated for legal entities in ACTIVE or SUSPENDED statuses.
Editable information on division:
name
addresses
phones
email
add the gps-coordinates attributed to the division (location)
working hours
Configuration parameters
N/A
Dictionaries
Dictionary ADDRESS_TYPE
Dictionary PHONE_TYPE
Dictionary SETTLEMENT_TYPE
Dictionary STREET_TYPE
Dictionary DIVISION_TYPE
Dictionary COUNTRY
Input parameters
Input parameter | Mandatory | Type | Description | Example | |||||
---|---|---|---|---|---|---|---|---|---|
1 | composition_id | M | String ($uuid) (path) | Composition object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 | 2 | Required | d290f1ee-6c54-4b01-90e6-d701748f0851 | |
2 |
Parameter | Source |
---|---|
action | `PATCH` |
id |
|
external_id | $.external_id |
name | $.name |
type | $.type |
addresses | $.addresses |
phones | $.type, $.number |
inserted_at | :timestamp |
updated_at | :timestamp |
legal_entity_id | take from token |
location | $.latitude, $.longitude |
status | ACTIVE |
is_active | true |
working_hours | $.working_hours |
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example
Expand | ||
---|---|---|
| ||
|
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
Request data validation
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
Description of the REST API response structure, example
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Headers
Request data validation
Authorize
Verify the validity of access token
Check user scope (scope = 'division:write') in order to perform this action
In case error generate 401 response
If BLOCK_UNVERIFIED_PARTY_USERS is true, then check party's data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at > current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):
in case not match - return 403 ("Access denied. Party is not verified")
Validate location
Location is required for divisions related to legal entity with type PHARMACY
Check that location exists in request for legal entity with type PHARMACY
In case of error - generate 422 response
Validate addresses
Check that addresses.type exists in dictionaries.
In case error generate 422 "value is not allowed in enum"
Check that addresses.area exists in Uaddresses.areas
in case error generate 422 "invalid area value"
Check that addresses.settlement exists in Uaddresses.settlements
in case error generate 422 "invalid settlement value"
Check that addresses.settlement_type exists in dictionaries.
in case error generate 422 "value is not allowed in enum"
Check that addresses.settlement_id exists in Uaddresses.settlements
in case error generate 422 "settlement with id = <id> does not exist"
Check that addresses.street_type exists in dictionaries.
In case error generate 422 "value is not allowed in enum"
Check that addresses.zip in
"^[0-9]{5}$"
format.In case error generate 422 "string does not match pattern \"^[0-9]{5}$\""
Check mapping legal_entity_type, division_type and address_type and its obligation. See validation rules here: Validation rules on Divisions
in case error generate 422 response
Validate phone
Check that phone type exists in dictionaries. PHONE_TYPE required (MOBILE,LAND_LINE)
in case error generate 422 response
Check phone number is valid according to "^\\+38[0-9]{10}$"
in case error generate 422 response
Validate email
Check that email is valid according to "~r/^[\\w!#$%&'*+\\/=?`{|}~^-]+(?:\\.[\\w!#$%&'*+\\/=?`{|}~^-]+)*@(?:[A-Z0-9-]+\\.)+[A-Z]{2,6}$/i"
in case error generate 422 response
Validate type
Check that type exists in dictionaries. Type required (DRUGSTORE,DRUGSTORE2,CLINIC,AMBULANT_CLINIC,FAP)
in case error generate 422 response
Check mapping of legal_entity_type and division type.
in case error generate 422 response
Processing
N/A
Response structure examples
See on API-specification
Expand | |||||
---|---|---|---|---|---|
| |||||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |||||
---|---|---|---|---|---|---|---|---|---|
1 | Базові | ||||||||
2 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | 3 | 401 | Unauthorized | Помилка підтвердження |
4 | Специфічні | 5 | 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
...
200 | Response |
| |||
3 | 401 | Authorization failed | |||
4 | 403 | Access denied | |||
5 | 403 | Access denied. Party is not verified | |||
6 | 422 | invalid area value | |||
7 | 422 | invalid settlement value | |||
8 | 422 | settlement with id = <id> does not exist | |||
9 | 422 | string does not match pattern \"^[0-9]{5}$\" | |||
10 | 422 | Validation failed | |||
11 | 422 | value is not allowed in enum | |||
12 | Специфічні | ||||
13 |
Post-processing processes
N/A
Technical modules where the method is used
Page Properties Report | ||||
---|---|---|---|---|
|
...