Versions Compared

Key

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

Purpose

This service returns parties.declaration_count from report DB for get employees services

Specification

Page Properties
idAPI_Specification

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-portal-and-reports/parties/get-declaration-count-internal

Посилання на Apiary або Swagger

Resource

/api/parties/declaration_count/{{ids}}

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

Scope

API paragraph not found

Scope для доступу

Components

Employees

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

Microservices

il/api

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

Protocol type

REST

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

Request type

POST

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

Sync/Async

Sync

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

Public/Private/Internal

Internal

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

Logic

...

Input parameters

See on Apiary

Input parameter

Values

Type

Description

Example

ids

String

id of a party.

Required

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

Authorize

Request to process the request using a token in the headers

Request structure

See on Apiary

Headers

Наприклад:

Content-Type:application/json

Request data validation

API paragraph not found

Processing

API paragraph not found

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": [
    {
      "declaration_count": 1234,
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

Post-processing processes

...

HTTP status codes

Page Properties
idAPI_HTTP status codes

HTTP status code

Message

What caused the error

 200

 Response