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

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

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

Успішна відповідь поверне 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"
    }
}

Опис полів

Property	Data 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	Название региона (области)
GeoInfo.CountryId	int	ID страны
GeoInfo.Country	string	Название страны
GeoInfo.Address	string	Адрес организации
ReturnInfo	Объект ReturnInfo	Информация о результатах выполнения

Page tree

Versions Compared

Old Version 4

New Version 5

Key

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

Запити

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

Метод

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

Тіло запиту

Опис полів

Page tree

Page History

Versions Compared

Old Version 4

New Version 5

Key

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

Запити

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

Метод

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

Тіло запиту

Опис полів

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