Versions Compared

Old Version 32

changes.mady.by.user Danylo Kalchenko

Saved on

compared with

New Version 33

changes.mady.by.user Danylo Kalchenko

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleGetServiceCentersSettings()

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

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

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


Метод

'POST'

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

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

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

Тіло запиту

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


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

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


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

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


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

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

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

...

Expand
titleОписание объекта ReturnInfo

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

Поля объекта ReturnInfo

  • ReturnCode (int): Код ошибки.
  • ReturnSubcode (int): Код ошибки сервера очереди.
  • ReturnMessage (string): Сообщение о результате выполнения.

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

Успешное выполнение

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

Ошибка ServiceHub

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

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

Code Block
{
    "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Сообщение от сервера очереди

...