Схема взаємодії Клієнта з Серверами черги

Gliffy Diagram

displayName	Схема взаимодействия Copy
name	Схема взаимодействия Copy
pagePin	2

Загальна інформація щодо роботи із запитами

Всі запити мають бути у форматі POST. Content-type:application/json

Запити:

Тіло

Тіло запиту

Expand

title	GetOrganisations()

GetOrganisations()

Цей запит використовується для отримання списку організацій. Він вимагає аутентифікацію за допомогою токену і підтримує багатомовність через параметр languageId.

URL
`https://{HOST}/api/servicehub/GetOrganisations`

Метод

'POST'

Параметри запиту

Запит має включати тіло з двома параметрами:

authToken (Guid): Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
languageId (int): Ідентифікатор мови, якою користувач хоче отримати дані.

Expand

title

Code Block

language	js

{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "languageId": "1"
}

Expand

Приклад відповіді

Успішна відповідь поверне JSON об'єкт зі списком організацій. Приклад структури відповіді:

Code Block

language	js

 {
    "OrganisationList": [
        {
            "OrgTypeId": 1,
            "OrgTypeDescription": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ",
            "Code": 240,
            "LocationId": 1,
            "GeoInfo": {
                "CityId": 47,
                "City": "Первомайське",
                "RegionId": 1,
                "Region": "АР Крим",
                "CountryId": 1,
                "Country": "Україна",
                "Address": "ул. Пушкина"
            },
            "OrganisationId": 1,
            "OrganisationName": "test"
        },
        {
            "OrgTypeId": 1,
            "OrgTypeDescription": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ",
            "Code": 240,
            "LocationId": 1,
            "GeoInfo": {
                "CityId": 47,
                "City": "Первомайське",
                "RegionId": 1,
                "Region": "АР Крим",
                "CountryId": 1,
                "Country": "Україна",
                "Address": "ул. Пушкина"
            },
            "OrganisationId": 2,
            "OrganisationName": "Volia"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

Опис полів

PropertyData type

Властивість	Тип даних	Обов'язковість	Опис

Description


OrganisationId	int	ID організації
OrganisationName	string	Назва організації
OrgTypeId	int	ID типу організації
OrgTypeDescription	string	Назва типу організації
Code	int	Код організації
LocationId	int	ID локації
GeoInfo.CityId	int	ID міста
GeoInfo.City	string	Назва міста
GeoInfo.RegionId	int	ID региона (области)
GeoInfo.Region	string	ID регіону (області)
GeoInfo.CountryId	int	ID країни
GeoInfo.Country	string	Назва країни
GeoInfo.Address	string	Адреса організації
ReturnInfo	Объект ReturnInfo	Інформація про результати виконання

Тіло

запиту

Запиту

Expand

title	GetServiceCenters()

Опис запиту `GetServiceCenters()`

Цей запит використовується для отримання списку сервісних центрів.

URL

`https://{HOST}/api/servicehub/GetServiceCenters`

Метод

POST

Параметри запиту

Запит має включати тіло з трьома параметрами:

authToken (Guid): Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
organisationId (int): Ідентифікатор організації.
languageId (int): Ідентифікатор мови, якою користувач хоче отримати дані.

Expand

title

Приклад

Code Block

language	js

 {
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "organisationId": "2",
    "languageId": "1"
}

Expand

title

Приклади відповіді

Code Block

language	js

 {
    "ServiceCenterList": [
        {
            "ServiceCenterId": 1,
            "ServiceCenterName": "ЦНАП м. Києва",
            "GeoInfo": {
                "CityId": 472,
                "City": "Київ",
                "RegionId": 11,
                "Region": "Київ",
                "CountryId": 1,
                "Country": "Україна",
                "Address": "вул. Дніпровська набережна, 19-Б"
            },
            "OrganisationId": 3,
            "RegistrationDaysLimit": 60,
            "Sop": "2024-01-25T00:00:00"
        },
        {
            "ServiceCenterId": 2,
            "ServiceCenterName": "ЦНАП Подільської РДА",
            "GeoInfo": {
                "CityId": 472,
                "City": "Київ",
                "RegionId": 11,
                "Region": "Київ",
                "CountryId": 1,
                "Country": "Україна",
                "Address": "вул. Костянтинівська, 9/6"
            },
            "OrganisationId": 2,
            "RegistrationDaysLimit": 30,
            "Sop": "2024-01-25T00:00:00"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

Опис полів відповіді

Властивість

PropertyData type

Тип даних	Обов'язковість	Опис

Description


ServiceCenterId	int	ID сервісного центру
ServiceCenterName	string	Назва сервісного центру
OrganisationId	int	ID організації
RegistrationDaysLimit	int	Ліміт кількості днів для попередньої реєстрації
Sop	datetime	Дата, з якої дозволена попередня реєстрація
GeoInfo.CityId	int	ID міста
GeoInfo.City	string	Назва міста
GeoInfo.RegionId	int	ID регіону (області)
GeoInfo.Region	string	Назва регіону (області)
GeoInfo.CountryId	int	ID країни
GeoInfo.Country	string	Назва країни
GeoInfo.Address	string	Адреса організації
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання
ReturnInfo.ReturnCode	int	Код результату
ReturnInfo.ReturnSubcode	int	Підкод результату
ReturnInfo.ReturnMessage	string	Повідомлення про результат

Expand

Expandcode

titlelanguage	Тіло запитуjs

Code Block

language	js

expand

Expand

Code Block

language	js	title	Приклад відповіді

Code Block

language	js

titleexpand

Expand

Тіло запиту

Code Block

language	js

Expand

title	Приклад відповіді

Code Block

language	js

titleexpand

Expand

Тіло запиту

Code Block

language	js

Expand

title	Приклад відповіді

Code Block

language	js

Тіло запиту

Expand

title

Code Block

language	js

Expand

title	Приклад відповіді

Code Block

language	js

Page tree

Versions Compared

Old Version 8

New Version 9

Key

Схема взаємодії Клієнта з Серверами черги

Запити:

URL
`https://{HOST}/api/servicehub/GetOrganisations`

Метод

Параметри запиту

Опис полів

Опис запиту `GetServiceCenters()`

URL

`https://{HOST}/api/servicehub/GetServiceCenters`

Метод

Параметри запиту

Опис полів відповіді

Page tree

Page History

Versions Compared

Old Version 8

New Version 9

Key

Схема взаємодії Клієнта з Серверами черги

Запити:

URLhttps://{HOST}/api/servicehub/GetOrganisations

Метод

Параметри запиту

Опис полів

Опис запиту GetServiceCenters()

URL

https://{HOST}/api/servicehub/GetServiceCenters

Метод

Параметри запиту

Опис полів відповіді

URL
`https://{HOST}/api/servicehub/GetOrganisations`

Опис запиту `GetServiceCenters()`

`https://{HOST}/api/servicehub/GetServiceCenters`