Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

Required parameters are marked with "*"

...

Purpose*

This WS allows to get a list of medical programs already provided by the divisions of legal entity according to contracts. Also, this list can be filtered using search parameters.

...

This method allows to get a list of medical programs already provided by the divisions of legal entity according to contracts. Also, this list can be filtered using search parameters.

Key points

  1. Only authenticated and authorized employees with appropriate scope can get a list of Medical programs provision.

  2. Method returns a list of Medical programs provision for user’s legal entity only.

  3. List can be filtered by search params.

Filters

Filter

Values

Type

Description

Example

contract_number

String

Contract number

0000-PAP5-M000

medical_program_id

String

Medical program identifier

04d5ea65-d6e7-44f8-9eef-f0d3c1121d2b

division_id

String

Division identifier

6d07bdb0-59c0-4b54-8a90-bada3e232877

is_active

Boolean

Medical program provision status

true

page

Number

Page number

2

page_size

Number

A limit on the number of objects to be returned, between 1 and 500.

50

...

Request to process the request using a token in the headers

Headers*

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer F3GF124Df565FDS234SDF34

  • api-key:aDGFDFGT46S5gFGD

...

  • contract_number

    • If submitted, filter list by medical_program_provision.contract_number

  • medical_program_id

    • If submitted, filter list by medical_program_provision.medical_program_id

  • division_id

    • If submitted, filter list by medical_program_provision.division_id

  • is_active

    • If submitted, filter list by medical_program_provision.is_active

Service logic

  1. Get client_id from token as legal entity identifier

  2. Define all the divisions of the legal entity

  3. Get and render all the records with defined divisions from medical_program_provision table filtered by search params.

Response structure*

See on Apiary

...