Specification

Apiary

Service logic

1. Only authenticated and authorized user can use declaration requests

...

Purpose

This WS is designed to get declaration requests list.

Key features

1. Only authenticated and authorized employee with appropriate scope can get declaration requests list.

2. The service returns only a declaration requests that were created in the same legal entity as the user

3. Method returns shortened declaration request details, to obtain full information - use Get Declaration request by ID method.

Specification

Logic

1. Extract client_id from token. Filter declaration requests by client_id (legal_entity_id)

2. Filter declaration requests to show only originated by legal entity or shared with legal entity (channel == MIS OR is_shareable == True)

3. Filter declaration requests by search params (If legal_entity_id is differ from client_id in token - empty list must be returned)

4. Render found declaration requests with shortened details according to specification

Filters

Authorize

1. Verify the validity of access token

...

1. • in case of error - return 401 (“Invalid access token”) in case of validation fails

2. Verify that token is not expired

   • in case of error - return 401 (“Invalid access token”)

3. Check user scopes in order to perform this action (scope = 'declaration_request:read')

...

1. • return 403 (“Your scope does not allow to access this resource. Missing allowances: declaration_request:read”) in case of invalid scope(s)

Headers

• Content-Type:application/json

• Authorization:Bearer {{access_token}}

• X-Custom-PSK:{{secret}}

Response structure

See on Apiary

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "start_date": "2017-03-02",
      "end_date": "2025-03-02",
      "status": "NEW",
      "status_reason": "not relevant",
      "channel": "MIS",
      "person_id": "4fa9cac7-8950-44db-9294-0daba56eed58",
      "employee_id": "60a797bb-43c5-463d-86ee-68e354cb626b",
      "division_id": "4c9c9c6e-5230-444d-8b65-7678da1c1ab3",
      "legal_entity_id": "56b8bcd7-78b8-4ff7-8a60-a48e54a6ef57",
      "authorize_with": "cc949559-5dfe-420f-ac05-065e443b2cc6",
      "parent_declaration_id": "8c7753fc-a647-435f-8e43-4ff4546431f6",
      "system_declaration_limit": 900,
      "current_declaration_count": 675
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

Backward compatibility

This endpoint returns declaration requests that were created through V2 and V3. Field person_id will be empty for declaration request V2.

Filtered by

...

legal_entity_id

...

employee_id

...