Page History

...

Expand

title	GetServiceIdByTypeId()

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

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

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

Метод

'POST'

Тіло запиту

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

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

Code Block

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

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

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

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

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

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

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

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

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

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

...

Expand

title	GetServiceTypesByOrgId()

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

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

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

Метод

'POST'

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

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

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

Тіло запиту

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

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

Code Block

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

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

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

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

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

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

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

...

Expand

title	GetCustomerTypes()

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

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

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

Метод

'POST'

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

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

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

Тіло запиту

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

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

Code Block

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


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

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

Code Block

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


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

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

...

Expand

title	CustomerPreReg()

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

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

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

Метод

'POST'

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

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

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

Тіло запиту

Code Block

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

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

Code Block

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

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

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

Code Block

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

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

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

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

...

Expand

title	BookCustomer()

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

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

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

Метод

'POST'

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

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

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

Тіло запиту

Code Block

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

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

Code Block

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

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

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

Code Block

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

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

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

...

Page tree

Versions Compared

Old Version 36

New Version 37

Key

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

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

Метод

Тіло запиту

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

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

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

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

Метод

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

Тіло запиту

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

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

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

Метод

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

Тіло запиту

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

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

Метод

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

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

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

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

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

Метод

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

Тіло запиту

Page tree

Page History

Versions Compared

Old Version 36

New Version 37

Key

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

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

Метод

Тіло запиту

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

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

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

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

Метод

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

Тіло запиту

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

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

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

Метод

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

Тіло запиту

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

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

Метод

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

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

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

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

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

Метод

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

Тіло запиту

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

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

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

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

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

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

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

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

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

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