Purpose
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
Specification
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
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
id | String | Required | d290f1ee-6c54-4b01-90e6-d701748f0851 |
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 |
Dictionaries
Dictionary ADDRESS_TYPE
Dictionary PHONE_TYPE
Dictionary SETTLEMENT_TYPE
Dictionary STREET_TYPE
Dictionary DIVISION_TYPE
Dictionary COUNTRY
Request structure
Example:
Authorize
Request to process the request using a token in the headers
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. Addresses type required (RESIDENCE,REGISTRATION)
In case error generate 422 response
Check that address exists in Uaddresses
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
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")
Response structure
Example: