TextDecoder POST GET

Метод позволяет определить кодировку текста и преобразовывать текст из одной кодировки в другую.


Запросы следует отправлять на адрес:

Поддерживаются запросы методом GET и POST.

По умолчанию ответ сервера будет в формате JSON. Для получения ответа в другом формате, можно добавить расширение к файлу в адресе: .xml, .html или .txt. Например: /v2/TextDecoder.xml Либо использовать HTTP-заголовок Accept: text/xml, text/html или text/plain.


Параметры

Имя параметра Тип Обязательный По умолчанию Описание
text String Да NULL Текст, который необходимо обработать.
from String Нет NULL Название или код исходной кодовой страницы.
to String Нет windows-1251, iso-8859-1, koi8-r, utf-8, gb2312, ibm855, cp866, x-mac-cyrillic, ibm880, koi8-u, iso-8859-5 Название или код целевой кодовой страницы, в которую следует преобразовать текст.
detection Boolean Нет False Указывает на необходимость автоматического определения кодировки текста.
Общие параметры

В таблице ниже представлен список параметров, которые могут быть использованы при запросе к любому методу API.

Имя параметра Тип Обязательный По умолчанию Описание
appId Int32 Нет NULL Идентификатор приложения.
appSecret String Условно NULL Секретный ключ приложения.
token String Нет NULL Маркер доступа клиента, полученный методом GetToken.
formatting ResponseFormatting Нет None Определяет параметры форматирования выдачи результатов.
details Boolean Нет False Позволяет отобразить дополнительную информацию о запросе.
cp String Нет UTF-8 Имя кодовой страницы.
lang Language Нет Auto Язык, на котором будут выдаваться системные сообщения. Этот параметр также можно использовать при работе со справочной информацией API.
auth Boolean Нет False При наличии этого параметра, сервер вернет ответ с кодом HTTP401 и потребует указание идентификатора приложения и секретного ключа в HTTP заголовке Authorization.

Результат

Возвращает результат типа TextDecoderResult.

Имя свойства Тип Описание
Исходное XML JSON
Value value value String Текст, полученный в результате преобразования text из from в to.
Items items items TextDecoderResultItem[] Небольшие фрагменты текста в различных кодировках (для ручного поиска и выбора нужной комбинации кодовых страниц).
Messages messages messages Message[] Список сообщений системы.
Trace trace trace TraceItem[] Детальная информация о выполнении запроса. Добавляется, если параметр details имеет значение True.

Имя XML и JSON используется при выдаче результатов в XML и, соответственно, JSON.

Если имя XML начинается с символа «собака» (@), то значит в XML это имя будет использоваться в качестве имени атрибута, а не самостоятельного элемента.

Исходное имя - это имя, которое используется непосредственно в коде API.


Ошибки

При возникновении ошибок, будет возвращаен результат типа ErrorResult.

В таблице ниже представлен список ошибок, которые могут возникнуть при работе с методом TextDecoder.

Ключ Код Описание
ArgumentNullOrEmpty 2001 Ошибка происходит, если один из обязательных параметров не указан или имеет пустое значение.

Ключ и код соответствуют элементам перчисления ErrorCode.

В некоторых случаях, в ответе сервера могут содержать предупреждения (Warning) и сообщения о проблемах (Critical), которые можно найти в коллекции Messages. При этом, ответ сервера будет иметь тип TextDecoderResult.

Если метод содержит сообщения типа Critical, то можно считать, что работа метода завершена с ошибкой. Подобное поведение свойствено методам, в которых производится обработка списка данных, где каждый элемент списка является независимым от других элментов. Т.е. в таких случаях запрос может быть выполнен частично.


Примечания

Если кодовая страница не указана, то будет возвращен список фрагментов входящего текста для различных комбинаций кодовых страниц.

В параметрах from и to допустимо указывать несколько вариантов кодовых страниц через запятую. При этом, будет возвращен список фрагментов текста для различных комбинаций указанных кодовых страниц.

Чтобы получить весь конвертированный текст из одной кодовой страницы в другую, следует точно указать кодовые страницы в параметрах from и to, но не более одной кодовой страницы. Например: from=windows-1251&to=utf-8.

Если параметр detection имеет значение True, то будет предпринята попытка определения исходной кодовой страницы. Если в результате будет найден всего один вариант, то метод выполнит конвертирование текста из обнаруженной кодовой страницы в указанную в параметре to кодовую страницу.

Если параметр from или to имеет значение All, то будет возвращен список фрагментов входящего текста, преобразованного из, и/или во все существующие кодовые страницы.


Статистика


Конструктор запросов

text:
from:
to:
detection:

http:
lang:
auth:
cp: