/v2/Api/DataTablesGetData POST
Для получения коллекции DataTable Используется метод HTTP POST.
Запрос
| Элемент/атрибут | Тип | Описание |
|---|---|---|
| ApiKey | string | API key для аутентификации. Обязательный. |
| TableName | string | Имя таблицы. Обязательный |
| Columns | complex | Коллекция столбцов для выборки(элементы Column). Не обязательный. |
| WhereConditions | complex | Коллекция условий WHERE (элементы Where). Не обязательный. |
| OrderByColumns | complex | Коллекция правил ORDER BY (элементы OrderBy). Не обязательный. |
| Limit | int | Количество строк. Не обязательный |
Элементы тега Column:
| Элемент/атрибут | Тип | Описание |
|---|---|---|
| Column | string | Имя столбца. Обязательный |
Элементы тега Where:
| Элемент/атрибут | Тип | Описание |
|---|---|---|
| ColumnName | string | Имя столбца. Обязательный |
| Operator | string | Имя оператора из коллекции: Equals, Greater, Lower, Like. Обязательный |
| Value | string | Значение для поиска. Обязательный |
Элементы тега OrderBy:
| Элемент/атрибут | Тип | Описание |
|---|---|---|
| ColumnName | string | Имя столбца. Обязательный |
| Direction | string | Имя направления сортировки из коллекции: Ascending, Descending. Обязательный |
Ответ
Ответ возвращается в формате CSV. Content-Type - “text/csv”. Первой строкой идут имена столбцов
Используется следующий CSV формат:
- Разделитель полей: запятая (,)
- Начало записи: (")
- Конец записи: (")
- Кодировка: UTF-8
Примеры:
Запрос:
POST https://api.esv2.com/v2/Api/DataTablesGetData HTTP/1.1 Accept-Encoding: gzip,deflate Content-Type: text/xml User-Agent: Jakarta Commons-HttpClient/3.1 Host: api.esv2.com Content-Length: 563 <ApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <ApiKey>Ваш_API-ключ1</ApiKey> <TableName>Таблица</TableName> <Columns> <Column>Столбец1</Column> <Column>Столбец5</Column> </Columns> <WhereConditions> <Where> <ColumnName>Столбец1</ColumnName> <Operator>Equals</Operator> <Value>test</Value> </Where> </WhereConditions> <OrderByColumns> <OrderBy> <ColumnName>Столбец1</ColumnName> <Direction>Ascending</Direction> </OrderBy> </OrderByColumns> <Limit>50</Limit> </ApiRequest>
Ответ:
HTTP/1.1 200 OK Cache-Control: private Content-Type: text/csv; charset=utf-8 Content-Encoding: gzip Vary: Accept-Encoding Server: Microsoft-IIS/7.5 X-AspNetMvc-Version: 3.0 X-AspNet-Version: 4.0.30319 X-Powered-By: ASP.NET Date: Wed, 23 Jan 2013 12:18:23 GMT Content-Length: 201 Kolumna1,Kolumna5 co jest ziomeksXXX,1/16/2013 5:22:09 PM msg,1/14/2012 12:00:00 AM