Контроль стану сервера

Запит служить для отримання стану Сервісу. Запит повертає код відповіді 200, якщо після запуску застосування користувач здійснює вхід із застосування особистого ключа чи обрав режим роботи "Без ключів".

URL-адреса запиту

https://localhost:9094/api/v1/status

Метод

GET

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

Відсутні

Налаштовувані заголовки запиту

Відсутні

Відповідь

Код відповіді	Content-type	Допустимі параметри	Приклад вмісту
200	application/json	message	{ "message" : "Сервіси знаходяться у працездатному стані." }
503	application/json	message	{ "message" : "Сервіс зберігання даних не запущено." }

Параметри JSON обʼєкта відповіді

Параметр	Тип даних	Опис
message	String	Опис результату проведення операції

Приклад коду на JavaScript + jQuery 2.2.4

$.ajax({
    url: "https://localhost:9094/api/v1/status",
    type: "GET",
    dataType: "json",
    cache: false
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
    } catch (e) {
        message = (xhr.responseText == undefined) ? "Помилка при отриманні стану сервісу." : xhr.responseText;
    }
})

Page tree