追加フォーマット

Version 22.0.8500


追加フォーマット


デフォルトですべてのリソースおよびアクションがサポートするJSON 形式に加えて、API は次の形式をサポートします:XML、JSONP、SOAP、RSS、HTML、CSV、およびTSV。

XML

$format=atom クエリパラメータを追加するか、もしくはリクエストにapplication/xml という値を持つHTTP Accept ヘッダーを追加することで、XML (OData・Atom)形式をリクエストできます。次のリクエストとレスポンスの例を見てください。

Request

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

Response

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xml:base="http://MyServer:MyPort/api.rsc/"
      xmlns:m="http://docs.oasis-open.org/odata/ns/metadata" xmlns:info="http://www.rssbus.com/ns?RsbOps/v2/"
      xmlns:d="http://docs.oasis-open.org/odata/ns/data">
  <title type="text">Cars</title>
  <id>http://MyServer:MyPort/api.rsc/Cars/</id>
  <updated>2015-04-23T18:36:20-04:00</updated>
  <entry>
  <title>1000</title><id>http://MyServer:MyPort/api.rsc/Cars('1000')</id>
  <category term="CData.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 の結果をラップする関数の名前です。次のリクエストとレスポンスの例を見てください。

Request

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

Response

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

RSS

リクエストに@rss クエリパラメータを加えることによって、RSS 形式をリクエストすることができます。次のリクエストとレスポンスの例を見てください。

Request

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

Response

<rss xmlns:rsb="http://www.rssbus.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://www.rssbus.com/ns?RsbOps/v2/anonymous/"
     xmlns:odata="http://www.rssbus.com/ns?RsbOps/v2/anonymous/" xmlns:info="http://www.rssbus.com/ns?RsbOps/v2/anonymous/"
     xmlns:data="http://www.rssbus.com/ns?RsbOps/v2/anonymous/" version="2.0">
  <channel>
    <description>Retrieves and updates Cars information</description>
    <generator>RSSBus - http://www.rssbus.com</generator>
    <link>http://MyServer:MyPort/api.rsc/Cars?@html</link>
    <title>Cars</title>
    <item xmlns:x="http://www.rssbus.com/ns?RsbOps/v2/anonymous/">
      <x:Id>1000</x:Id>
      <x:Model>Accord</x:Model>
    </item>
  </channel>
</rss>

HTML

リクエストに@html クエリパラメータを加えることによって、API レスポンスをシンプルでスタイルなしのHTML テーブル形式にすることができます。次のリクエストとレスポンスの例を見てください。

Request

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

Response

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

CSV/TSV

リクエストに@csv または@tsv クエリパラメータを加えることによって、API レスポンスをCSV またはTSV 形式にすることができます。次のリクエストとレスポンスの例を見てください。

Request

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

Response

Id,Model
1000,Accord