Purpose
This WS is designed to get declaration requests list.
...
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 | Sync |
Public/Private/Internal | Public |
...
Logic
Extract
client_id
from token. Filter declaration requests byclient_id
(legal_entity_id
)Filter declaration requests to show only originated by legal entity or shared with legal entity (
channel
== MIS ORis_shareable
== True)Filter declaration requests by search params (If
legal_entity_id
is differ fromclient_id
in token - empty list must be returned)Render found declaration requests with shortened details according to specification
...
Parameter | Value | Type | Description |
---|---|---|---|
employee_id |
| String(UUID) | Employee identifier |
legal_entity_id |
| String(UUID) | Legal entity identifier |
status | Dictionary:
| String | Declaration request status according to Status chart |
channel | Dictionary:
| String | Declaration request channel |
page |
| Number | Page number |
page_size |
| Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
...