Purpose
Use this method to obtain a list of Declaration Requests for an employee_id
Key features
Only authenticated and authorized user can use declaration requests.
Specification
Link | |
Resource | /api/v3/declaration_requests |
Scope | declaration_request:read |
Components | Declarations |
Microservices | il/api ops/api |
Protocol type | REST |
Request type | GET |
Sync/Async | API paragraph not found |
Public/Private/Internal | Public |
Logic
API paragraph not found
Filters
Filter | Values | Type | Description | Example |
---|---|---|---|---|
employee_id |
| String | user_id of a doctor |
|
legal_entity_id | String | MSP ID |
| |
status |
| Enum |
|
|
page | Number | Page number | 2 | |
page_size | Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 | 50 |
Request structure
API paragraph not found
Authorize
Verify the validity of access token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'declaration_request:read')
Return 403 in case invalid scope(s)
Request to process the request using a token in the headers.
Headers
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Validation data request
API paragraph not found
Processing
API paragraph not found
Response structure
Post-processing processes
API paragraph not found
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 | Response |
|
401 |
| Access token validation failed |
403 |
| Invalid scope |
Backward compatibility
This endpoint returns declaration requests that were created through V2 and V3. Field person_id
will be empty for declaration request V2.