You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

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

Схема взаимодействия Copy
 

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

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

Запити

 GetOrganisations()

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

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

Метод

'POST'

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

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

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

Тіло запиту

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


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

 {
    "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 typeDescription
OrganisationIdintID организации
OrganisationNamestringНазвание организации
OrgTypeIdintID типа организации
OrgTypeDescriptionstringНазвание типа организации
CodeintКод организации
LocationIdintID локации
GeoInfo.CityIdintID города
GeoInfo.CitystringНазвание города
GeoInfo.RegionIdintID региона (области)
GeoInfo.RegionstringНазвание региона (области)
GeoInfo.CountryIdintID страны
GeoInfo.CountrystringНазвание страны
GeoInfo.AddressstringАдрес организации
ReturnInfoОбъект ReturnInfoИнформация о результатах выполнения


  • No labels