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

Compare with Current View Page History

« Previous Version 19 Next »


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

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

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

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

Запити:



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

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

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

Метод

'POST'

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

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

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

 Тіло запиту

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

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

 Опис полів

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

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

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

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

URL

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

Метод

POST

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

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

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

Тіло Запиту 

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

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

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

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

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

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

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

Метод

POST

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

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

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

Тіло запиту

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

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

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

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

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

Метод

POST

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

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

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

Тіло запиту

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

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

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

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

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

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

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

Метод

POST

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

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

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

Тіло запиту

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

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

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

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

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

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

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

Метод

POST

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

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

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

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

Тіло запиту

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


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

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

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

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

Якщо є додаткові питання або потрібна допомога з іншими запитами, дай

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

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

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

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

Метод

POST

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

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

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

Тіло запиту

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

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

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

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

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

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

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

Метод

POST

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

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

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

Тіло запиту

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

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

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

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

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

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

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

Метод

POST

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

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

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

Тіло запиту

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

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

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

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

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

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

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

Метод

POST

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

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

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

Тіло запиту

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


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

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

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен аутентифікації.
  • serviceCenterId (int): Ідентифікатор сервісного центру.
  • serviceTypeId (int[]): Перелік ідентифікаторів типів послуг.
  • from (datetime): Початкова дата.
  • to (datetime): Кінцева дата.
  • languageId (int): Ідентифікатор мови.

Тіло запиту

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


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

ВластивістьТип данихОпис
OrganisationIdintID організації
ServiceCenterIdintID сервісного центру
ServiceIdintID послуги
UniqueServiceIdintУнікальний ID послуги
ServiceNamestringНазва послуги
ServiceTypeIdint[]Перелік ID типів послуг
ReturnInfoоб'єкт ReturnInfoІнформація про результати виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

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

Примітка

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

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

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

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

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

Метод

POST

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

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

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

Тіло запиту

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

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

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

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

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

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

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

Метод

POST

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

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

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

Тіло запиту

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

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

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

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

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

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

Метод

POST

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

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

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

Тіло запиту

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

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

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

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен авторизації.
  • organisationId (int): Ідентифікатор організації.
  • serviceCenterId (int): Ідентифікатор сервісного центру.
  • serviceId (int): Ідентифікатор послуги.
  • startDay (datetime): Початкова дата.
  • stopDay (datetime): Кінцева дата.

Тіло запиту

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


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

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

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен авторизації.
  • organisationId (int): Ідентифікатор організації.
  • serviceCenterId (int): Ідентифікатор сервісного центру.
  • serviceId (int): Ідентифікатор послуги.
  • date (datetime): Дата попередньої реєстрації.

Тіло запиту

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


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

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

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен авторизації.
  • organisationId (int): Ідентифікатор організації.
  • serviceCenterId (int): Ідентифікатор сервісного центру.
  • serviceId (int): Ідентифікатор послуги.
  • startDay (datetime): Початкова дата діапазону днів попередньої реєстрації.
  • stopDay (datetime): Кінцева дата діапазону днів попередньої реєстрації.

Тіло запиту

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


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

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

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен авторизації.
  • organisationId (int): Ідентифікатор організації.
  • serviceCenterId (int): Ідентифікатор сервісного центру.
  • serviceId (int): Ідентифікатор послуги.
  • customerTypeId (int): Ідентифікатор типу клієнта.
  • languageId (int): Ідентифікатор мови.
  • customerName (string): Ім'я клієнта.
  • customerPhone (string): Телефон клієнта.
  • customerEmail (string): Адреса електронної пошти клієнта.
  • customerInfo (string): Додаткова інформація про клієнта.
  • 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"
    }
}


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

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

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

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

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

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

Метод

POST

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

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

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

Тіло запиту

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


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

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

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен авторизації.
  • organisationId (int): Ідентифікатор організації.
  • orderGuid (Guid): Унікальний ідентифікатор підтверджуваної реєстрації.

Тіло запиту

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


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

ВластивістьТип данихОпис
ReturnCodeintКод результату
ReturnSubcodeintПідкод результату
ReturnMessagestringПовідомлення про результат

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен авторизації.
  • organisationId (int): Ідентифікатор організації.
  • serviceCenterId (int): Ідентифікатор сервісного центру.
  • orderGuid (Guid): Унікальний ідентифікатор реєстрації.

Тіло запиту

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


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

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

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен авторизації.
  • organisationId (int): Ідентифікатор організації.
  • orderGuid (Guid): Унікальний ідентифікатор реєстрації.

