获取数据
Get data 获取数据
DataTable 允许通过HTTP POST访问数据表格中数据
请求
| 元素/属性 | 类型 | 描述 |
|---|---|---|
| ApiKey | string | 你的 API key, 用于身份验证. 必填. |
| TableName | string | 指定数据表格名称. 选填. |
| Columns | complex | 需要指定的列 (Column元素). 选填. |
| WhereConditions | complex | 需要指定的位置 (Where元素). 选填. |
| OrderByColumns | complex | 需要指定的排列顺序 (OrderBy元素). 选填. |
| Limit | int | 所取回数据表格中行数目的限制. 选填. |
Columns子元素:
| 元素/属性 | 类型 | 描述 |
|---|---|---|
| Column | string | 列名称. 必填. |
Where子元素:
| 元素/属性 | 类型 | 描述 |
|---|---|---|
| ColumnName | string | 列名称. 必填. |
| Operator | string | 运算值名称. 有效值为:
必填. |
| Value | string | 检索运算对比的值. 必填. |
OrderBy子元素:
| 元素/属性 | 类型 | 描述 |
|---|---|---|
| ColumnName | string | 列名称. 必填. |
| Direction | string | 排列方式. 有效值为:
必填. |
应答
这种接口与其他接口不同的是返回的数据是以CSV格式，而不是XML。这是因为这些数据的数量通常会更大一些。CSV会减少管理成本，而且一般来说会更容易解析及操作。
应答内容类型应为“text/csv”。返回的数据包括具有各列名称的表头。输出的CSV格式将遵循以下设置：
- Field separator字段分隔符: comma逗号 (,)
- Quoting character引用符: (“)
- Escape character换码符: (“)
- Encoding: 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>test_api_key1</ApiKey>
<TableName>Table1</TableName>
<Columns>
<Column>Column1</Column>
<Column>Column5</Column>
</Columns>
<WhereConditions>
<Where>
<ColumnName>Column1</ColumnName>
<Operator>Equals</Operator>
<Value>test</Value>
</Where>
</WhereConditions>
<OrderByColumns>
<OrderBy>
<ColumnName>Column1</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 Column1,Column5 |