ЕСОЗ - публічна документація
[DRAFT] Reject declaration [API-005-004-001-0061]
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.
Document type | Метод REST API |
---|---|
Document title | [DRAFT] Reject declaration [API-005-004-001-0061] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-005-004-001-0061 |
Microservices (namespace) | IL |
Component | Declarations |
Component ID | COM-005-004 |
Link на API-специфікацію | |
Resource | {{host}}/declarations/{{id}}/reject |
Scope | declaration:reject |
Protocol type | REST |
Request type | PATCH |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This method is used by NHS_admin to reject declarations that has been created with the offline authorization. In case if the verification result is not acceptable. declaration status will be changed to closed
.
Logic
N/A
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | id |
| String | Required | d290f1ee-6c54-4b01-90e6-d701748f0851 |
2 |
|
|
|
|
|
Request structure
See on API-specification
Headers
Request data validation
Authorize
Verify the validity of access token
Check user scope declaration:reject in order to perform this action
In case error - return 401 error.
Validate transition
Validate transitionю Allowed transitions:
pending_verification → closed
Check is_active = true
If not passed, Return Error 403 message "Invalid transition"
Processing
Update Declaration status
$declaration.status = closed
$declaration.updated_by = user_id
$declaration.updated_at = timestamp
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
---|---|---|---|---|---|
1 | Базові | ||||
2 |
| 200 | Response |
|
|
3 |
| 401 |
|
|
|
4 |
| 403 | Invalid transition |
|
|
5 | Специфічні | ||||
6 |
|
|
|
|
|
Post-processing processes
N/A
Technical modules where the method is used
ЕСОЗ - публічна документація