Тіло запиту

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

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

ВластивістьТип данихОпис
WaypointsмасивСписок подій, пов'язаних з реєстрацією
Waypoints.OrderNamestringНазва реєстрації
Waypoints.StatusIdintІдентифікатор статусу реєстрації
Waypoints.StatusDescriptionstringОпис статусу реєстрації
Waypoints.SetJobTimedatetimeДата і час реєстрації
Waypoints.CallTimedatetimeДата і час виклику клієнта
Waypoints.BeginTimedatetimeДата і час початку обслуговування
Waypoints.CompleteTimedatetimeДата і час завершення обслуговування
Waypoints.EventTimedatetimeДата і час події
Waypoints.CustomerEventIDintІдентифікатор події
Waypoints.CustomerEventDescriptionstringОпис події
Waypoints.ServiceNamestringНазва послуги
Waypoints.WorkPlaceDescriptionstringОпис робочого місця
Waypoints.EmployeeNamestringІм'я співробітника
Waypoints.ToServiceNamestringНазва нової послуги у випадку зміни
Waypoints.ToWorkplaceDescriptionstringОпис робочого місця, на яке перенаправляється клієнт
Waypoints.ToEmployeeNamestringІм'я співробітника, до якого перенаправляється клієнт
ReturnInfoоб'єктІнформація про результат виконання
ReturnInfo.ReturnCodeintКод результату
ReturnInfo.ReturnSubcodeintПідкод результату
ReturnInfo.ReturnMessagestringПовідомлення про результат

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен авторизації.
  • organisationId (int): Ідентифікатор організації.
  • orderGuid (Guid): Унікальний ідентифікатор реєстрації, яку потрібно видалити.

Тіло запиту

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


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

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

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен авторизації.
  • organisationId (int): Ідентифікатор організації.
  • serviceCenterId (int): Ідентифікатор сервісного центру.
  • orderGuid (Guid): Унікальний ідентифікатор реєстрації.

Тіло запиту

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


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

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

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен авторизації.
  • organisationId (int): Ідентифікатор організації.
  • orderGuid (Guid): Унікальний ідентифікатор реєстрації.
  • assessment (int): Оцінка якості наданої послуги. (Може бути ціле число від 1 до 5)

Тіло запиту

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


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

ВластивістьТип данихОпис
ReturnInfoоб'єктІнформація про результат виконання
ReturnInfo.ReturnCodeintКод результату (0 – успішно)
ReturnInfo.ReturnSubcodeintПідкод результату (0 – успішно)
ReturnInfo.ReturnMessagestringПовідомлення про результат (OK)

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

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

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

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

Метод

POST

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

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

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

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

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

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

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

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

Метод

POST

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

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

  • authToken (Guid): Токен авторизації.

Тіло запиту

{
    "authToken": "11111111-abcd-dead-beef-0123456789"
}


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


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



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

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

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


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

ВластивістьТип данихОпис
ApiVersionstringВерсія API
ReturnInfoоб'єктІнформація про результат виконання
ReturnInfo.ReturnCodeintКод результату (0 – успішно)
ReturnInfo.ReturnSubcodeintПідкод результату (0 – успішно)
ReturnInfo.ReturnMessagestringПовідомлення про результат (OK)

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

Объект 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Соответствующий параметр не указан, имеет недопустимое значение или неверный формат
1002Не указан параметр authToken
1003Не указан параметр organisationId
1004Не указан параметр serviceCenterId
1005Не указан параметр orderGuid
1006Не указан параметр customerId
1007Не указан параметр languageId
1008Не указан параметр customerName
1009Не указан параметр customerPhone
1010Не указан параметр customerEmail
1011Не указан параметр customerInfo
1012Не указан параметр regTime
1013Значение параметра regTime имеет неверный формат
1014Переданный токен авторизации не соответствует текущему IP адресу или имени сервера клиента
1015Токен авторизации не активирован
1016Время доступности токена авторизации истекло
1017Организация с указанным ID не найдена
1018Не указан уникальный идентификатор организации
1019Уникальный идентификатор организации имеет неверный формат
1020Организация с указанным GUID не найдена
1021IP адрес или имя сервера клиента изменились с момента последнего входа
1022Ошибка подключения к БД
1023Организация с указанным ID в данный момент недоступна
1024Сервисный центр с указанным ID в данный момент недоступен
1025Интервал между регистрациями слишком мал

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

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

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

Код ошибкиОписание
2100Ошибка при запросе нижележащего сервиса
2101Сообщение от сервера очереди


  • No labels