Versions Compared

Old Version 10

changes.mady.by.user Danylo Kalchenko

Saved on

compared with

New Version 11

changes.mady.by.user Danylo Kalchenko

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleGetOrganisations()

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

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

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

Метод

'POST'

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

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

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

 Тіло запиту

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

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

Code Block
languagejs
 {
    "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"
    }
}

 Опис полів

ВластивістьТип данихОбов'язковістьОпис
OrganisationIdint
ID організації
OrganisationNamestring
Назва організації
OrgTypeIdint
ID типу організації
OrgTypeDescriptionstring
Назва типу організації
Codeint
Код організації
LocationIdint
ID локації
GeoInfo.CityIdint
ID міста
GeoInfo.Citystring
Назва міста
GeoInfo.RegionIdint
ID региона (области)
GeoInfo.Regionstring
ID регіону (області)
GeoInfo.CountryIdint
ID країни
GeoInfo.Countrystring
Назва країни
GeoInfo.Addressstring
Адреса організації
ReturnInfoОбъект ReturnInfo
Інформація про результати виконання

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

...

Expand
titleGetServiceCenters()

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

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

URL

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

Метод

POST

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

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

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

Тіло Запиту 

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

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

Code Block
languagejs
 {
    "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"
    }
}

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


ВластивістьТип данихОбов'язковістьОпис
ServiceCenterIdint ID сервісного центру
ServiceCenterNamestring
Назва сервісного центру
OrganisationIdint
ID організації
RegistrationDaysLimitint
Ліміт кількості днів для попередньої реєстрації
Sopdatetime
Дата, з якої дозволена попередня реєстрація
GeoInfo.CityIdint
ID міста
GeoInfo.Citystring
Назва міста
GeoInfo.RegionIdint
ID регіону (області)
GeoInfo.Regionstring
Назва регіону (області)
GeoInfo.CountryIdint
ID країни
GeoInfo.Countrystring
Назва країни
GeoInfo.Addressstring
Адреса організації
ReturnInfoоб'єкт ReturnInfo
Інформація про результати виконання
ReturnInfo.ReturnCodeint
Код результату
ReturnInfo.ReturnSubcodeint
Підкод результату
ReturnInfo.ReturnMessagestring
Повідомлення про результат


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

...

Expand
titleGetCities()

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

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

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

Метод

POST

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

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

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

Тіло запиту

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

Приклад запиту з використанням curl

Code Block
curl -X POST https://{HOST}/api/servicehub/GetCities \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "languageId": "1"
    }'

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

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

