其它输出格式

Version 24.3.9111


其它输出格式


除了所有资源和操作支持的默认 JSON 格式外,API 还支持以下格式:XML、JSONP、RSS、HTML、CSV 和 TSV。

XML

通过添加“$format=atom”查询参数或向请求添加值为“application/xml”的 HTTP Accept 消息头来请求 XML (OData Atom) 格式。 请参阅下面的示例请求和响应。

请求

http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/Cars?$format=atom

响应

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xml:base="http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/" xmlns:m="http://docs.oasis-open.org/odata/ns/metadata" xmlns:info="http://..com/ns?RsbOps/v2/" xmlns:d="http://docs.oasis-open.org/odata/ns/data">
  <title type="text">Cars</title>
  <id>http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/Cars/</id>
  <updated>2015-04-23T18:36:20-04:00</updated>
  <entry>
  <title>1000</title><id>http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/Cars('1000')</id>
  <category term=".Cars" scheme="http://docs.oasis-open.org/odata/ns/scheme" />
  <link rel="edit" title="Cars" href="Cars('1000')"/>
  <content type="application/xml">
    <m:properties>
      <d:Id m:type="String">1000</d:Id>
      <d:Model m:type="String">Accord</d:Model>
    </m:properties>
  </content>
  </entry>
</feed>

JSONP

通过添加“$callback=myCallback”查询参数来请求 JSONP 格式,其中“myCallback”是想要包装 JSON 结果的函数的名称。 请参阅下面的示例请求和响应。

请求

http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/Cars?$callback=myCallback

响应

myCallback(
  {
    "@odata.context": "http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/$metadata#Cars",
    "value": [
      {
        "Id": "1000", 
        "Model": "Accord"
      },
      ...
    ]
  }
);

RSS

通过在请求中添加查询参数“@rss”来请求 RSS 格式。 请参阅下面的示例请求和响应。

请求

http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/Cars?@rss

响应

<rss xmlns:="http://..com/ns?RsbOps/v2/" xmlns:ls="http://www.microsoft.com/schemas/rss/core/2005" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:x="http://..com/ns?RsbOps/v2/anonymous/" xmlns:odata="http://..com/ns?RsbOps/v2/anonymous/" xmlns:info="http://..com/ns?RsbOps/v2/anonymous/" xmlns:data="http://..com/ns?RsbOps/v2/anonymous/" version="2.0">
  <channel>
    <description>Retrieves and updates Cars information</description>
    <generator> - http://..com</generator>
    <link>http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/Cars?@html</link>
    <title>Cars</title>
    <item xmlns:x="http://..com/ns?RsbOps/v2/anonymous/">
      <x:Id>1000</x:Id>
      <x:Model>Accord</x:Model>
    </item>
  </channel>
</rss>

HTML

通过将查询参数“@html”添加到请求中,请求将 API 响应格式化为简单的、无样式的 HTML 表。 请参阅下面的示例请求和响应。

请求

http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/Cars?@html

响应

<table>
  <tr><th>Id</th><th>Model</th></tr>
  <tr><td>1000</td><td>Accord</td></tr>

CSV

通过将查询参数“@csv”添加到请求中,请求将 API 响应格式化为 CSV 数据。 请参阅下面的示例请求和响应。

请求

http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/Cars?@csv

响应

Id,Model
1000,Accord

TSV

通过将查询参数“@tsv”添加到请求中,请求将 API 响应格式化为 TSV 数据。 请参阅下面的示例请求和响应。

请求

http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/Cars?@tsv

响应

Id  Model
1000 Accord