|
|
| Строка 1: |
Строка 1: |
| − | Запрос возвращает список документов рубрики. | + | Запрос обновляет список тегов для документа. |
| − | Адрес запроса: http://service.iqbuzz.ru/actions/api/documentList
| + | Необходимо отправлять полный список тегов документа. Теги, уже прикреплённые к документу, но не указанные в списке тегов в запросе, будут откреплены от документа. |
| − | Запрос необходимо отправлять '''POST''' методом. | + | Запрос можно отправлять '''GET''' или '''POST''' методом. |
| − | Дополнительный параметр для получения списка документов:
| |
| − | '''reqStr''' – XML представление объекта, для организации постраничной навигации. | |
| | | | |
| − | Формат значения параметра:
| + | Адрес запроса: http://service.iqbuzz.ru/actions/api/updateTags |
| | | | |
| − | <pagedList>
| |
| − | <page>'''PAGE_NUMBER'''</page>
| |
| − | <perPage>'''DOC_PER_PAGE'''</perPage>
| |
| − | <filter>
| |
| − | <name>RUBRICID</name>
| |
| − | <type>RUBRICID</type>
| |
| − | <values>
| |
| − | <long>'''RUBRIC_ID'''</long>
| |
| − | </values>
| |
| − | </filter>
| |
| − | <filter>
| |
| − | <name>SENTIMENT</name>
| |
| − | <type>SENTIMENT</type>
| |
| − | <values>
| |
| − | <string'''>SENTIMENT_VALUE'''</string>
| |
| − | </values>
| |
| − | </filter>
| |
| − | <filter>
| |
| − | <name>TAGID</name>
| |
| − | <type>TAGID</type>
| |
| − | <values>
| |
| − | <string>'''TAG_ID'''</string>
| |
| − | </values>
| |
| − | </filter>
| |
| − | <filter>
| |
| − | <name>DOCID</name>
| |
| − | <type>DOCID</type>
| |
| − | <values>
| |
| − | <long>DOC_ID_1</long>
| |
| − | <long>DOC_ID_2</long>
| |
| − | </values>
| |
| − | </filter>
| |
| − | <sorting>
| |
| − | <fieldName>SORT_FIELD</fieldName>
| |
| − | <direction>SORT_DIRECTION</direction>
| |
| − | </sorting>
| |
| − | </pagedList>
| |
| | | | |
| − | '''PAGE_NUMBER''' – номер страницы, начинается с 0.
| + | Дополнительные параметры: |
| | | | |
| − | '''DOC_PER_PAGE''' – количество документов, которые надо отобразить | + | '''docId''' – идентификатор документа |
| | | | |
| − | '''RUBRIC_ID''' – идентификатор рубрики, для которой надо отобразить список документов | + | '''rubricId''' – идентификатор рубрики |
| | | | |
| − | '''SENTIMENT_VALUE''' – значение тональности документов, которые надо отобразить. Может принимать значения: POSITIVE(позитивные), NEGATIVE(негативные), MIXED(смешанные), NEUTRAL(нейтральные), ALL(все) – по умолчанию. | + | ''''''tagId[0]''' – идентификатор первого тега |
| | | | |
| − | '''TAG_ID''' – идентификатор тега, по которому надо произвести фильтрацию
| + | tagId[1]''' – идентификатор второго тега и т.д |
| | | | |
| − | '''DOC_ID''' – фильтр по заданным идентификаторам документов | + | ''' |
| − | | + | Результат:''' |
| − | '''SORT_FIELD''' – название поля для сортировки. Может принимать значение DOCDATE (дата документа), INSERTIONDATE (дата индексации системой IQBuzz)
| + | 1 – успешное выполнение операции |
| − | | |
| − | '''SORT_DIRECTION''' – ASC (по возрастанию, новые документы в конце), DESC (по убыванию, новые документы вначале)
| |
| − | | |
| − | | |
| − | Жирным шрифтом выделены обязательные для запроса параметры.
| |
| − | | |
| − | При отправке запроса количество узлов <filter> может варьироваться, по необходимости. Фильтр TAGID может содержать несколько элементов <string>TAG_ID</string>, для фильтрации по нескольким тегам.
| |
| − | | |
| − | Формат возвращаемого списка:
| |
| − | | |
| − | <searchResult>
| |
| − | <totalCount>ОБЩЕЕ КОЛИЧЕСТВО ДОКУМЕНТОВ, УДОВЛЕТВОРЯЮЩИХ ФИЛЬТРАМ</totalCount>
| |
| − | <results>
| |
| − | <searchItem>
| |
| − | <document>
| |
| − | <id>ИДЕНТИФИКАТОР ДОКУМЕНТА</id>
| |
| − | <title>РАЗМЕЧЕННОЕ НАЗВАНИЕ ДОКУМЕНТА</title>
| |
| − | <text>РАЗМЕЧЕННЫЙ ТЕКСТ ДОКУМЕНТА</text>
| |
| − | <docDate>ДАТА СОЗДАНИЯ ДОКУМЕНТА(пример: 17-02-2012 10:19:40)</docDate>
| |
| − | <insertionDate>ДАТА ИНДЕКСАЦИИ ДОКУМЕНТА</insertionDate>
| |
| − | <url>URL ДОКУМЕНТА</url>
| |
| − | <doctype>ТИП ДОКУМЕНТА (POST,COMMENT,FORUM,MICROBLOG,VIDEO,NEWS,SOCIALNET)</doctype>
| |
| − | <sentiment>ТОНАЛЬНОСТЬ ДОКУМЕНТА ДЛЯ ВЫБРАННОЙ РУБРИКИ</sentiment>
| |
| − | </document>
| |
| − | <docSource>
| |
| − | <name>ИМЯ БЛОГА</name>
| |
| − | <url>URL БЛОГА</url>
| |
| − | </docSource>
| |
| − | <blogger>
| |
| − | <name>ИМЯ БЛОГГЕРА</name>
| |
| − | <nick>ПСЕВДОНИМ БЛОГГЕРА</nick>
| |
| − | <email>АДРЕС ЭЛЕКТРОННОЙ ПОЧТЫ</email>
| |
| − | <icq>НОМЕР ICQ</icq>
| |
| − | <skype>SKYPE ИДЕНТИФИКАТОР БЛОГГЕРА</skype>
| |
| − | <age>ВОЗРАСТ БЛОГГЕРА</age>
| |
| − | <geo>МЕСТОПОЛОЖЕНИЕ БЛОГГЕРА</geo>
| |
| − | </blogger>
| |
| − | <tags>
| |
| − | <tag>
| |
| − | <id>ИДЕНТИФИКАТОР ТЕГА</id>
| |
| − | <name>НАЗВАНИЕ ТЕГА</name>
| |
| − | </tag>
| |
| − | </tags>
| |
| − | </searchItem>
| |
| − | </results>
| |
| − | </searchResult>
| |
| − | | |
| − | Параметры title и text содержат значения с тегами, которые преобразованы, чтобы не портить XML структуру (“<” = <, “>”=>). Для получения валидного html надо произвести обратное декодирование.
| |
Запрос обновляет список тегов для документа.
Необходимо отправлять полный список тегов документа. Теги, уже прикреплённые к документу, но не указанные в списке тегов в запросе, будут откреплены от документа.
Запрос можно отправлять GET или POST методом.
Адрес запроса: http://service.iqbuzz.ru/actions/api/updateTags
Дополнительные параметры:
docId – идентификатор документа
rubricId – идентификатор рубрики
'tagId[0] – идентификатор первого тега
tagId[1] – идентификатор второго тега и т.д
Результат:
1 – успешное выполнение операции
