Versions Compared

Key

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

Purpose

This WS allows to get a list of Groups of Diagnoses without details by legal entity employees. Used to get id, name and description of the Group of Diagnoses.

...

  1. This is a REST method used by MIS.

  2. Authorization is not needed to get Diagnoses Groups list (as dictionaries).

Specification

Page Properties

...

Search params

  • Group of Diagnoses name

  • Group of Diagnoses code

...

або Swagger

Resource

api/diagnoses_groups

Посилання на ресурс, наприклад: /api/persons/create

Scope

API paragraph not found

Scope для доступу

Components

Medical events

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Async

Метод є синхронним чи асинхронним?

Public/Private/Internal

Public

Потрібно зазначити тип методу за ступенем доступності

Logic

  1. Filter active diagnoses_groups by search params (name, code)

  2. Render found diagnoses_groups with following params only:

    1. id

    2. name

    3. code

    4. description

Filters

See on Apiary

Request structure

See on Apiary

Authorize

Is not needed

Headers

Content-Type:application/json

Response structure

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "f7f817b2-3134-4625-b87d-e2d7fc8e9b90",
      "name": "Some name",
      "code": "H00",
      "description": "Some description"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

Page Properties

HTTP status code

Message

What caused the error

 200

Response