Zidium

Отключение компонента

Url запроса

АдресВашегоСервисаApi/SetComponentDisable

Запрос
{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "ComponentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "ToDate": "2016-04-30T23:25:43.511Z",
        "Comment": "Comment for disabling"
    }
}

Здесь:

  • Token — раздел с токеном авторизации. В нём:
    • SecretKey (string) — ключ доступа к Api, посмотрите в Личном кабинете в разделе Управление — Ключи доступа к Api
  • ComponentId (guid) — Уникальный Id компонента, который нужно отключить.
  • ToDate (datetime) — Дата и время, до которых нужно отключить компонент. После этого он включится автоматически. Если свойство в запросе не указано, то отключается без срока.
  • Comment (string) — Комментарий к отключению, рекомендуется записать причину.

Ответ
{
    "Data": "",
    "Code": 10
}

В ответе возвращается только код результата.

Если компонента с указанным Id не существует, то Code будет равен 1100.