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

Gliffy Diagram

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


 
Загальна інформація щодо роботи із запитами
Всі запити мають бути у форматі'POST'. Content-type:application/json
Запити:
GetOrganisations()
 Expand
title

...

параметр 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"
}

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

Code Block
curl -X POST https://{HOST}/api/servicehub/GetOrganisations \ -H "Content-Type: application/json" \ -d '{ "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"
    }
}

Опис полів

Property	Data 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	Інформація про результати виконання

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

`GetServiceCenters()`

Expand

title

...

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

URL

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

Метод

'POST'

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

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

Параметр	Тип даних	Обов'язковість	Опис
authToken	Guid	обов'язковий	Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
OrganisationId	int	обов'язковий	ID організації.
languageId	int		ID мови, якою користувач хоче отримати дані.

Тіло Запиту

Code Block

language	js

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

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

Code Block
curl -X POST https://{HOST}/api/servicehub/GetOrganisations \ -H "Content-Type: application/json" \ -d '{ "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"
    }
}

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

Property	Data 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	Інформація про результати виконання

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

`GetCities()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Обов'язковість	Опис
authToken	Guid		Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
languageId	int		ID мови, якою користувач хоче отримати дані.

Тіло запиту

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"
    }
}


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

Property	Data type	Description
CityId	int	ID міста
City	string	Назва міста
RegionId	int	ID регіону (області)
Region	string	Назва регіону (області)
CountryId	int	ID країни
Country	string	Назва країни
Address	string	Адреса організації
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання

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

`GetOrganisationsByCityId()`

Expand

title

...

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

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

Метод

'POST'

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

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

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

Тіло запиту

Code Block

language	js

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

Приклад запиту з використанням `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" }'

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

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

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

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	Інформація про результати виконання

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

`GetServiceCentersByOrgAndCityId()`

Expand

title

...

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

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

Метод

'POST'

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

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

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

Тіло запиту

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"
    }
}

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

Property	Data 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	Інформація про результати виконання

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

`GetServiceCentersByService()`

Expand

title

...

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

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

Метод

'POST'

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

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

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

Примітка: 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"
    }
}

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

Property	Data type	Description
ServiceCenterId	int	ID сервісного центру
ServiceCenterName	string	Назва сервісного центру
OrganisationId	int	ID організації
OrganisationName	string	Назва організації
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання

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

Вміст параметрів			Логіка
serviceId	from	to	Логіка
N	yyyy-MM-dd hh:mm:ss	yyyy-MM-dd hh:mm:ss	Повертає всі СЦ, де доступна попередня реєстрація послуги N в інтервалі від `from` до `to`
N	NULL	yyyy-MM-dd hh:mm:ss	Повертає всі СЦ, в яких доступна попередня реєстрація послуги N в інтервалі yyyy-MM-dd ... to
N	yyyy-MM-dd hh:mm:ss	NULL	повертає всі СЦ, в яких доступна попередня реєстрація послуги N в from ... yyyy-MM-dd 23:59:59
N	NULL	NULL	повертає всі СЦ, в яких доступна попередня реєстрація послуги N протягом завтрашнього дня
NULL	yyyy-MM-dd hh:mm:ss	yyyy-MM-dd hh:mm:ss	повертає всі СЦ, в яких доступна попередня реєстрація в інтервалі from ... to
NULL	NULL	yyyy-MM-dd hh:mm:ss	повертає всі СЦ, в яких доступна попередня реєстрація в інтервалі yyyy-MM-dd ... to
NULL	yyyy-MM-dd hh:mm:ss	NULL	повертає всі СЦ, в яких доступна попередня реєстрація в from ... yyyy-MM-dd 23:59:59
NULL	NULL	NULL	повертає всі СЦ, в яких доступна попередня реєстрація протягом завтрашнього дня

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

`GetAllGroups()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен аутентифікації.
organisationId	int	ID організації.
serviceCenterId	int	ID сервісного центру.
languageId	int	ID мови, якою користувач хоче отримати дані.

Тіло запиту

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"
    }
}

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

Property	Data type	Description
GroupId	int	ID групи
ParentGroupId	int	ID батьківської групи
Description	string	Опис групи
OrderWeight	int	Ваговий коефіцієнт для сортування
ReturnInfo	Объект ReturnInfo	Інформація про результати виконання

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

`GetGroupsByParentId()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен аутентифікації.
organisationId	int	ID організації.
serviceCenterId	int	ID сервісного центру.
parentGroupId	int	ID батьківської групи.
languageId	int	ID мови, якою користувач хоче отримати дані.

Тіло запиту

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"
    }
}

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

Property	Data type	Description
GroupId	int	ID групи
ParentGroupId	int	ID батьківської групи
Description	string	Опис групи
OrderWeight	int	Ваговий коефіцієнт для сортування
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання

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

`GetAllServices()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен аутентифікації.
organisationId	int	ID організації.
serviceCenterId	int	ID сервісного центру.
languageId	int	ID мови, якою користувач хоче отримати дані.

Тіло запиту

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"
    }
}

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

Property	Data type	Description
ServiceId	int	ID послуги
GroupId	int	ID групи, до якої належить послуга
Description	string	Опис послуги
OrderWeight	int	Ваговий коефіцієнт для сортування
ReturnInfo	Объект ReturnInfo	Інформація про результати виконання

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

`GetServicesByGroupId()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен аутентифікації.
organisationId	int	ID організації.
serviceCenterId	int	ID сервісного центру.
groupId	int	ID групи послуг.
languageId	int	ID мови, якою користувач хоче отримати дані.

Тіло запиту

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,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Property	Data type	Description
ServiceId	int	ID послуги
GroupId	int	ID групи, до якої належить послуга
Description	string	Опис послуги
OrderWeight	int	Ваговий коефіцієнт для сортування
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання

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

