Versions Compared

Old Version 3

changes.mady.by.user Svitlana Nimych

Saved on

compared with

New Version 4

changes.mady.by.user Svitlana Nimych

Saved on

Key

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

Встановлює деякі параметри роботи Сервісу.
Доступні наступні параметри:

  • час бездіяльності сервісу, після якого слід запитати у користувача пароль для доступудо ключа
URL-адреса запиту

Устанавливает некоторые параметры работы Сервиса.
Доступны следующие параметры:

  • время бездействия сервиса, после которого следует запросить у пользователя пароль для доступа к ключу

...

https://local.cipher.kiev.ua:9091/api/v1/option

Метод

PUT

Параметры запроса

Отсутствуют

...

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

Відсутні

Налаштовувані заголовки запиту
Content-Typeapplication/json
Параметры JSON объекта запроса
Параметрыи JSON об'єкта запиту
Ім'яИмяТипОписаниеОписДопустимые значенияДопустимыі значення
signatureTypeNumber

Время Час в секундах бездействия сервиса, после которого следует запросить у пользователя пароль для доступа к ключубездіяльності сервісу, після якого слід запитати у користувача пароль для доступу до ключа

300-3600, 901*

* - значение по умолчанию

...

значення за замовчуванням

Відповідь
Код ответавідповідіContent-typeДопустимые параметрыДопустимі параметриПриклад вмістуПример содержимого
200application/json
message
settedOptions : {
    serviceUptime    
} 
{
    "message": "ЗапросЗапиту на установкувстановлення параметровпараметрів сервисасервісу выполненвиконано.",
    "settedOptions": {
       "serviceUptime" : "900"       
    }
}
503application/jsonmessage{
     "message" : "СервисСервіс хранениязберігання данныхданих не запущензапущено."
}
400application/jsonmessage

{

       "message" : "СессияСесія отсутствуетвідсутня."

}

...

Параметри JSON об'єкта відповіді
ПараметрТип данныхданихОписаниеОпис
messageStringОписание результата проведения операцииОпис результату проведення операції
settedOptions
ObjectПараметры и их значения, которые были установлены после выполнения запроса

...

Параметри та їх значення, які були встановлені після виконання запиту
Приклад коду на JavaScript + jQuery 2.2.4
Code Block
languagejs
var appOptions = {
    signatureType: 900
};
$.ajax({
    url: "https://local.cipher.kiev.ua:9091/api/v1/option",
    type: "PUT",
    dataType: "json",
    contentType: "application/json",
    data: JSON.stringify(appOptions)
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
    settedOptions = jsonResponse.settedOptions;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
    } catch (e) {
        message = (xhr.responseText == undefined) ? "ОшибкаПомилка при установкевстановленні параметровпараметрів сервисасервісу." : xhr.responseText;
    }
})