Запрос на обновление тегов для документа: различия между версиями
Admin (обсуждение | вклад) |
Admin (обсуждение | вклад) |
||
(не показаны 2 промежуточные версии этого же участника) | |||
Строка 1: | Строка 1: | ||
− | Запрос | + | Запрос возвращает список документов рубрики. |
− | + | Адрес запроса: http://service.iqbuzz.ru/actions/api/documentList | |
− | Запрос | + | Запрос необходимо отправлять '''POST''' методом. |
+ | Дополнительный параметр для получения списка документов: | ||
+ | '''reqStr''' – XML представление объекта, для организации постраничной навигации. | ||
− | + | Формат значения параметра: | |
− | + | <code> | |
+ | <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> | ||
+ | </code> | ||
− | ''' | + | '''PAGE_NUMBER''' – номер страницы, начинается с 0. |
− | ''' | + | '''DOC_PER_PAGE''' – количество документов, которые надо отобразить |
− | ''' | + | '''RUBRIC_ID''' – идентификатор рубрики, для которой надо отобразить список документов |
− | ''' | + | '''SENTIMENT_VALUE''' – значение тональности документов, которые надо отобразить. Может принимать значения: POSITIVE(позитивные), NEGATIVE(негативные), MIXED(смешанные), NEUTRAL(нейтральные), ALL(все) – по умолчанию. |
− | ''' | + | '''TAG_ID''' – идентификатор тега, по которому надо произвести фильтрацию |
− | + | ||
+ | '''DOC_ID''' – фильтр по заданным идентификаторам документов | ||
+ | |||
+ | '''SORT_FIELD''' – название поля для сортировки. Может принимать значение DOCDATE (дата документа), INSERTIONDATE (дата индексации системой IQBuzz) | ||
+ | |||
+ | '''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 надо произвести обратное декодирование. |
Текущая версия на 13:57, 21 апреля 2015
Запрос возвращает список документов рубрики. Адрес запроса: http://service.iqbuzz.ru/actions/api/documentList Запрос необходимо отправлять POST методом. Дополнительный параметр для получения списка документов: reqStr – XML представление объекта, для организации постраничной навигации.
Формат значения параметра:
<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 – количество документов, которые надо отобразить
RUBRIC_ID – идентификатор рубрики, для которой надо отобразить список документов
SENTIMENT_VALUE – значение тональности документов, которые надо отобразить. Может принимать значения: POSITIVE(позитивные), NEGATIVE(негативные), MIXED(смешанные), NEUTRAL(нейтральные), ALL(все) – по умолчанию.
TAG_ID – идентификатор тега, по которому надо произвести фильтрацию
DOC_ID – фильтр по заданным идентификаторам документов
SORT_FIELD – название поля для сортировки. Может принимать значение DOCDATE (дата документа), INSERTIONDATE (дата индексации системой IQBuzz)
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 надо произвести обратное декодирование.