`GetServicesByServiceCenter()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен аутентифікації.
serviceCenterId	int	ID сервісного центру.
serviceTypeId	int[]	Перелік ID типів послуг.
from	datetime	Початкова дата.
to	datetime	Кінцева дата.
languageId	int	ID мови, якою користувач хоче отримати дані.

Тіло запиту

Code Block
{ "authToken": "11111111-abcd-dead-beef-0123456789", "serviceCenterId": 1, "serviceTypeId": [1, 2], "from": "2024-07-15 00:00:00", "to": "2024-07-20 00:00:00", "languageId": 1 }

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

Code Block

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


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

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

Code Block

{
    "ServiceList": [
        {
            "OrganisationId": 1,
            "ServiceCenterId": 1,
            "ServiceId": 8,
            "UniqueServiceId": 1358,
            "ServiceName": "замена паспорта",
            "ServiceTypeId": [1, 2]
        },
        {
            "OrganisationId": 2,
            "ServiceCenterId": 5,
            "ServiceId": 68,
            "UniqueServiceId": 336,
            "ServiceName": "ееееемалятко",
            "ServiceTypeId": [1, 2]
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Property	Data type	Description
OrganisationId	int	ID організації
ServiceCenterId	int	ID сервісного центру
ServiceId	int	ID послуги
UniqueServiceId	int	Унікальний ID послуги
ServiceName	string	Назва послуги
ServiceTypeId	int[]	Перелік ID типів послуг
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання

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

Вміст параметрів			Логіка
serviceCenterId	from	to	Логіка
N	yyyy-MM-dd hh:mm:ss	yyyy-MM-dd hh:mm:ss	Повертає всі послуги для СЦ N, доступні для реєстрації в інтервалі from ... to
N	NULL	yyyy-MM-dd hh:mm:ss	Повертає всі послуги для СЦ N, доступні для реєстрації в інтервалі yyyy-MM-dd ... to
N	yyyy-MM-dd hh:mm:ss	NULL	Повертає всі послуги для СЦ N, доступні для реєстрації в інтервалі from ... yyyy-MM-dd 23:59:59
N	NULL	NULL	Повертає всі послуги для СЦ N, доступні для реєстрації на протязі завтрашнього дня
NULL	yyyy-MM-dd hh:mm:ss	yyyy-MM-dd hh:mm:ss	Повертає всі послуги для всіх СЦ, на які підписаний клієнт, доступні для реєстрації в інтервалі from ... to
NULL	NULL	yyyy-MM-dd hh:mm:ss	Повертає всі послуги для всіх СЦ, на які підписаний клієнт, доступні для реєстрації в інтервалі yyyy-MM-dd ... to
NULL	yyyy-MM-dd hh:mm:ss	NULL	Повертає всі послуги для всіх СЦ, на які підписаний клієнт, доступні для реєстрації в інтервалі from ... yyyy-MM-dd 23:59:59
NULL	NULL	NULL	Повертає всі послуги для всіх СЦ, на які підписаний клієнт, доступні для реєстрації на протязі завтрашнього дня

Info

icon	false

Примітка

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

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

`GetServiceIdByTypeId()`

Expand

title

...

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

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

Метод

'POST'

Тіло запиту

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

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

Code Block

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

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

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

Параметр	Тип	Опис
authToken	Guid	Токен авторизації
organisationId	int	ID організації
serviceTypeId	int	ID типу послуги
serviceCenterId	int	ID сервісного центру

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

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

Code Block
{ "ServiceId": 1, "ReturnInfo": { "ReturnCode": 0, "ReturnSubcode": 0, "ReturnMessage": "OK" } }

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

Property	Data type	Description
ServiceId	int	ID послуги
ReturnInfo	Об'єкт ReturnInfo	Інформація про результати виконання

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

`GetServiceTypesByOrgId()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації.
organisationId	int	ID організації.
languageId	int	ID мови, якою користувач хоче отримати дані.

Тіло запиту

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

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

Code Block

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

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

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

Code Block
{ "ServiceTypeList": [ { "ServiceTypeId": 1, "Description": "ljhvkgvgv" } ], "ReturnInfo": { "ReturnCode": 0, "ReturnSubcode": 0, "ReturnMessage": "OK" } }

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

Property	Data type	Description
ServiceTypeId	int	ID типу послуги
Description	string	Опис типу послуги
ReturnInfo	Объект ReturnInfo	Інформація про результати виконання

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

`GetCustomerTypes()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації.
organisationId	int	ID організації.
serviceCenterId	int	ID мови, якою користувач хоче отримати дані.

Тіло запиту

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

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

Code Block

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


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

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

Code Block

{
    "CustomerTypeList": [
        {
            "CustomerTypeId": 1,
            "Description": "Відвідувач",
            "IdentificationField": ""
        },
        {
            "CustomerTypeId": 2,
            "Description": "Відвідувач попередній запис",
            "IdentificationField": "preliminary"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}


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

Property	Data type	Description
ServiceTypeId	int	ID типу послуги
Description	string	Опис типу послуги
IdentificationField	string	Ідентифікаційне поле
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання

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

`GetCustomerTypesForOrganisation()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації.
organisationId	int	ID організації.
serviceCenterId	int	ID мови, якою користувач хоче отримати дані.

Тіло запиту

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

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

Code Block

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

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

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

Code Block

{
    "CustomerTypeList": [
        {
            "CustomerTypeId": 1,
            "Description": "Відвідувач",
            "IdentificationField": ""
        },
        {
            "CustomerTypeId": 2,
            "Description": "Відвідувач попередній запис",
            "IdentificationField": "preliminary"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Property	Data type	Description
ServiceTypeId	int	ID типу послуги
Description	string	Опис типу послуги
IdentificationField	string	Ідентифікаційне поле
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання

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

`GetDays()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації.
organisationId	int	ID організації.
serviceCenterId	int	IDсервісного центру.
serviceId	int	ID послуги.
startDay	datetime	Початкова дата.
stopDay	datetime	Кінцева дата.

Тіло запиту

Code Block
{ "authToken":"11111111-abcd-dead-beef-0123456789", "organisationId": 1, "serviceCenterId": 1, "serviceId": 1, "startDay":"2024-03-17", "stopDay":"2024-03-18" }

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

Code Block

curl -X POST https://{HOST}/api/servicehub/GetDays \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 1,
        "serviceCenterId": 1,
        "serviceId": 1,
        "startDay": "2024-03-17",
        "stopDay": "2024-03-18"
    }'


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

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

Code Block

{
    "Days": [
        {
            "DatePart": "2024-01-27T00:00:00",
            "IsAllow": 0,
            "Exclude": 0,
            "StartTime": "09:00:00",
            "StopTime": "17:45:00",
            "ScheduleBreak": 0,
            "StartBreak": "13:00:00",
            "StopBreak": "13:45:00",
            "CountJobs": 0,
            "CountJobsAllow": 0
        },
        {
            "DatePart": "2024-01-28T00:00:00",
            "IsAllow": 0,
            "Exclude": 1,
            "StartTime": "08:55:00",
            "StopTime": "21:00:00",
            "ScheduleBreak": 0,
            "StartBreak": "00:00:00",
            "StopBreak": "00:00:00",
            "CountJobs": 0,
            "CountJobsAllow": 0
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Property	Data type	Description
DatePart	datetime	Дата
IsAllow	int	Признак дозволеної реєстрації
Exclude	int	Признак недоступності дати для реєстрації
StartTime	datetime	Початок дня
StopTime	datetime	Кінець дня
ScheduleBreak	bool	Признак наявності перерви
StartBreak	datetime	Початок перерви
StopBreak	datetime	Кінець перерви
CountJobs	int	Кількість зареєстрованих послуг
CountJobsAllow	int	Кількість доступних реєстрацій
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання

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

`GetTimeIntervals()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації.
organisationId	int	ID організації.
serviceCenterId	int	ID сервісного центру.
serviceId	int	ID послуги.
date	datetime	Дата попередньої реєстрації.

Тіло запиту

Code Block
{ "authToken":"11111111-abcd-dead-beef-0123456789", "organisationId": 2, "serviceCenterId": 1, "serviceId": 870, "date": "2024-03-30" }

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

Code Block

curl -X POST https://{HOST}/api/servicehub/GetTimeIntervals \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "serviceId": 870,
        "date": "2024-03-30"
    }'


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

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

Code Block

{
    "TimeIntervals": [
        {
            "StartTime": "09:00:00",
            "StopTime": "09:30:00",
            "TimeType": 1,
            "IsAllow": 1,
            "CountJobs": 0,
            "CountJobsAllow": 25
        },
        {
            "StartTime": "09:30:00",
            "StopTime": "10:00:00",
            "TimeType": 1,
            "IsAllow": 1,
            "CountJobs": 0,
            "CountJobsAllow": 25
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Property	Data type	Description
StartTime	datetime	Початок часовго інтервалу
StopTime	datetime	Кінець часовго інтервалу
TimeType	int	Тип часовго інтервалу (не використовується)
IsAllow	int	Признак дозволеної реєстрації
CountJobs	int	Кількість зареєстрованих послуг
CountJobsAllow	int	Кількість доступних реєстрацій
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання

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

`GetDaysAndIntervals()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації.
organisationId	int	ID організації.
serviceCenterId	int	ID сервісного центру.
serviceId	int	ID послуги.
startDay	datetime	Початкова дата діапазону днів попередньої реєстрації.
stopDay	datetime	Кінцева дата діапазону днів попередньої реєстрації.

Тіло запиту

Code Block
{ "authToken":"11111111-abcd-dead-beef-0123456789", "organisationId": 2, "serviceCenterId": 1, "serviceId": 870, "startDay": "2024-03-17", "stopDay": "2024-03-18" }

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

Code Block

curl -X POST https://{HOST}/api/servicehub/GetDaysAndIntervals \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "serviceId": 870,
        "startDay": "2024-03-17",
        "stopDay": "2024-03-18"
    }'


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

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

Code Block

{
    "DaysAndIntervals": [
        {
            "DatePart": "2024-01-29T00:00:00",
            "IsAllow": 0,
            "Exclude": 0,
            "StartTime": "09:00:00",
            "StopTime": "17:45:00",
            "ScheduleBreak": 0,
            "StartBreak": "13:00:00",
            "StopBreak": "13:45:00",
            "CountJobs": 0,
            "CountJobsAllow": 0,
            "Times": [
                {
                    "StartTime": "09:00:00",
                    "StopTime": "09:30:00",
                    "TimeType": 1,
                    "IsAllow": 0,
                    "CountJobs": 0,
                    "CountJobsAllow": 0
                },
                {
                    "StartTime": "09:30:00",
                    "StopTime": "10:00:00",
                    "TimeType": 1,
                    "IsAllow": 0,
                    "CountJobs": 0,
                    "CountJobsAllow": 0
                }
            ]
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Property	Data type	Description
DatePart	datetime	Дата
IsAllow	int	Признак дозволеної реєстрації
Exclude	int	Признак недоступності дати для реєстрації
StartTime	datetime	Початок дня
StopTime	datetime	Кінець дня
ScheduleBreak	bool	Признак наявності перерви
StartBreak	datetime	Початок перерви
StopBreak	datetime	Кінець перерви
CountJobs	int	Кількість зареєстрованих послуг
CountJobsAllow	int	Кількість доступних реєстрацій
Time.StartTime	datetime	Початок часовго інтервалу
Time.StopTime	datetime	Кінець часовго інтервалу
Time.TimeType	int	Тип часовго інтервалу (не використовується)
Time.IsAllow	int	Признак дозволеної реєстрації
Time.CountJobs	int	Кількість зареєстрованих послуг
Time.CountJobsAllow	int	Кількість доступних реєстрацій
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання

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

`CustomerPush()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації.
organisationId	int	ID організації.
serviceCenterId	int	ID сервісного центру.
serviceId	int	ID послуги.
customerTypeId	int	ID типу клієнта.
languageId	int	ID мови, якою користувач хоче отримати дані.
customerName	string	Ім'я клієнта.
customerPhone	string	Телефон клієнта.
customerEmail	string	Адреса електронної пошти клієнта.
customerInfo	string	Додаткова інформація про клієнта.
regTime	datetime	`regTime` (datetime): Дата і час реєстрації. Необхідно вказувати `StartTime` вибраного часового інтервалу.

Тіло запиту

Code Block

{
    "authToken":"11111111-abcd-dead-beef-0123456789",
    "organisationId": 2,
    "serviceCenterId": 1,
    "serviceId": 1,
    "customerTypeId": 1,
    "languageId": 2,
    "customerName": "CustomerName",
    "customerPhone": "(654)456-98-48",
    "customerEmail": "mail@site.domain",
    "customerInfo": "info",
    "regTime": "2024-05-26 18:00:00"
}

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

Code Block

curl -X POST https://{HOST}/api/servicehub/CustomerPush \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "serviceId": 1,
        "customerTypeId": 1,
        "languageId": 2,
        "customerName": "CustomerName",
        "customerPhone": "(654)456-98-48",
        "customerEmail": "mail@site.domain",
        "customerInfo": "info",
        "regTime": "2024-05-26 18:00:00"
    }'


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

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

Code Block

{
    "RegistrationInfo": {
        "ReceiptNumber": 1,
        "ReceiptLetter": "",
        "ReceiptMarkup": "<html>\r\n\t<head>\r\n\t\t<meta charset=\"windows-1251\"/>\r\n\t\t\r\n\t\t<title>Receipt</title>\r\n\t\t<style type=\"text/css\">\r\n    \t\t\ttd{border-bottom:solid 0px #000; cellspacing:0;}\r\n\t\t</style>\r\n\t</head>\r\n<body>\r\n\t<table align=\"center\" style=\"width:265px;\" cellspacing=\"0\" cellpadding=\"0\">\r\n\t\t<tr style=\"align:center\">\r\n\t\t\t<td colspan=\"2\" align=\"center\">\r\n\t\t\t\t<img width=\"auto\" height=\"70\" src='http://URI/images/81ebe084-0090-481a-beea-2b7566aba338.png'/>\r\n\t\t\t</td>\r\n\t\t</tr>\r\n\t\t<tr>\r\n\t\t\t<td colspan=\"2\" style=\"font-size:12px;\" align=\"center\">\r\n\t\t\t\t\r\n\t\t\t\t<p><HR size=\"2\" color=\"black\" noshade>\r\n\t\t\r\n\t\t\t\t<p style=\"font-size:16px\"><strong>Центр сучасних технологій</strong></p>\r\n\t\t\r\n\t\t\t\t<HR size=\"2\" color=\"black\" noshade>\r\n\t\r\n\t\t\t</td>\r\n\t</tr>\r\n\t\t\r\n\t<tr align=\"center\" >\r\n\t\t<td colspan=\"2\">\r\n\t\t\t<p style=\"font-size:32px\"><strong>ЧЕК</strong> </p>\r\n\t\t</td>\r\n\t</tr>\r\n\t\t\r\n\t<tr align=\"center\">\r\n\t\t<td colspan=\"2\">\r\n\t\t\t<p style=\"font-size:36px\">1</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr align=\"center\">\r\n\t\t<td colspan=\"2\">\r\n\t\t\t\t<p style=\"font-size:16px\">ТВ + Інтернет - Підключення послуг Компанії</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr>\r\n\t\t<td colspan=\"2\"><HR size=\"2\" color=\"black\" noshade></td>\r\n\t</tr>\r\n\t<tr style=\"font-size:16px; text-align:left\" >\r\n\t\t<td>\r\n\t\t\t<p>Час реєстрації:</p>\r\n\t\t</td>\r\n\t\t<td>\r\n\t\t\t<p style=\"font-size:16px; text-align:right\">16:22:02</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr  style=\"font-size:16px; text-align:left\">\r\n\t\t<td>\r\n\t\t\tОператор:\r\n\t\t</td>\r\n\t\t<td>\r\n\t\t\t<p style=\"font-size:16px; text-align:right\">--</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr>\r\n\t\t<td colspan=\"2\"><HR size=\"2\" color=\"black\" noshade></td>\r\n\t</tr>\r\n\t<tr>\r\n\t\t<td style=\"font-size:12px; text-align:center\" colspan=\"2\"><p>Цінуйте Ваш час – вирішуйте питання онлайн!\r\n\r\n       Фінансові питання та зміна пакетів: my.volia.com\r\n       Поради досвічених користувачів: club.volia.com\r\n\t\t\t\r\n       Використайте демо-ПК у у залі!\r\n</p></td>\r\n\t</tr>\t\r\n\t</table>\r\n</body>\r\n</html>",
        "OrderGuid": "49834bc9-fa04-4886-994b-02c9a8ccd9f4"
    },
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Property	Data type	Description
ReceiptNumber	int	Номер чека
ReceiptLetter	string	Буква чека (необов'язково)
ReceiptMarkup	string	HTML розмітка чека для друку
OrderGuid	Guid	Унікальний ідентифікатор реєстрації
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання

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

`CustomerPreReg()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип	Опис
authToken	Guid	Токен авторизації
organisationId	int	ID організації
serviceCenterId	int	ID сервісного центру
serviceId	int	ID послуги
customerName	string	Ім'я клієнта (необов'язкове)
customerPhone	string	Телефон клієнта (необов'язкове)
customerEmail	string	Адреса електронної пошти клієнта (необов'язкове)
customerInfo	string	Додаткова інформація про клієнта (необов'язкове)
regTime	datetime	Дата та час, на який проводиться реєстрація. Під час реєстрації необхідно вказувати StartTime вибраного часового інтервалу

Тіло запиту

Code Block

{
    "authToken":"11111111-abcd-dead-beef-0123456789",
    "organisationId":2,
    "serviceCenterId":1,
    "serviceId":1,
    "customerName":"CustomerName",
    "customerPhone":"(654)456-98-48",
    "customerEmail":"mail@site.domain",
    "customerInfo":"info",
    "regTime":"2024-05-26 18:00:00"
}

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

Code Block

curl -X POST "https://{HOST}/api/servicehub/CustomerPreReg" \
-H "Content-Type: application/json" \
-d '{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "organisationId": 2,
    "serviceCenterId": 1,
    "serviceId": 1,
    "customerName": "CustomerName",
    "customerPhone": "(654)456-98-48",
    "customerEmail": "mail@site.domain",
    "customerInfo": "info",
    "regTime": "2024-05-26 18:00:00"
}'

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

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

Code Block

{
    "RegistrationInfo": {
        "ReceiptNumber": 1,
        "ReceiptLetter": "",
        "ReceiptMarkup": "<html>\r\n\t<head>\r\n\t\t<meta charset=\"windows-1251\"
/>\r\n\t\t\r\n\t\t<title>Receipt</title>\r\n\t\t<style type=\"text/css\">\r\n    \t\t\ttd{border-bottom:solid
0px #000; cellspacing:0;}\r\n\t\t</style>\r\n\t</head>\r\n<body>\r\n\t<table align=\"center\"
style=\"width:265px;\" cellspacing=\"0\" cellpadding=\"0\">\r\n\t\t<tr
style=\"align:center\">\r\n\t\t\t<td colspan=\"2\" align=\"center\">\r\n\t\t\t\t<img width=\"auto\"
height=\"70\" src='http://URI/images/81ebe084-0090-481a-beea-2b7566aba338.png'
/>\r\n\t\t\t</td>\r\n\t\t</tr>\r\n\t\t<tr>\r\n\t\t\t<td colspan=\"2\" style=\"font-size:12px;\"
align=\"center\">\r\n\t\t\t\t\r\n\t\t\t\t<p><HR size=\"2\" color=\"black\" noshade>\r\n\t\t\r\n\t\t\t\t<p
style=\"font-size:16px\"><strong>Центр сучасних технологій</strong></p>\r\n\t\t\r\n\t\t\t\t<HR
size=\"2\" color=\"black\" noshade>\r\n\t\r\n\t\t\t</td>\r\n\t</tr>\r\n\t\t\r\n\t<tr
align=\"center\" >\r\n\t\t<td colspan=\"2\">\r\n\t\t\t<p style=\"font-size:32px\">
<strong>ЧЕК</strong> </p>\r\n\t\t</td>\r\n\t</tr>\r\n\t\t\r\n\t<tr align=\"center\">\r\n\t\t<td
colspan=\"2\">\r\n\t\t\t<p style=\"font-size:36px\">1</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr
align=\"center\">\r\n\t\t<td colspan=\"2\">\r\n\t\t\t\t<p style=\"font-size:16px\">ТВ + Інтернет -
Підключення послуг Компанії</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr>\r\n\t\t<td colspan=\"2\"><HR
size=\"2\" color=\"black\" noshade></td>\r\n\t</tr>\r\n\t<tr style=\"font-size:16px; text-align:left\" >\r\n\t\t<td>\r\n\t\t\t<p>Час реєстрації:</p>\r\n\t\t</td>\r\n\t\t<td>\r\n\t\t\t<p
style=\"font-size:16px; text-align:right\">16:22:02</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr  style=\"font-size:16px; text-align:left\">\r\n\t\t<td>\r\n\t\t\tОператор:\r\n\t\t</td>\r\n\t\t<td>\r\n\t\t\t<p
style=\"font-size:16px; text-align:right\">--</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr>\r\n\t\t<td
colspan=\"2\"><HR size=\"2\" color=\"black\" noshade></td>\r\n\t</tr>\r\n\t<tr>\r\n\t\t<td
style=\"font-size:12px; text-align:center\" colspan=\"2\"><p>Цінуйте Ваш час – вирішуйте
питання онлайн!\r\n\r\n       Фінансові питання та зміна пакетів: my.volia.com\r\n       Поради
досвічених користувачів: club.volia.com\r\n\t\t\t\r\n       Використайте демо-ПК у у
залі!\r\n</p></td>\r\n\t</tr>\t\r\n\t</table>\r\n</body>\r\n</html>",
        " OrderGuid ": "49834bc9-fa04-4886-994b-02c9a8ccd9f4"
    },
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Параметр	Тип	Опис
ReceiptNumber	int	Номер чека
ReceiptLetter	string	Літера чека (необов'язкове)
ReceiptMarkup	string	HTML розмітка чека для друку
OrderGuid	Guid	Унікальний ідентифікатор реєстрації
ReturnInfo	Об'єкт	Інформація про результати виконання

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

`BookCustomer()`

Expand

title

...

Цей запит виконує бронювання реєстрації, яке потребує підтвердження для завершення реєстрації.

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен організації.
organisationId	int	ID організації.
serviceCenterId	int	ID сервісного центру.
serviceId	int	ID послуги.
customerTypeId	int	ID типу клієнта.
customerId	int	ID клієнта.
languageId	int	ID мови, якою користувач хоче отримати дані.
customerName	string	Ім'я клієнта.
customerPhone	string	Телефон клієнта.
customerEmail	string	Адреса електронної пошти клієнта.
customerInfo	string	Додаткова інформація про клієнта.
regTime	datetime	Дата та час, на який здійснюється реєстрація

Тіло запиту

Code Block

{
    "authToken": "11111111-abcd-dead-beef-0123456789",
    "organisationId": 2,
    "serviceCenterId": 1,
    "serviceId": 1,
    "customerTypeId": 1,
    "customerId": 1,
    "languageId": 2,
    "customerName": "CustomerName",
    "customerPhone": "(654)456-98-48",
    "customerEmail": "mail@site.domain",
    "customerInfo": "info",
    "regTime": "2024-05-26 18:00:00"
}

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

Code Block

curl -X POST https://{HOST}/api/servicehub/BookCustomer \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "serviceId": 1,
        "customerTypeId": 1,
        "customerId": 1,
        "languageId": 2,
        "customerName": "CustomerName",
        "customerPhone": "(654)456-98-48",
        "customerEmail": "mail@site.domain",
        "customerInfo": "info",
        "regTime": "2024-05-26 18:00:00"
    }'

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

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

Code Block

{
    "RegistrationInfo": {
        "ReceiptNumber": 1,
        "ReceiptLetter": "",
        "ReceiptMarkup": "<html>\r\n\t<head>\r\n\t\t<meta charset=\"windows-1251\"/>\r\n\t\t\r\n\t\t<title>Receipt</title>\r\n\t\t<style type=\"text/css\">\r\n    \t\t\ttd{border-bottom:solid 0px #000; cellspacing:0;}\r\n\t\t</style>\r\n\t</head>\r\n<body>\r\n\t<table align=\"center\" style=\"width:265px;\" cellspacing=\"0\" cellpadding=\"0\">\r\n\t\t<tr style=\"align:center\">\r\n\t\t\t<td colspan=\"2\" align=\"center\">\r\n\t\t\t\t<img width=\"auto\" height=\"70\" src='http://URI/images/81ebe084-0090-481a-beea-2b7566aba338.png'/>\r\n\t\t\t</td>\r\n\t\t</tr>\r\n\t\t<tr>\r\n\t\t\t<td colspan=\"2\" style=\"font-size:12px;\" align=\"center\">\r\n\t\t\t\t\r\n\t\t\t\t<p><HR size=\"2\" color=\"black\" noshade>\r\n\t\t\r\n\t\t\t\t<p style=\"font-size:16px\"><strong>Центр сучасних технологій</strong></p>\r\n\t\t\r\n\t\t\t\t<HR size=\"2\" color=\"black\" noshade>\r\n\t\r\n\t\t\t</td>\r\n\t</tr>\r\n\t\t\r\n\t<tr align=\"center\" >\r\n\t\t<td colspan=\"2\">\r\n\t\t\t<p style=\"font-size:32px\"><strong>ЧЕК</strong> </p>\r\n\t\t</td>\r\n\t</tr>\r\n\t\t\r\n\t<tr align=\"center\">\r\n\t\t<td colspan=\"2\">\r\n\t\t\t<p style=\"font-size:36px\">1</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr align=\"center\">\r\n\t\t<td colspan=\"2\">\r\n\t\t\t\t<p style=\"font-size:16px\">ТВ + Інтернет - Підключення послуг Компанії</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr>\r\n\t\t<td colspan=\"2\"><HR size=\"2\" color=\"black\" noshade></td>\r\n\t</tr>\r\n\t<tr style=\"font-size:16px; text-align:left\" >\r\n\t\t<td>\r\n\t\t\t<p>Час реєстрації:</p>\r\n\t\t</td>\r\n\t\t<td>\r\n\t\t\t<p style=\"font-size:16px; text-align:right\">16:22:02</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr  style=\"font-size:16px; text-align:left\">\r\n\t\t<td>\r\n\t\t\tОператор:\r\n\t\t</td>\r\n\t\t<td>\r\n\t\t\t<p style=\"font-size:16px; text-align:right\">--</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr>\r\n\t\t<td colspan=\"2\"><HR size=\"2\" color=\"black\" noshade></td>\r\n\t</tr>\r\n\t<tr>\r\n\t\t<td style=\"font-size:12px; text-align:center\" colspan=\"2\"><p>Цінуйте Ваш час – вирішуйте питання онлайн!\r\n\r\n       Фінансові питання та зміна пакетів: my.volia.com\r\n       Поради досвічених користувачів: club.volia.com\r\n\t\t\t\r\n       Використайте демо-ПК у у залі!\r\n</p></td>\r\n\t</tr>\t\r\n\t</table>\r\n</body>\r\n</html>",
        "OrderGuid": "49834bc9-fa04-4886-994b-02c9a8ccd9f4"
    },
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Property	Data type	Description
ReceiptNumber	int	Номер чека
ReceiptLetter	string	Буква чека (необов'язково)
ReceiptMarkup	string	HTML розмітка чека для друку
OrderGuid	Guid	Унікальний ідентифікатор реєстрації
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання

Цей запит виконує бронювання реєстрації, яке потребує підтвердження для завершення реєстрації.

`ConfirmRegistration()`

Expand

title

...

методу BookCustomer().

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації.
organisationId	int	ID організації.
orderGuid	Guid	Унікальний ідентифікатор підтверджуваної реєстрації.

Тіло запиту

Code Block
{ "authToken": "11111111-abcd-dead-beef-0123456789", "organisationId": 2, "orderGuid": "49834bc9-fa04-4886-994b-02c9a8ccd9f4" }

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

Code Block

curl -X POST https://{HOST}/api/servicehub/ConfirmRegistration \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "orderGuid": "49834bc9-fa04-4886-994b-02c9a8ccd9f4"
    }'


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

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

Code Block
{ "ReturnCode": 0, "ReturnSubcode": 0, "ReturnMessage": "OK" }

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

Property	Data type	Description
ReturnCode	int	Код результату
ReturnSubcode	int	Підкод результату
ReturnMessage	string	Повідомлення про результат

Цей запит підтверджує бронювання реєстрації, яке було виконано за допомогою методу BookCustomer().

`GetReceipt()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації.
organisationId	int	ID організації.
serviceCenterId	int	ID сервісного центру.
orderGuid	Guid	Унікальний ідентифікатор реєстрації.

Тіло запиту

Code Block
{ "authToken": "11111111-abcd-dead-beef-0123456789", "organisationId": 2, "serviceCenterId": 1, "orderGuid": "49834bc9-fa04-4886-994b-02c9a8ccd9f4" }

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

Code Block

curl -X POST https://{HOST}/api/servicehub/GetReceipt \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "serviceCenterId": 1,
        "orderGuid": "49834bc9-fa04-4886-994b-02c9a8ccd9f4"
    }'


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

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

Code Block

{
    "ReceiptMarkup": "<html>\r\n\t<head>\r\n\t\t<meta charset=\"windows-1251\" />\r\n\t\t\r\n\t\t<title>Receipt</title>\r\n\t\t<style type=\"text/css\">\r\n    \t\t\ttd{border-bottom:solid 0px #000; cellspacing:0;}\r\n\t\t</style>\r\n\t</head>\r\n<body>\r\n\t<table align=\"center\" style=\"width:265px;\" cellspacing=\"0\" cellpadding=\"0\">\r\n\t\t<tr style=\"align:center\">\r\n\t\t\t<td colspan=\"2\" align=\"center\">\r\n\t\t\t\t<img width=\"auto\" height=\"70\" src='http://URI/images/81ebe084-0090-481a-beea-2b7566aba338.png' />\r\n\t\t\t</td>\r\n\t\t</tr>\r\n\t\t<tr>\r\n\t\t\t<td colspan=\"2\" style=\"font-size:12px;\" align=\"center\">\r\n\t\t\t\t\r\n\t\t\t\t<p><HR size=\"2\" color=\"black\" noshade>\r\n\t\t\t\t<p style=\"font-size:16px\"><strong>Центр сучасних технологій</strong></p>\r\n\t\t\t\t<HR size=\"2\" color=\"black\" noshade>\r\n\t\r\n\t\t\t</td>\r\n\t</tr>\r\n\t\t\r\n\t<tr align=\"center\" >\r\n\t\t<td colspan=\"2\">\r\n\t\t\t<p style=\"font-size:32px\"><strong>ЧЕК</strong> </p>\r\n\t\t</td>\r\n\t</tr>\r\n\t\t\r\n\t<tr align=\"center\">\r\n\t\t<td colspan=\"2\">\r\n\t\t\t\t<p style=\"font-size:36px\">1</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr align=\"center\">\r\n\t\t<td colspan=\"2\">\r\n\t\t\t\t<p style=\"font-size:16px\">ТВ + Інтернет - Підключення послуг Компанії</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr>\r\n\t\t<td colspan=\"2\"><HR size=\"2\" color=\"black\" noshade></td>\r\n\t</tr>\r\n\t<tr style=\"font-size:16px; text-align:left\" >\r\n\t\t<td>\r\n\t\t\t<p>Час реєстрації:</p>\r\n\t\t</td>\r\n\t\t<td>\r\n\t\t\t<p style=\"font-size:16px; text-align:right\">16:22:02</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr  style=\"font-size:16px; text-align:left\">\r\n\t\t<td>\r\n\t\t\tОператор:\r\n\t\t</td>\r\n\t\t<td>\r\n\t\t\t<p style=\"font-size:16px; text-align:right\">--</p>\r\n\t\t</td>\r\n\t</tr>\r\n\t<tr>\r\n\t\t<td colspan=\"2\"><HR size=\"2\" color=\"black\" noshade></td>\r\n\t</tr>\r\n\t<tr>\r\n\t\t<td style=\"font-size:12px; text-align:center\" colspan=\"2\"><p>Цінуйте Ваш час – вирішуйте питання онлайн!\r\n\r\n       Фінансові питання та зміна пакетів: my.volia.com\r\n       Поради досвічених користувачів: club.volia.com\r\n\t\t\t\r\n       Використайте демо-ПК у у залі!\r\n</p></td>\r\n\t</tr>\t\r\n\t</table>\r\n</body>\r\n</html>",
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Property	Data type	Description
ReceiptMarkup	string	HTML розмітка чека для друку
ReturnInfo	об'єкт ReturnInfo	Інформація про результат виконання

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

`GetOrderHistory()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації.
organisationId	int	ID організації.
orderGuid	Guid	Унікальний ідентифікатор реєстрації.

Тіло запиту

Code Block
{ "authToken": "11111111-abcd-dead-beef-0123456789", "organisationId": 2, "orderGuid": "49834bc9-fa04-4886-994b-02c9a8ccd9f4" }


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

Code Block

curl -X POST https://{HOST}/api/servicehub/GetOrderHistory \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "orderGuid": "49834bc9-fa04-4886-994b-02c9a8ccd9f4"
    }'

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

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

Code Block

{
  "Waypoints": [
    {
        "OrderName": "",
        "StatusId": 1,
        "StatusDescription": "",
        "SetJobTime": "2024-05-26 18:00:00",
        "CallTime": "2024-05-26 18:00:00",
        "BeginTime": "2024-05-26 18:00:00",
        "CompleteTime": "2024-05-26 18:00:00",
        "EventTime": "2024-05-26 18:00:00",
        "CustomerEventID": 20,
        "CustomerEventDescription": "",
        "ServiceName": "",
        "WorkPlaceDescription": "",
        "EmployeeName": "",
        "ToServiceName": "",
        "ToWorkplaceDescription": "",
        "ToEmployeeName": ""
    }
  ],
  "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Property	Data type	Description
OrderName	string	Назва реєстрації
StatusId	int	Ідентифікатор статусу реєстрації
StatusDescription	string	Опис статусу реєстрації
SetJobTime	datetime	Дата і час реєстрації
CallTime	datetime	Дата і час виклику клієнта
BeginTime	datetime	Дата і час початку обслуговування
CompleteTime	datetime	Дата і час завершення обслуговування
EventTime	datetime	Дата і час події
CustomerEventId	int	Ідентифікатор події
CustomerEventDescription	string	Опис події
ServiceName	string	Назва послуги
WorkPlaceDescription	string	Опис робочого місця
EmployeeName	string	Ім'я співробітника
ToServiceName	string	Назва нової послуги у випадку зміни
ToWorkplaceDescription	string	Опис робочого місця, на яке перенаправляється клієнт
ToEmployeeName	string	Ім'я співробітника, до якого перенаправляється клієнт
ReturnInfo	об'єкт ReturnInfo	Інформація про результат виконання

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

`DropOrder()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації
organisationId	int	ID організації.
orderGuid	Guid	Унікальний ідентифікатор реєстрації, яку потрібно видалити.

Тіло запиту

Code Block
{ "authToken": "11111111-abcd-dead-beef-0123456789", "organisationId": 2, "orderGuid": "49834bc9-fa04-4886-994b-02c9a8ccd9f4" }

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

Code Block

curl -X POST https://{HOST}/api/servicehub/DropOrder \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 2,
        "orderGuid": "49834bc9-fa04-4886-994b-02c9a8ccd9f4"
    }'

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

Успішна відповідь підтверджує видалення реєстрації. Приклад структури відповіді:

Code Block
{ "ReturnInfo": { "ReturnCode": 0, "ReturnSubcode": 0, "ReturnMessage": "OK" } }

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

Property	Data type	Description
ReturnInfo	об'єкт ReturnInfo	Інформація про результат виконання

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

`GetActivatedOrderInfo()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації.
organisationId	int	ID організації.
serviceCenterId	int	ID сервісного центру.
orderGuid	Guid	Унікальний ідентифікатор реєстрації.

Тіло запиту

Code Block
{ "authToken": "11111111-abcd-dead-beef-0123456789", "organisationId": 4, "serviceCenterId": 2, "orderGuid": "9bf9e892-c5bd-4bc6-a59c-598389b7c4fc" }

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

Code Block

curl -X POST https://{HOST}/api/servicehub/GetActivatedOrderInfo \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 4,
        "serviceCenterId": 2,
        "orderGuid": "9bf9e892-c5bd-4bc6-a59c-598389b7c4fc"
    }'


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

Відповідь містить інформацію про активовану реєстрацію:

Code Block
{ "EstimateTime": "2.16:51:00", "CustomersPerWorkplace": 0, "WorkplaceCount": 5, "WorkplaceList": "1, 3, 4, 7, 9", "ReturnInfo": { "ReturnCode": 0, "ReturnSubcode": 0, "ReturnMessage": "OK" } }

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

Property	Data type	Description
EstimateTime	datetime	Час, що залишився до виклику
CustomersPerWorkplace	int	Кількість клієнтів на робоче місце
WorkplaceCount	int	Кількість активних робочих місць
WorkplaceList	string	Перелік робочих місць, розділений комами
ReturnInfo	об'єкт ReturnInfo	Інформація про результат виконання

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

`SetAssessment()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Опис
authToken	Guid	Токен авторизації.
organisationId	int	ID організації.
orderGuid	Guid	Унікальний ідентифікатор реєстрації.
assessment	int	Оцінка якості наданої послуги.

Тіло запиту

Code Block
{ "authToken": "11111111-abcd-dead-beef-0123456789", "organisationId": 1, "orderGuid": "11111111-abcd-dead-beef-0123456789", "assessment": 5 }

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

Code Block

curl -X POST https://{HOST}/api/servicehub/SetAssessment \
    -H "Content-Type: application/json" \
    -d '{
        "authToken": "11111111-abcd-dead-beef-0123456789",
        "organisationId": 1,
        "orderGuid": "11111111-abcd-dead-beef-0123456789",
        "assessment": 5
    }'

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

Відповідь підтверджує успішне виконання запиту:

Code Block
{ "ReturnInfo": { "ReturnCode": 0, "ReturnSubcode": 0, "ReturnMessage": "OK" } }

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

Property	Data type	Description
ReturnInfo	об'єкт ReturnInfo	Інформація про результат виконання

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

`GetOrganisationInfo()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Обов'язковість	Опис
authToken	Guid		Токен авторизації.
organisationId	int		ID організації.

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

Тіло запиту

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

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

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

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

Відповідь містить деталі про сервісні центри організації:

Code Block

{
    "ServiceCenters": [
        {
            "BranchId": 1,
            "BranchName": "Дніпровська набережна, 19 Б",
            "ServiceCenterId": 1,
            "ServiceCenterName": "ЦНАП м. Києва",
            "LocationId": 1,
            "LocationName": "Київ",
            "ExecutedJobsCount": 127,
            "DeletedJobsCount": 31,
            "WaitJobsCount": 6,
            "WaitJobsCountOther": 5,
            "WaitJobsCountSMS": 1,
            "WorkplacesInWork": 18,
            "WorkplacesOutOfWork": 50,
            "AvgWaitTime": 29668,
            "AvgProcTime": 1032,
            "WorkplacesInWorkOther": 15,
            "WorkplacesInWorkSMS": 3,
            "IsActive": 1,
            "CustTotal": 116,
            "ExtCenterId": 0
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Property	Data type	Description
BranchId	int	Ідентифікатор гілки
BranchName	string	Назва гілки
ServiceCenterId	int	Ідентифікатор сервісного центру
ServiceCenterName	string	Назва сервісного центру
LocationId	int	Ідентифікатор локації
LocationName	string	Назва локації
ExecutedJobsCount	int	Кількість завершених реєстрацій
DeletedJobsCount	int	Кількість видалених реєстрацій
WaitJobsCount	int	Кількість очікуючих реєстрацій
WaitJobsCountOther	int	Кількість очікуючих реєстрацій (інші)
WaitJobsCountSMS	int	Кількість очікуючих реєстрацій (SMS)
WorkplacesInWork	int	Кількість активних робочих місць
WorkplacesOutOfWork	int	Кількість неактивних робочих місць
AvgWaitTime	int	Середній час очікування (в секундах)
AvgProcTime	int	Середній час обробки (в секундах)
WorkplacesInWorkOther	int	Кількість активних робочих місць (інші)
WorkplacesInWorkSMS	int	Кількість активних робочих місць (SMS)
IsActive	int	Признак активності сервісного центру (1 – активний)
CustTotal	int	Загальна кількість клієнтів
ExtCenterId	int	Внешній ID сервісного центру
ReturnInfo	об'єкт ReturnInfo	Інформація про результат виконання

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

`GetServiceCentersSettings()`

Expand

title

...

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

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

Метод

'POST'

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

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

Параметр	Тип даних	Обов'язковість	Опис
authToken	Guid		Токен авторизації.
organisationId	int		ID організації.

Тіло запиту

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

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

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

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

Code Block

{
    "SettingsList": [
        {
            "ServiceCenterId": 1,
            "ServiceCenterGuid": "5fc70ec7-d9ed-495b-a91c-21a802d6b5dc",
            "Sop": "2024-01-26T00:00:00+02:00",
            "PQLimitDays": 60
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

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

Property	Data type

...

Description
ServiceCenterId	int	ID сервісного центру.
ServiceCenterGuid	Guid	Унікальний ідентифікатор сервісного центру.
Sop	datetime	Дата, з якої дозволена попередня реєстрація.
PQLimitDays	int	Кількість днів, протягом яких дозволена попередня реєстрація.
ReturnInfo	об'єкт ReturnInfo	Інформація про результати виконання.

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

`ReturnInfo`

Expand

title

...

Объект ReturnInfo предоставляет информацию о результате выполнения запроса. В зависимости от результата выполнения запроса, объект ReturnInfo может содержать разные коды ошибок и сообщения.

...

`Возможные результаты выполнения запросов`

...

Повідомлення про результат виконання.

Можливі результати виконання запитів

Успішне виконання

Code Block
{ "ReturnInfo": { "ReturnCode": 0, "ReturnSubcode": 0, "ReturnMessage": "OK" } }

...

2001	Неіснуючий токен авторизації
2002	Токен авторизації не активовано
2003	Час доступності токена авторизації закінчився
2004	Переданий токен авторизації не допускає запити з поточної ip-адреси або імені сервера клієнта
2006	Організація із зазначеним ID не знайдена
2017	Не вказано унікального ідентифікатора організації
2018	Унікальний ідентифікатор організації
2019	Організація із зазначеним GUID не знайдена
2025	Ip-адреса або ім'я сервера клієнта змінилися з моменту останнього входу
2026	Помилка підключення до БД
2032	Організація із зазначеним ID на даний момент недоступна
2033	Сервісний центр із зазначеним ID на даний момент недоступний
2034	Інтервал між реєстраціями занадто малий
2100	Помилка при запиті сервісу нижче
2101	Повідомлення від сервера черги

Table of Contents

maxLevel	2

`Коды ошибок сервера очереди`

Код ошибки	Описание
2001	Несуществующий токен авторизации
2002	Токен авторизации не активирован
2003	Время доступности токена авторизации истекло
2004	Переданный токен авторизации не допускает запросы с текущего IP адреса или имени сервера клиента
2006	Организация с указанным ID не найдена
2017	Не указан уникальный идентификатор организации
2018	Уникальный идентификатор организации имеет неверный формат
2019	Организация с указанным GUID не найдена
2025	IP адрес или имя сервера клиента изменились с момента последнего входа
2026	Ошибка подключения к БД
2032	Организация с указанным ID в данный момент недоступна
2033	Сервисный центр с указанным ID в данный момент недоступен
2034	Интервал между регистрациями слишком мал

`Ошибки сервера очереди`

...

Page tree

Page History

Versions Compared

Old Version 37

New Version Current

Key

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

Запити:

GetOrganisations()

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

Метод

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

Тіло запиту

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

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

Опис полів

GetServiceCenters()

URL

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

Метод

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

Тіло Запиту

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

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

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

GetCities()

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

Метод

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

Тіло запиту

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

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

GetOrganisationsByCityId()

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

Метод

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

Тіло запиту

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

GetServiceCentersByOrgAndCityId()

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

Метод

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

Тіло запиту

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

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

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

GetServiceCentersByService()

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

Метод

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

Тіло запиту

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

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

GetAllGroups()

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

Метод

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

Тіло запиту

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

GetGroupsByParentId()

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

Метод

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

Тіло запиту

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

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

GetAllServices()

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

Метод

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

Тіло запиту

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

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

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

GetServicesByGroupId()

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

Метод

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

Тіло запиту

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

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

`GetOrganisations()`

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

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

`GetServiceCenters()`

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

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

`GetCities()`

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

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

`GetOrganisationsByCityId()`

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

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

`GetServiceCentersByOrgAndCityId()`

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

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

`GetServiceCentersByService()`

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

`GetAllGroups()`

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

`GetGroupsByParentId()`

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

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

`GetAllServices()`

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

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

`GetServicesByGroupId()`

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

`GetServicesByServiceCenter()`

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

`GetServiceIdByTypeId()`

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

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

`GetServiceTypesByOrgId()`

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

`GetCustomerTypes()`

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

`GetCustomerTypesForOrganisation()`

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

`GetDays()`

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

`GetTimeIntervals()`

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

`GetDaysAndIntervals()`

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

`CustomerPush()`

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

`CustomerPreReg()`

`BookCustomer()`

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

`ConfirmRegistration()`

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

`GetReceipt()`

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