Hex POST GET

Производит кодирование и декодирование данных в/из шестнадцатеричного формата.


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

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

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


Параметры

Имя параметра Тип Обязательный По умолчанию Описание
mode DataMode Нет Auto Тип выполняемой операции.
text String Условно NULL Текст, который необходимо обработать.
file File Условно NULL Файл, который необходимо обработать.
url String Условно NULL Адрес, который необходимо обработать.
pattern String Нет b Шаблон кодирования данных в шестнадцатеричный формат.
numeric Boolean Нет False Указывает, что обрабатываемое значение следует интерпретировать как число.
hexOnly Boolean Нет False Указывает, что при декодировании следует оставить только обработанные значения.
return OutputFormat Нет Text Формат, в котором следует вернуть результат работы.
Общие параметры

В таблице ниже представлен список параметров, которые могут быть использованы при запросе к любому методу 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.

Результат

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

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

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

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

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


Ошибки

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

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

Ключ Код Описание
AddressIsBlacklisted 1121 Ошибка происходит, когда в параметре URL указан адрес, который находится в чёрном списке.
ArgumentNullOrEmpty 2001 Ошибка происходит, если один из обязательных параметров не указан или имеет пустое значение.
InvalidCast 3004 Ошибка возникает, когда указанный формат данных не может быть преобразован в другой формат.
UnableToProcessData 1003 Ошибка возникает, когда система не может обработать указанный тип данных.

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

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

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


Примечания

Параметр pattern используйтся только при кодировании данных.

В параметре pattern поддерживаются следующие управляющие символы:

  • i - индекс байта;
  • b - байт в шестндацатеричном формате;
  • bb - массив байт в шестндацатеричном формате.

Все остальные символы, указанные в шаблоне, останутся без изменений.

Для экранирования используется обратный слеш. Напримар: Байт: b; Буква: \b.

Управляющие символы чувствительны к регистру.

Параметр hexOnly используется только при декодировании. Если значение этого параметра True, то все символы, не являющиеся шестнадцатеричными будут удалены из результатов выполнения запроса. Например, при декодировании строки: CF F0 E8 E2 E5 F2 2C 20 F7 E5 EB EE E2 E5 EA E8 21, будут удалены все лишние пробелы и на выходе получится строка: «Привет, человеки!». А если значение параметра hexOnly будет False, то на выходе получится: «П р и в е т , ч е л о в е к и !».

Если параметр numeric имеет значение True, то будет считаться, что производится операция над числовым значением. Например, если преобразовать число 65 535 в шестнадцатеричный формат, как число, то будет значение: FFFF. Если же преобразовать значение 65535 как строку, то на выходе будет: 36 35 35 33 35.

При обработке текстовых данных используется кодовая страница, указанная в параметре cp.


Статистика


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

mode:
text:
file:
url:
pattern:
numeric:
hexOnly:
return:

http:
lang:
auth:
cp: