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

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

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

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

Запити:

GetOrganisations()

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

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

Метод

'POST'

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

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

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


 Тіло запиту

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

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

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

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

 {
    "OrganisationList": [
        {
            "OrgTypeId": 1,
            "OrgTypeDescription": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ",
            "Code": 240,
            "LocationId": 1,
            "GeoInfo": {
                "CityId": 47,
                "City": "Первомайське",
                "RegionId": 1,
                "Region": "АР Крим",
                "CountryId": 1,
                "Country": "Україна",
                "Address": "ул. Пушкина"
            },
            "OrganisationId": 1,
            "OrganisationName": "test"
        },
        {
            "OrgTypeId": 1,
            "OrgTypeDescription": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ",
            "Code": 240,
            "LocationId": 1,
            "GeoInfo": {
                "CityId": 47,
                "City": "Первомайське",
                "RegionId": 1,
                "Region": "АР Крим",
                "CountryId": 1,
                "Country": "Україна",
                "Address": "ул. Пушкина"
            },
            "OrganisationId": 2,
            "OrganisationName": "Volia"
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}

 Опис полів

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

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

GetServiceCenters()

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

URL

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

Метод

'POST'

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

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

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


Тіло Запиту 

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

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

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

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

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

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

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

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

GetCities()

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

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

Метод

'POST'

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

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

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


Тіло запиту

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

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

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

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

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

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

Опис полів відповіді
PropertyData typeDescription
CityIdintID міста
CitystringНазва міста
RegionIdintID регіону (області)
RegionstringНазва регіону (області)
CountryIdintID країни
CountrystringНазва країни
AddressstringАдреса організації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання

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

GetOrganisationsByCityId()

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

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

Метод

'POST'

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

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

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


Тіло запиту

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

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

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 об'єкт зі списком організацій та інформацією про результат виконання. Приклад структури відповіді:

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

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


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

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

GetServiceCentersByOrgAndCityId()

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

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

Метод

'POST'

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

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

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


Тіло запиту

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

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

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 об'єкт зі списком сервісних центрів та інформацією про результат виконання. Приклад структури відповіді:

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

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

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

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

GetServiceCentersByService()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен аутентифікації, який підтверджує, що користувач має право доступу до API.
serviceIdint
ID послуги.
serviceTypeIdint
ID типів послуг.
fromdatetime
Початкова дата і час.
todatetime
Кінцева дата і час.
languageIdint
ID мови, якою користувач хоче отримати дані.


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

Тіло запиту

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

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 об'єкт зі списком сервісних центрів та інформацією про результат виконання. Приклад структури відповіді:

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


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

PropertyData typeDescription
ServiceCenterIdintID сервісного центру
ServiceCenterNamestringНазва сервісного центру
OrganisationIdintID організації
OrganisationNamestringНазва організації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання

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

Вміст параметрів

Логіка 

serviceIdfromto
Nyyyy-MM-dd hh:mm:ssyyyy-MM-dd hh:mm:ssПовертає всі СЦ, де доступна попередня реєстрація послуги N в інтервалі від from до to
NNULLyyyy-MM-dd hh:mm:ssПовертає всі СЦ, в яких доступна попередня реєстрація послуги N в інтервалі yyyy-MM-dd ... to
Nyyyy-MM-dd hh:mm:ssNULLповертає всі СЦ, в яких доступна попередня реєстрація послуги N в from ... yyyy-MM-dd 23:59:59
NNULLNULLповертає всі СЦ, в яких доступна попередня реєстрація послуги N протягом завтрашнього дня
NULLyyyy-MM-dd hh:mm:ssyyyy-MM-dd hh:mm:ssповертає всі СЦ, в яких доступна попередня реєстрація в інтервалі from ... to
NULLNULLyyyy-MM-dd hh:mm:ssповертає всі СЦ, в яких доступна попередня реєстрація в інтервалі yyyy-MM-dd ... to
NULLyyyy-MM-dd hh:mm:ssNULLповертає всі СЦ, в яких доступна попередня реєстрація в from ... yyyy-MM-dd 23:59:59
NULLNULLNULL повертає всі СЦ, в яких доступна попередня реєстрація протягом завтрашнього дня

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

GetAllGroups()

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

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

Метод

'POST'

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

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

ПараметрТип данихОпис
authTokenGuidТокен аутентифікації.
organisationIdintID організації.
serviceCenterIdintID сервісного центру.
languageIdintID мови, якою користувач хоче отримати дані.


Тіло запиту

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


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

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 об'єкт зі списком груп послуг та інформацією про результат виконання. Приклад структури відповіді:

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

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

PropertyData typeDescription
GroupIdintID групи
ParentGroupIdintID батьківської групи
DescriptionstringОпис групи
OrderWeightintВаговий коефіцієнт для сортування
ReturnInfoОбъект ReturnInfoІнформація про результати виконання

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

GetGroupsByParentId()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен аутентифікації.
organisationIdint
ID організації.
serviceCenterIdint
ID сервісного центру.
parentGroupIdint
ID батьківської групи.
languageIdint
ID мови, якою користувач хоче отримати дані.


Тіло запиту

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

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

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 об'єкт зі списком груп послуг та інформацією про результат виконання. Приклад структури відповіді:

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

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

PropertyData typeDescription
GroupIdintID групи
ParentGroupIdintID батьківської групи
DescriptionstringОпис групи
OrderWeightintВаговий коефіцієнт для сортування
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання

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

GetAllServices()

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

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

Метод

'POST'

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

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

ПараметрТип даних
Опис
authTokenGuid
Токен аутентифікації.
organisationIdint
ID організації.
serviceCenterIdint
ID сервісного центру.
languageIdint
ID мови, якою користувач хоче отримати дані.


Тіло запиту

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

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

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 об'єкт зі списком послуг та інформацією про результат виконання. Приклад структури відповіді:

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

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

PropertyData typeDescription
ServiceIdintID послуги
GroupIdintID групи, до якої належить послуга
DescriptionstringОпис послуги
OrderWeightintВаговий коефіцієнт для сортування
ReturnInfoОбъект ReturnInfoІнформація про результати виконання

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

GetServicesByGroupId()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен аутентифікації.
organisationIdint
ID організації.
serviceCenterIdint
ID сервісного центру.
groupIdint
ID групи послуг.
languageIdint
ID мови, якою користувач хоче отримати дані.


Тіло запиту

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


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

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 об'єкт зі списком послуг та інформацією про результат виконання. Приклад структури відповіді:

{
    "ServiceList": [
        {
            "ServiceId": 870,
            "GroupId": 204,
            "Description": "Подати документи щодо оформлення ID картки та закордонного паспортa",
            "OrderWeight": 835
        }
    ],
    "ReturnInfo": {
        "ReturnCode": 0,
        "ReturnSubcode": 0,
        "ReturnMessage": "OK"
    }
}


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

PropertyData typeDescription
ServiceIdintID послуги
GroupIdintID групи, до якої належить послуга
DescriptionstringОпис послуги
OrderWeightintВаговий коефіцієнт для сортування
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання

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

GetServicesByServiceCenter()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен аутентифікації.
serviceCenterIdint
ID сервісного центру.
serviceTypeIdint[]
Перелік ID типів послуг.
fromdatetime Початкова дата.
todatetime
Кінцева дата.
languageIdint
ID мови, якою користувач хоче отримати дані.


Тіло запиту

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

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 об'єкт зі списком послуг та інформацією про результат виконання. Приклад структури відповіді:

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


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

PropertyData typeDescription
OrganisationIdintID організації
ServiceCenterIdintID сервісного центру
ServiceIdintID послуги
UniqueServiceIdintУнікальний ID послуги
ServiceNamestringНазва послуги
ServiceTypeIdint[]Перелік ID типів послуг
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання

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

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


Примітка

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

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

GetServiceIdByTypeId()

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

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

Метод

'POST'

Тіло запиту

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

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

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


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

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

ПараметрТипОбов'язковістьОпис
authTokenGuid
Токен авторизації
organisationIdint
ID організації
serviceTypeIdint
ID типу послуги
serviceCenterIdint
ID сервісного центру


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

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


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

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

PropertyData typeDescription
ServiceIdintID послуги
ReturnInfoОб'єкт ReturnInfoІнформація про результати виконання

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

GetServiceTypesByOrgId()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації.
organisationIdint
ID організації.
languageIdint
ID мови, якою користувач хоче отримати дані.


Тіло запиту

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


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

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 об'єкт зі списком типів послуг та інформацією про результат виконання. Приклад структури відповіді:

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

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

PropertyData typeDescription
ServiceTypeIdintID типу послуги
DescriptionstringОпис типу послуги
ReturnInfoОбъект ReturnInfoІнформація про результати виконання

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

GetCustomerTypes()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації.
organisationIdint
ID організації.
serviceCenterIdint
ID мови, якою користувач хоче отримати дані.


Тіло запиту

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


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

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 об'єкт зі списком груп клієнтів та інформацією про результат виконання. Приклад структури відповіді:

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

Опис полів відповіді
PropertyData typeDescription
ServiceTypeIdintID типу послуги
DescriptionstringОпис типу послуги
IdentificationFieldstringІдентифікаційне поле
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання

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

GetCustomerTypesForOrganisation()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації.
organisationIdint
ID організації.
serviceCenterIdint
ID мови, якою користувач хоче отримати дані.


Тіло запиту

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


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

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 об'єкт зі списком груп клієнтів та інформацією про результат виконання. Приклад структури відповіді:

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

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

PropertyData typeDescription
ServiceTypeIdintID типу послуги
DescriptionstringОпис типу послуги
IdentificationFieldstringІдентифікаційне поле
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання

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

GetDays()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації.
organisationIdint
ID організації.
serviceCenterIdint
IDсервісного центру.
serviceIdint
ID послуги.
startDaydatetime
Початкова дата.
stopDaydatetime
Кінцева дата.


Тіло запиту

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


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

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 об'єкт зі списком днів та інформацією про результат виконання. Приклад структури відповіді:

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


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

PropertyData typeDescription
DatePartdatetimeДата
IsAllowintПризнак дозволеної реєстрації
ExcludeintПризнак недоступності дати для реєстрації
StartTimedatetimeПочаток дня
StopTimedatetimeКінець дня
ScheduleBreakboolПризнак наявності перерви
StartBreakdatetimeПочаток перерви
StopBreakdatetimeКінець перерви
CountJobsintКількість зареєстрованих послуг
CountJobsAllowintКількість доступних реєстрацій
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання

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

GetTimeIntervals()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації.
organisationIdint
ID організації.
serviceCenterIdint
ID сервісного центру.
serviceIdint
ID послуги.
datedatetime
Дата попередньої реєстрації.


Тіло запиту

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


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

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 об'єкт зі списком часових інтервалів та інформацією про результат виконання. Приклад структури відповіді:

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


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

PropertyData typeDescription
StartTimedatetimeПочаток часовго інтервалу
StopTimedatetimeКінець часовго інтервалу
TimeTypeintТип часовго інтервалу (не використовується)
IsAllowintПризнак дозволеної реєстрації
CountJobsintКількість зареєстрованих послуг
CountJobsAllowintКількість доступних реєстрацій
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання

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

GetDaysAndIntervals()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації.
organisationIdint
ID організації.
serviceCenterIdint
ID сервісного центру.
serviceIdint
ID послуги.
startDaydatetime
Початкова дата діапазону днів попередньої реєстрації.
stopDaydatetime
Кінцева дата діапазону днів попередньої реєстрації.


Тіло запиту

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


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

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 об'єкт зі списком днів та часових інтервалів, а також інформацією про результат виконання. Приклад структури відповіді:

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


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

PropertyData typeDescription
DatePartdatetimeДата
IsAllowintПризнак дозволеної реєстрації
ExcludeintПризнак недоступності дати для реєстрації
StartTimedatetimeПочаток дня
StopTimedatetimeКінець дня
ScheduleBreakboolПризнак наявності перерви
StartBreakdatetimeПочаток перерви
StopBreakdatetimeКінець перерви
CountJobsintКількість зареєстрованих послуг
CountJobsAllowintКількість доступних реєстрацій
Time.StartTimedatetimeПочаток часовго інтервалу
Time.StopTimedatetimeКінець часовго інтервалу
Time.TimeTypeintТип часовго інтервалу (не використовується)
Time.IsAllowintПризнак дозволеної реєстрації
Time.CountJobsintКількість зареєстрованих послуг
Time.CountJobsAllowintКількість доступних реєстрацій
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання

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

CustomerPush()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації.
organisationIdint
ID організації.
serviceCenterIdint
ID сервісного центру.
serviceIdint
ID послуги.
customerTypeIdint
ID типу клієнта.
languageIdint
ID мови, якою користувач хоче отримати дані.
customerNamestring
Ім'я клієнта.
customerPhonestring
Телефон клієнта.
customerEmailstring
Адреса електронної пошти клієнта.
customerInfostring
Додаткова інформація про клієнта.
regTimedatetime
regTime (datetime): Дата і час реєстрації. Необхідно вказувати StartTime вибраного часового інтервалу.


Тіло запиту

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

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 об'єкт з інформацією про реєстрацію та результат виконання. Приклад структури відповіді:

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


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

PropertyData typeDescription
ReceiptNumberintНомер чека
ReceiptLetterstringБуква чека (необов'язково)
ReceiptMarkupstringHTML розмітка чека для друку
OrderGuidGuidУнікальний ідентифікатор реєстрації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання

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

CustomerPreReg()

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

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

Метод

'POST'

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

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

ПараметрТипОбов'язковістьОпис
authTokenGuid
Токен авторизації
organisationIdint
ID організації
serviceCenterIdint
ID сервісного центру
serviceIdint
ID послуги
customerNamestring
Ім'я клієнта (необов'язкове)
customerPhonestring
Телефон клієнта (необов'язкове)
customerEmailstring
Адреса електронної пошти клієнта (необов'язкове)
customerInfostring
Додаткова інформація про клієнта (необов'язкове)
regTimedatetime
Дата та час, на який проводиться реєстрація. Під час реєстрації необхідно вказувати StartTime вибраного часового інтервалу


Тіло запиту

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

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 об'єкт з інформацією про реєстрацію та результат виконання. Приклад структури відповіді:

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

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

ПараметрТипОпис
ReceiptNumberintНомер чека
ReceiptLetterstringЛітера чека (необов'язкове)
ReceiptMarkupstringHTML розмітка чека для друку
OrderGuidGuidУнікальний ідентифікатор реєстрації
ReturnInfoОб'єктІнформація про результати виконання

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

BookCustomer()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен організації.
organisationIdint
ID організації.
serviceCenterIdint
ID сервісного центру.
serviceIdint
ID послуги.
customerTypeIdint
ID типу клієнта.
customerIdint
ID клієнта.
languageIdint
ID мови, якою користувач хоче отримати дані.
customerNamestring
Ім'я клієнта.
customerPhonestring
Телефон клієнта.
customerEmailstring
Адреса електронної пошти клієнта.
customerInfostring
Додаткова інформація про клієнта.
regTimedatetime
Дата та час, на який здійснюється реєстрація

Тіло запиту

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

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 об'єкт з інформацією про реєстрацію та результат виконання. Приклад структури відповіді:

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

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

PropertyData typeDescription
ReceiptNumberintНомер чека
ReceiptLetterstringБуква чека (необов'язково)
ReceiptMarkupstringHTML розмітка чека для друку
OrderGuidGuidУнікальний ідентифікатор реєстрації
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання

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

ConfirmRegistration()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації.
organisationIdint
ID організації.
orderGuidGuid
Унікальний ідентифікатор підтверджуваної реєстрації.


Тіло запиту

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


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

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 об'єкт з інформацією про результат виконання. Приклад структури відповіді:

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


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

PropertyData typeDescription
ReturnCodeintКод результату
ReturnSubcodeintПідкод результату
ReturnMessagestringПовідомлення про результат

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

GetReceipt()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації.
organisationIdint
ID організації.
serviceCenterIdint
ID сервісного центру.
orderGuidGuid
Унікальний ідентифікатор реєстрації.


Тіло запиту

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


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

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 розмітку чека та інформацію про результат виконання. Приклад структури відповіді:

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


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

PropertyData typeDescription
ReceiptMarkupstringHTML розмітка чека для друку
ReturnInfoоб'єкт ReturnInfoІнформація про результат виконання

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

GetOrderHistory()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації.
organisationIdint
ID організації.
orderGuidGuid
Унікальний ідентифікатор реєстрації.


Тіло запиту

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

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


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

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

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

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

PropertyData typeDescription
OrderNamestringНазва реєстрації
StatusIdintІдентифікатор статусу реєстрації
StatusDescriptionstringОпис статусу реєстрації
SetJobTimedatetimeДата і час реєстрації
CallTimedatetimeДата і час виклику клієнта
BeginTimedatetimeДата і час початку обслуговування
CompleteTimedatetimeДата і час завершення обслуговування
EventTimedatetimeДата і час події
CustomerEventIdintІдентифікатор події
CustomerEventDescriptionstringОпис події
ServiceNamestringНазва послуги
WorkPlaceDescriptionstringОпис робочого місця
EmployeeNamestringІм'я співробітника
ToServiceNamestringНазва нової послуги у випадку зміни
ToWorkplaceDescriptionstringОпис робочого місця, на яке перенаправляється клієнт
ToEmployeeNamestringІм'я співробітника, до якого перенаправляється клієнт
ReturnInfoоб'єкт ReturnInfoІнформація про результат виконання

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

DropOrder()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації
organisationIdint
ID організації.
orderGuidGuid
Унікальний ідентифікатор реєстрації, яку потрібно видалити.


Тіло запиту

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


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

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


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

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

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


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

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

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

GetActivatedOrderInfo()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації.
organisationIdint
ID організації.
serviceCenterIdint
ID сервісного центру.
orderGuidGuid
Унікальний ідентифікатор реєстрації.


Тіло запиту

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


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

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

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

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

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


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

PropertyData typeDescription
EstimateTimedatetimeЧас, що залишився до виклику
CustomersPerWorkplaceintКількість клієнтів на робоче місце
WorkplaceCountintКількість активних робочих місць
WorkplaceListstringПерелік робочих місць, розділений комами
ReturnInfoоб'єкт ReturnInfoІнформація про результат виконання

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

SetAssessment()

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

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

Метод

'POST'

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

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

ПараметрТип данихОбов'язковістьОпис
authTokenGuid
Токен авторизації.
organisationIdint
ID організації.
orderGuidGuid
Унікальний ідентифікатор реєстрації.
assessmentint
Оцінка якості наданої послуги.


Тіло запиту

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


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

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


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

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

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


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

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

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

GetOrganisationInfo()

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

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

Метод

'POST'

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

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

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

Тіло запиту

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


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

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


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

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

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


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

PropertyData typeDescription
BranchIdintІдентифікатор гілки
BranchNamestringНазва гілки
ServiceCenterIdintІдентифікатор сервісного центру
ServiceCenterNamestringНазва сервісного центру
LocationIdintІдентифікатор локації
LocationNamestringНазва локації
ExecutedJobsCountintКількість завершених реєстрацій
DeletedJobsCountintКількість видалених реєстрацій
WaitJobsCountintКількість очікуючих реєстрацій
WaitJobsCountOtherintКількість очікуючих реєстрацій (інші)
WaitJobsCountSMSintКількість очікуючих реєстрацій (SMS)
WorkplacesInWorkintКількість активних робочих місць
WorkplacesOutOfWorkintКількість неактивних робочих місць
AvgWaitTimeintСередній час очікування (в секундах)
AvgProcTimeintСередній час обробки (в секундах)
WorkplacesInWorkOtherintКількість активних робочих місць (інші)
WorkplacesInWorkSMSintКількість активних робочих місць (SMS)
IsActiveintПризнак активності сервісного центру (1 – активний)
CustTotalintЗагальна кількість клієнтів
ExtCenterIdintВнешній ID сервісного центру
ReturnInfoоб'єкт ReturnInfoІнформація про результат виконання

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

GetServiceCentersSettings()

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

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


Метод

'POST'

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

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

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


Тіло запиту

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


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

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


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

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


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

PropertyData typeDescription
ServiceCenterIdintID сервісного центру.
ServiceCenterGuidGuidУнікальний ідентифікатор сервісного центру.
SopdatetimeДата, з якої дозволена попередня реєстрація.
PQLimitDaysintКількість днів, протягом яких дозволена попередня реєстрація.
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання.

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

ReturnInfo

Об'єкт ReturnInfo надає інформацію про результат виконання запиту. Залежно від результату виконання запиту, об'єкт ReturnInfo може містити різні коди помилок та повідомлення.

Поля об'єкту ReturnInfo

  • ReturnCode (int): Код помилки.
  • ReturnSubcode (int): Код помилки сервера черги.
  • ReturnMessage (string): Повідомлення про результат виконання.

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

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

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

Помилка ServiceHub

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

Помилка на стороні сервера черги

{
    "ReturnInfo": {
        "ReturnCode": 2101,
        "ReturnSubcode": 70001,
        "ReturnMessage": "SQL server message"
    }
}

Коди помилок  ServiceHub

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


  • No labels