Table of Contents |
---|
Purpose
This WS is designed registration of a new pharmacy's division
Specification
...
id | API_Specification |
---|
...
Link
...
...
Посилання на Apiary або Swagger
...
Resource
...
/api/divisions
...
Посилання на ресурс, наприклад: /api/persons/create
...
Scope
...
division:write
...
Scope для доступу
...
Components
...
Divisions
...
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
...
Microservices
...
il/api
...
Table of Contents |
---|
Purpose
This method must be used to create new 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
Specification
Page Properties | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
|
Logic
General
Each legal entity can manage its own divisions:
...
Note: Calculate mountain group for each new Divisions based on division addressConfluence: ERD
Acceptance criteria:
Configured Public GET, POST, PATCH methods on GW
Successful response with correct authorization and appropriate scopes
401 error on invalid authorization
403 error on invalid scopes
Legal entity id is missing in request
Legal entity id is set as header by GW
Created divisions saved to DB
Mountain group calculated
Request structure
...
Dictionaries
Dictionary ADDRESS_TYPE
Dictionary PHONE_TYPE
Dictionary SETTLEMENT_TYPE
Dictionary STREET_TYPE
Dictionary DIVISION_TYPE
Dictionary COUNTRY
Request structure
Example:
Expand | ||
---|---|---|
| ||
|
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
Headers
Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{secret}}
Request data validation
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
...
|
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")
Headers
Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{secret}}
Request data validation
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 response"value is not allowed in enum"
Check that address exists in Uaddresses
inaddresses.zip in
"^[0-9]{5}$"
format.In case error generate 422 response"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
...
Processing
Create new division
Parameter | Source |
---|---|
action | `PUT` |
id | |
external_id | $.external_id |
name | $.name |
type | $.type |
mountain_group | |
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 |
Additional
Add new mapping for "division_type" & Legal_entity_type
Check that prm.legal_entities.status = active or suspended and prm.legal_entities.is_active = true for legal entity to which division is added
Add new validation for verification of usage division_type in Legal_entity_type at Create_division process.
There is no other specific logic for new division types.
...