Name	Type	Required	Description
format	string	◯	レスポンスのデータ形式の指定。必須指定できる値: - xml: xml形式のデータ - json: json形式のデータ ※クエリパラメータではなくパスに値を指定します。
key	string	◯	アクセスキー。必須
name	string	△	回数券名称。serializeDataと排他。serializeData無指定時必須。 Example: `新幹線回数券(自由席)`
serializeData	string	△	経路シリアライズデータ。nameと排他。name無指定時必須)。
checkEngineVersion	string	---	完全な経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。指定できる値: - true: チェックする - false: チェックしない Default: true

response

Name	Description
ResultSet	レスポンスの最下部を表す要素
ResultSet / apiVersion	WebAPIバージョン
ResultSet / engineVersion	エンジンバージョン
ResultSet / Coupon	回数券を表す要素
ResultSet / Coupon / index	インデックス ※ jsonデータ形式のレスポンスにインデックスは含まれません。JSON形式のレスポンスデータを利用する際の注意事項
ResultSet / Coupon / Detail	回数券の詳細な情報を表す要素
ResultSet / Coupon / Detail / Count	枚数を表す要素
ResultSet / Coupon / Detail / Direction	回数券の設定区間の方向を表す要素 - Both: 両方向で利用可能 - Define: 定義された方向のみ利用可能
ResultSet / Coupon / Detail / Price	金額を表す要素
ResultSet / Coupon / Detail / Price / Amount	合計金額を表す要素
ResultSet / Coupon / Detail / ValidPeriod	有効期限を表す要素単位: month
ResultSet / Coupon / Name	回数券名称に区間の情報を合わせた名称を表す要素

example

GET /v1/xml/coupon/detail?key=アクセスキーを入力してください&name=新幹線回数券(自由席)

<ResultSet apiVersion="1.27.0.0" engineVersion="202210_01a">
  <Coupon index="1">
    <Name>新幹線回数券(自由席):東京:新横浜</Name>
    <Detail>
      <Direction>Both</Direction>
      <ValidPeriod>3</ValidPeriod>
      <Price>
        <Amount>7860</Amount>
      </Price>
      <Count>6</Count>
    </Detail>
  </Coupon>
  <Coupon index="2">
    <Name>新幹線回数券(自由席):東京山手線内:小田原</Name>
    <Detail>
      <Direction>Both</Direction>
      <ValidPeriod>3</ValidPeriod>
      <Price>
        <Amount>16800</Amount>
      </Price>
      <Count>6</Count>
    </Detail>
  </Coupon>
  <Coupon index="3">
    <Name>新幹線回数券(自由席):東京都区内:熱海</Name>
    <Detail>
      <Direction>Both</Direction>
      <ValidPeriod>3</ValidPeriod>
      <Price>
        <Amount>20340</Amount>
      </Price>
      <Count>6</Count>
    </Detail>
  </Coupon>
  :
</ResultSet>

GET /v1/json/coupon/detail?key=アクセスキーを入力してください&name=新幹線回数券(自由席)

{
  "ResultSet": {
    "apiVersion": "1.27.0.0",
    "engineVersion": "202210_01a",
    "Coupon": [
      {
        "Name": "新幹線回数券(自由席):東京:新横浜",
        "Detail": {
          "Direction": "Both",
          "ValidPeriod": "3",
          "Price": {
            "Amount": "7860"
          },
          "Count": "6"
        }
      },
      {
        "Name": "新幹線回数券(自由席):東京山手線内:小田原",
        "Detail": {
          "Direction": "Both",
          "ValidPeriod": "3",
          "Price": {
            "Amount": "16800"
          },
          "Count": "6"
        }
      },
      {
        "Name": "新幹線回数券(自由席):東京都区内:熱海",
        "Detail": {
          "Direction": "Both",
          "ValidPeriod": "3",
          "Price": {
            "Amount": "20340"
          },
          "Count": "6"
        }
      },
      {
        :
      }
    ]
  }
}