Перейти к содержанию

Источники

Список источников

{
  "action" : "origin.list" 

-- параметры фильтрации, все параметры необязательны
--
-- если выбрана последняя порция списка, то ответ содержит "last_page" : 1
--
-- доступны поля
--
-- origin.id            -- "идентификатор источника" 
-- origin.name          -- "название источника" 
-- origin.label         -- "метка источника" 
-- origin.status        -- "активность источника" 
-- origin.type          -- "тип источника": "site" | "internal" | "external | other" 
-- origin.create.date   -- "дата создания" (Ys)
-- origin.update.date   -- "дата изменения" (Ys)
-- origin.reltype       -- "число, ограничивает список только источниками с указанным reltype" 
-- origin.relref        -- "число, ограничивает список только источниками с указанным relref" 
--

 ,"filter" : [ фильтр в синтаксисе stat.uni ]
 ,"order" : [ сортировка ответа в синтаксисе stat.uni ]
 ,"skip" : количество пропускаемых записей от начала списка -- по умолчанию 0
 ,"first" : количество выбираемых записей после skip -- по умолчанию 50, не более 50

}

ответ

{
  <общие поля>

 ,"list" : [
    {
      "id" : "идентификатор источника" 
     ,"name" : "имя источника" 
     ,"status" : "активность источника" 
     ,"label" : "метка источника" 
     ,"type" : "тип источника" 
     ,"relref" : "пользовательская метка" 
     ,"reltype" : "пользовательская метка" 
     ,"create.date" : "дата создания" (Ys)
     ,"update.date" : "дата изменения" (Ys)
    }

    ...
  ]
}

Чтение источника

{
  "action" : "origin.get" 

 ,"id" : "идентификатор источника" 
}

ответ

{
  <общие поля>

  "obj" : {
    "id" : "идентификатор источника" 
   ,"name" : "имя источника" 
   ,"label" : "метка источника" 
   ,"type" : "тип источника" 
   ,"status" : "активность источника" 
   ,"create.date" : "дата создания" (Ys)
   ,"update.date" : "дата изменения" (Ys)
   ,"reltype" : "пользовательская метка" 
   ,"relref" : "пользовательская метка" 
   }
}

Создание источника

label должно быть уникально для всех источников.

Для создания доступен только тип site.

{
  "action" : "origin.create" 

 ,"name" : "название источника"   -- обязательно (string)

 ,"label" : "метка"               -- обязательно (string)
                                  --
                                  -- если type == site, то или просто имя сайта или урл из которого
                                  -- будет взят и нормализовано имя хоста
                                  --
                                  -- либо label не пусто, если type == internal || type == external || type = other

 ,"type" : "тип источника"  -- не изменяем после создания
                            -- site - сайт
                            -- other - другое
                            -- internal - внутренний
                            -- external - внешний

 ,"status" : "статус источника" -- не обязательно
                                -- 1 - активирован (по умолчанию)
                                -- 0 - заблокирован

 ,"reltype" : параметр классификации -- не обязательно (int)
                                     -- пользовательская метка

 ,"relref" : параметр классификации -- не обязательно (int)
                                    -- пользовательская метка
}

ответ

{
  <общие поля>

  ,"id" : "идентификатор источника" 
}

Изменение источника

Обновляются только указанные в запросе поля.

Обновить можно только источник с типом site.

Параметр type не изменяем.

{
  "action" : "origin.set" 

 ,"id" : "идентификатор источника" 
 ,"obj" : {
   ,"name" : "имя источника" 
   ,"label" : "метка источника" 
   ,"type" : "тип источника" 
   ,"status" : "активность источника" 
   ,"reltype" : "общая группа источников" 
   ,"relref" : "пользовательская метка" 
  }

  -- не обязательно
 ,"return_fresh_obj" : 0|1
}

ответ

{
  <общие поля>
}

Удаление источника

{
  "action" : "origin.delete" 

 ,"id" : "идентификатор источника" 
}

ответ

{
  <общие поля>
}