Code Block
languagejs
{
    "CityList": [
        {
            "CityId": 404,
            "City": "Івано-Франківськ",
            "RegionId": 9,
            "Region": "Івано-Франківська область",
            "CountryId": 1,
            "Country": "Україна",
            "Address": ""
        },
        {
            "CityId": 349,
            "City": "Ужгород",
            "RegionId": 7,
            "Region": "Закарпатська область",
            "CountryId": 1,
            "Country": "Україна",
            "Address": ""
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

Опис полів відповіді
ВластивістьТип данихОпис
CityIdintID міста
CitystringНазва міста
RegionIdintID регіону (області)
RegionstringНазва регіону (області)
CountryIdintID країни
CountrystringНазва країни
AddressstringАдреса організації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат



...

Expand
titleGetOrganisationsByCityId()

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

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

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

Метод

POST

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

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

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

Тіло запиту

Code Block
languagejs
{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "cityId": 549,
    "languageId": "1"
}


Приклад

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

запиту з використанням curl

Code Block
{
curl -X POST  "OrganisationList": [https://{HOST}/api/servicehub/GetOrganisationsByCityId \
    -H "Content-Type:   {application/json" \
            "OrgTypeId": 31,-d '{
            "OrgTypeDescriptionauthToken": "ДЕРЖАВНА ОРГАНІЗАЦІЯ (УСТАНОВА, ЗАКЛАД)11111111-abcd-dead-beef-0123456789",
            "CodecityId": 425549,
            "LocationIdlanguageId": 1,
            "GeoInfo": {"1"
    }'


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

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

Code Block
{
       "OrganisationList": [
    "CityId": 549,
    {
            "CityOrgTypeId": "Буськ"31,
            "OrgTypeDescription": "ДЕРЖАВНА ОРГАНІЗАЦІЯ (УСТАНОВА, ЗАКЛАД)"RegionId": 14,
                "RegionCode": "Львівська область"425,
                "CountryIdLocationId": 1,
                "Country": "Україна","GeoInfo": {
                "AddressCityId": ""549,
            }    "City": "Буськ",
                "OrganisationIdRegionId": 914,
                "OrganisationNameRegion": "Державна реєстрація актів цивільного стану"Львівська область",
        }
    ],
    "ReturnInfoCountryId": {1,
        "ReturnCode": 0,
        "ReturnSubcodeCountry": 0"Україна",
         "ReturnMessage": "OK"
       "Address": ""
            }
}

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

ВластивістьТип данихОпис
OrganisationIdintID організації
OrganisationNamestringНазва організації
OrgTypeIdintID типу організації
OrgTypeDescriptionstringНазва типу організації
CodeintКод організації
LocationIdintID локації
GeoInfo.CityIdintID міста
GeoInfo.CitystringНазва міста
GeoInfo.RegionIdintID регіону (області)
GeoInfo.RegionstringНазва регіону (області)
GeoInfo.CountryIdintID країни
GeoInfo.CountrystringНазва країни
GeoInfo.AddressstringАдреса організації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

Приклад запиту з використанням curl

,
            "OrganisationId": 9,
            "OrganisationName": "Державна реєстрація актів цивільного стану"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

ВластивістьТип данихОпис
OrganisationIdintID організації
OrganisationNamestringНазва організації
OrgTypeIdintID типу організації
OrgTypeDescriptionstringНазва типу організації
CodeintКод організації
LocationIdintID локації
GeoInfo.CityIdintID міста
GeoInfo.CitystringНазва міста
GeoInfo.RegionIdintID регіону (області)
GeoInfo.RegionstringНазва регіону (області)
GeoInfo.CountryIdintID країни
GeoInfo.CountrystringНазва країни
GeoInfo.AddressstringАдреса організації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

...

Expand
titleGetServiceCentersByOrgAndCityId()

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

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

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

Метод

POST

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

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

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

Тіло запиту

Code Block
{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "organisationId": 9,
    "cityId": 549,
    "languageId": "1"
}

Приклад запиту з використанням curl

Code Block
curl -X POST https://{HOST}/api/servicehub/GetServiceCentersByOrgAndCityId \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 9,
        "cityId": 549,
        "languageId": "1"
    }'

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

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

Code Block
{
    "ServiceCenterList": [
        {
            "ServiceCenterId": 37,
            "ServiceCenterName": "Буський міський відділ ДРАЦ",
            "GeoInfo": {
                "CityId": 549,
                "City": "Буськ",
                "RegionId": 14,
                "Region": "Львівська область",
                "CountryId": 1,
                "Country": "Україна",
                "Address": "вул. Петрушевича, 12"
            },
            "OrganisationId": 9,
            "RegistrationDaysLimit": 30,
            "Sop": "2024-01-26T00:00:00"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

ВластивістьТип данихОпис
ServiceCenterIdintID сервісного центру
ServiceCenterNamestringНазва сервісного центру
OrganisationIdintID організації
RegistrationDaysLimitintЛіміт кількості днів для попередньої реєстрації
SopdatetimeДата, з якої дозволена попередня реєстрація
GeoInfo.CityIdintID міста
GeoInfo.CitystringНазва міста
GeoInfo.RegionIdintID регіону (області)
GeoInfo.RegionstringНазва регіону (області)
GeoInfo.CountryIdintID країни
GeoInfo.CountrystringНазва країни
GeoInfo.AddressstringАдреса організації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

...

Expand
titleGetServiceCentersByService()

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
  • serviceId (int): Ідентифікатор послуги.
  • serviceTypeId (array of int): Масив ідентифікаторів типів послуг.
  • from (datetime): Початкова дата і час.
  • to (datetime): Кінцева дата і час.
  • languageId (int): Ідентифікатор мови, якою користувач хоче отримати дані.

Примітка: from та to повинні бути в межах одного дня і не можуть бути меншими за поточний час.

Тіло запиту

Code Block
{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "serviceId": 220,
    "serviceTypeId": [1],
    "from": "2024-01-26T00:00:00",
    "to": "2024-01-26T12:00:00",
    "languageId": 1
}


Приклад запиту з використанням curl


Code Block
curl -X POST https://{HOST}/api/servicehub/GetServiceCentersByService \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "serviceId": 220,
        "serviceTypeId": [1],
        "from": "2024-01-26T00:00:00",
        "to": "2024-01-26T12:00:00",
        "languageId": 1
    }'



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

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

Code Block
{
    "ServiceCenterList": [
        {
            "ServiceCenterId": 37,
            "ServiceCenterName": "Буський міський відділ ДРАЦ",
            "OrganisationId": 9,
            "OrganisationName": "Будинок Нерухомості"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}


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

ВластивістьТип данихОпис
ServiceCenterIdintID сервісного центру
ServiceCenterNamestringНазва сервісного центру
OrganisationIdintID організації
OrganisationNamestringНазва організації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

Логіка обробки запиту

Вміст параметрів serviceId, from, і to:

  • N (serviceId) та from, to (datetime): Повертає всі СЦ, де доступна попередня реєстрація послуги N в інтервалі від from до to.
  • N (serviceId) та NULL (from), to (datetime): Повертає всі СЦ, де доступна попередня реєстрація послуги N в інтервалі від початку дня до to.
  • N (serviceId) та from (datetime), NULL (to): Повертає всі СЦ, де доступна попередня реєстрація послуги N в інтервалі від from до кінця дня.
  • N (serviceId) та NULL (from, to): Повертає всі СЦ, де доступна попередня реєстрація послуги N на протязі наступного дня.
  • NULL (serviceId) та from, to (datetime): Повертає всі СЦ, де доступна попередня реєстрація в інтервалі від from до to.
  • NULL (serviceId) та NULL (from), to (datetime): Повертає всі СЦ, де доступна попередня реєстрація в інтервалі від початку дня до to.
  • NULL (serviceId) та from (datetime), NULL (to): Повертає всі СЦ, де доступна попередня реєстрація в інтервалі від from до кінця дня.
  • NULL (serviceId) та NULL (from, to): Повертає всі СЦ, де доступна попередня реєстрація на протязі наступного дня.

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

...

Expand
titleGetAllGroups()

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен аутентифікації.
  • organisationId (int): Ідентифікатор організації.
  • serviceCenterId (int): Ідентифікатор сервісного центру.
  • languageId (int): Ідентифікатор мови.

Тіло запиту

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


Приклад запиту з використанням curl


Code Block
curl -X POST https://{HOST}/api/servicehub/GetAllGroups \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "languageId": 1
    }'



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

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

Code Block
{
    "GroupList": [
        {
            "GroupId": 204,
            "ParentGroupId": 0,
            "Description": "ID картка та закордонний паспорт",
            "OrderWeight": 4
        },
        {
            "GroupId": 230,
            "ParentGroupId": 0,
            "Description": "Отримати готовий документ",
            "OrderWeight": 902
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

ВластивістьТип данихОпис
GroupIdintID групи
ParentGroupIdintID батьківської групи
DescriptionstringОпис групи
OrderWeightintВаговий коефіцієнт для сортування
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

...

Expand
titleGetGroupsByParentId()

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

Цей запит повертає список груп послуг для вказаної батьківської групи.

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

Метод

POST

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

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

  • authToken (Guid): Токен аутентифікації.
  • organisationId (int): Ідентифікатор організації.
  • serviceCenterId (int): Ідентифікатор сервісного центру.
  • parentGroupId (int): Ідентифікатор батьківської групи.
  • languageId (int): Ідентифікатор мови.

Тіло запиту

Code Block
{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "organisationId": 2,
    "serviceCenterId": 1,
    "parentGroupId": 0,
    "languageId": 1
}

Приклад запиту з використанням curl

Code Block
curl -X POST https://{HOST}/api/servicehub/GetGroupsByParentId \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "parentGroupId": 0,
        "languageId": 1
    }'


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

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

Code Block
{
    "GroupList": [
        {
            "GroupId": 204,
            "ParentGroupId": 0,
            "Description": "ID картка та закордонний паспорт",
            "OrderWeight": 4
        },
        {
            "GroupId": 230,
            "ParentGroupId": 0,
            "Description": "Отримати готовий документ",
            "OrderWeight": 902
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

ВластивістьТип данихОпис
GroupIdintID групи
ParentGroupIdintID батьківської групи
DescriptionstringОпис групи
OrderWeightintВаговий коефіцієнт для сортування
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

Цей запит повертає список груп послуг для вказаної батьківської групи.

...

Expand
titleGetAllServices()

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен аутентифікації.
  • organisationId (int): Ідентифікатор організації.
  • serviceCenterId (int): Ідентифікатор сервісного центру.
  • languageId (int): Ідентифікатор мови.

Тіло запиту

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

Приклад запиту з використанням curl

Code Block
curl -X POST https://{HOST}/api/servicehub/GetAllServices \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "languageId": 1
    }'

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

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

Code Block
{
    "ServiceList": [
        {
            "ServiceId": 870,
            "GroupId": 204,
            "Description": "Подати документи щодо оформлення ID картки та закордонного паспортa",
            "OrderWeight": 835
        },
        {
            "ServiceId": 872,
            "GroupId": 0,
            "Description": "Отримати готовий документ (крім id картки та закордонного паспорту)",
            "OrderWeight": 837
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

ВластивістьТип данихОпис
ServiceIdintID послуги
GroupIdintID групи, до якої належить послуга
DescriptionstringОпис послуги
OrderWeightintВаговий коефіцієнт для сортування
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат


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

...

Expand
titleGetServicesByGroupId()

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

Цей запит отримує список послуг для вказаної групи послуг.

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

Метод

POST

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

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

  • authToken (Guid): Токен аутентифікації.
  • organisationId (int): Ідентифікатор організації.
  • serviceCenterId (int): Ідентифікатор сервісного центру.
  • groupId (int): Ідентифікатор групи послуг.
  • languageId (int): Ідентифікатор мови.

Тіло запиту

Code Block
{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "organisationId": 2,
    "serviceCenterId": 1,
    "groupId": 204,
    "languageId": 1
}


Приклад запиту з використанням curl


Code Block
curl -X POST https://{HOST}/api/servicehub/GetServicesByGroupId \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "groupId": 204,
        "languageId": 1
    }'


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

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

Code Block
{
    "ServiceList": [
        {
            "ServiceId": 870,
            "GroupId": 204,
            "Description": "Подати документи щодо оформлення ID картки та закордонного паспортa",
            "OrderWeight": 835
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
Code Block
curl -X POST https://{HOST}/api/servicehub/GetOrganisationsByCityId \
    -H "Content-Type: application/json" \
    -d '{
        "authTokenReturnSubcode": "11111111-abcd-dead-beef-0123456789"0,
        "cityId": 549,
        "languageId": "1"
    }'"ReturnMessage": "OK"
    }
}


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

ВластивістьТип данихОпис
ServiceIdintID послуги
GroupIdintID групи, до якої належить послуга
DescriptionstringОпис послуги
OrderWeightintВаговий коефіцієнт для сортування
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

 Цей запит отримує список послуг для вказаної групи послуг.

...

Expand
titleGetServiceCentersByOrgAndCityIdGetServicesByServiceCenter()

Опис запиту

GetServiceCentersByOrgAndCityId

GetServicesByServiceCenter()

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

URL

plaintext


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

GetServiceCentersByOrgAndCityId

GetServicesByServiceCenter

Метод

POST

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

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

  • authToken (Guid): Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
  • organisationId (int): Ідентифікатор організації.
  • .
  • serviceCenterId (int): Ідентифікатор сервісного центру.
  • serviceTypeId (int[]): Перелік ідентифікаторів типів послуг.
  • from (datetime): Початкова дата.
  • to (datetime): Кінцева датаcityId (int): Ідентифікатор міста.
  • languageId (int): Ідентифікатор мови, якою користувач хоче отримати дані.

Тіло запиту

code
json

{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "serviceCenterId": 1,
    "serviceTypeId": [1, 2],
    "
organisationId
from":
9
"2024-07-15 00:00:00",
    "
cityId": 549
to": "2024-07-20 00:00:00",
    "languageId":
"
1
"

}

Приклад запиту з використанням curl

code
bash

curl -X POST https://{HOST}/api/servicehub/
GetServiceCentersByOrgAndCityId
GetServicesByServiceCenter \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "serviceCenterId": 1,
        "serviceTypeId": [1, 2],
        "
organisationId
from":
9
 "2024-07-15 00:00:00",
        "
cityId
to":
549
"2024-07-20 00:00:00",
        "languageId":
"
1
"

    }'

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

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

code


{
    "
ServiceCenterList
ServiceList": [
        {
            "
ServiceCenterId
OrganisationId":
37
1,
            "
ServiceCenterName
ServiceCenterId":
"Буський міський відділ ДРАЦ"
1,
            "
GeoInfo
ServiceId":
{
8,
            
"
CityId
UniqueServiceId":
549
1358,

            "
City
ServiceName": "
Буськ
замена паспорта",

            
"
RegionId
ServiceTypeId":
14
[1,
"Region": "Львівська область", 
 2]
        },
"CountryId":
1, 
   {
            
"
Country
OrganisationId":
"Україна"
2,
            
"
Address
ServiceCenterId":
"вул. Петрушевича
5,
12" 
           "ServiceId":
}
68,
            "
OrganisationId
UniqueServiceId":
9
336,
            "
RegistrationDaysLimit
ServiceName":
30
"ееееемалятко",
            "
Sop
ServiceTypeId":
"2024-01-26T00:00:00"
 [1, 2]
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Назва сервісного центру
ВластивістьТип данихОпис
ServiceCenterIdintID сервісного центру
ServiceCenterNamestring
OrganisationIdintID організації
RegistrationDaysLimitServiceCenterIdintЛіміт кількості днів для попередньої реєстрації
SopdatetimeДата, з якої дозволена попередня реєстрація
ID сервісного центру
ServiceIdGeoInfo.CityIdintID міста
GeoInfo.CitystringНазва міста
послуги
UniqueServiceIdGeoInfo.RegionIdintУнікальний ID регіону (області)послуги
ServiceNameGeoInfo.RegionstringНазва регіону (області)послуги
ServiceTypeIdGeoInfo.CountryIdint[]ID країни
GeoInfo.CountrystringНазва країни
GeoInfo.AddressstringАдреса організаціїПерелік ID типів послуг
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат


...