Versions Compared

Key

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

Purpose

This WS is designed to get declaration requests list.

...

Link

https://uaehealthapi.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/declaration-requests/get-declaration-requests-list-v3

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

  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

...

Parameter

Value

Type

Description

employee_id

 

String(UUID)

Employee identifier

legal_entity_id

 

String(UUID)

Legal entity identifier

status

Dictionary:

DECLARATION_REQUEST_STATUSES

String

Declaration request status according to Status chart

/wiki/spaces/PCAB/pages/17513775491

channel

Dictionary:

DECLARATION_REQUEST_CHANNELS

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

...