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

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): Ідентифікатор мови, якою користувач хоче отримати дані.
 Тіло запиту
 Code Block
language js
{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "languageId": "1"
}
Приклад відповіді
 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"
    }
}
 Опис полів
Властивість Тип даних Обов'язковість Опис
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): Ідентифікатор мови, якою користувач хоче отримати дані.
Тіло Запиту 
 Code Block
language js
 {
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "organisationId": "2",
    "languageId": "1"
}
Приклади відповіді
 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"
    }
}
Опис полів відповіді

Властивість Тип даних Обов'язковість Опис
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
...
title
...
language js
...
language js
...
language js
GetCities()
Опис запиту GetCities()
Цей запит використовується для отримання списку міст.
URL https://{HOST}/api/servicehub/GetCities 
Метод
POST
Параметри запиту
Запит має включати тіло з двома параметрами:
authToken (Guid): Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
languageId (int): Ідентифікатор мови, якою користувач хоче отримати дані.
Тіло запиту
 Code Block
language js
{
    "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
language js
{
    "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"
    }
}

Опис полів відповіді
Властивість Тип даних Опис
CityId int ID міста
City string Назва міста
RegionId int ID регіону (області)
Region string Назва регіону (області)
CountryId int ID країни
Country string Назва країни
Address string Адреса організації
ReturnInfo об'єкт ReturnInfo Інформація про результати виконання
ReturnInfo.ReturnCode int Код результату
ReturnInfo.ReturnSubcode int Підкод результату
ReturnInfo.ReturnMessage string Повідомлення про результат

...
 Expand
Опис запиту GetOrganisationsByCityId()
Цей запит використовується для отримання списку організацій для вказаного міста.
URL https://{HOST}/api/servicehub/GetOrganisationsByCityId
Метод
POST
Параметри запиту
Запит має включати тіло з трьома параметрами:
authToken (Guid): Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
cityId (int): Ідентифікатор міста.
languageId (int): Ідентифікатор мови, якою користувач хоче отримати дані.
Тіло запиту
 Code Block
language js
{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "cityId": 549,
    "languageId": "1"
}


Приклад відповіді
Успішна відповідь поверне JSON об'єкт зі списком організацій та інформацією про результат виконання. Приклад структури відповіді:
 Code Block
{
    "OrganisationList": [
        {
            "OrgTypeId": 31,
            "OrgTypeDescription": "ДЕРЖАВНА ОРГАНІЗАЦІЯ (УСТАНОВА, ЗАКЛАД)",
            "Code": 425,
            "LocationId": 1,
            "GeoInfo": {
                "CityId": 549,
                "City": "Буськ",
                "RegionId": 14,
                "Region": "Львівська область",
                "CountryId": 1,
                "Country": "Україна",
                "Address": ""
            },
            "OrganisationId": 9,
            "OrganisationName": "Державна реєстрація актів цивільного стану"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}
Опис полів відповіді
Властивість Тип даних Опис
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 Інформація про результати виконання
ReturnInfo.ReturnCode int Код результату
ReturnInfo.ReturnSubcode int Підкод результату
ReturnInfo.ReturnMessage string Повідомлення про результат
Приклад запиту з використанням curl
 Code Block
curl -X POST https://{HOST}/api/servicehub/GetOrganisationsByCityId \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "cityId": 549,
        "languageId": "1"
    }'
...
 Expand
title GetServiceCentersByOrgAndCityId()
Опис запиту 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"
    }
}
Опис полів відповіді
Властивість Тип даних Опис
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 Повідомлення про результат
...
language js
...
language js
...
language js
...
language js
...
language js
...
language js
...
...

Page tree

Page History

Versions Compared

Old Version 9

New Version 10

Key

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

Запити:

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

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

Метод

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

Тіло запиту

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

Опис полів

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

URL

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

Метод

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

Тіло Запиту

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

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

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

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

Метод

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

Тіло запиту

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

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

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

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

Метод

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

Тіло запиту

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

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

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

Метод

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

Тіло запиту

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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