Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Filter declarations by search params.

  2. Render found declarations with shortened details according to specification.

...

Name

Type

Value

Example

employee_id

String

user_id of a Doctor

d290f1ee-6c54-4b01-90e6-d701748f0851

legal_entity_id

String

MSP ID

d290f1ee-6c54-4b01-90e6-d701748f0851

declaration_number

String

unique Unique human redable number of declaration

0000-12H4-245D

status

String

Default: active

active

reason

String

filter Filter declaration by reason

offline

page

Number

Page number

2

page_size

Number

A limit on the number of objects to be returned, between 1 and 300. Default: 50

50

Request structure

...

Authorize

  • Verify the validity of access token

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

  • Verify that token is not expired

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

  • Check user scopes in order to perform this action (scope = 'declaration:read')

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

...