Versions Compared

Old Version 17

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Oleksandr Zhuk (SoE eHealth)

Saved on

Key

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

...

Filter

Values

Type

Description

Example

id

String

Contract division identifier

b075f148-7f93-4fc2-b2ec-2d81b19a9b7b

contract_id

String

Contract identifier

82286646-ee07-4d89-929d-29287c367e8a

division_id

String

Division identifier

f93ac873-b999-47d2-a945-32e7f582eed0

is_active

Boolean

wether contract divisions is active

true

page

Number

Page number

2

page_size

Number

A limit on the number of objects to be returned. Maximum: 500

50

Request structure

...

Authorize

  1. Verify the validity of api-key

    1. Return 401 in case validation fails

  2. Verify the validity of token

    1. Return 401 in case validation fails

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

    1. Return 403 in case invalid scope(s)

Request to process the request using a token in the headers

Headers

Наприклад:

  • Content-Type:application/json

  • api-key:c2778f3064753ea70de870a53795f5c9

...

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "8be63914-a278-470b-b868-1af5b9087332",
      "division_id": "4b6b3b53-282a-415b-8f88-f1c7ab65f4a3",
      "contract_id": "71e51746-cc88-46e1-95ab-19cc5911d74c",
      "is_active": true,
      "inserted_at": "2017-04-20T19:14:13Z",
      "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
      "updated_at": "2017-04-20T19:14:13Z",
      "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

Post-processing processes

...

HTTP status codes
HTTP status code
Message
What caused the error
 200
 
 
...