回数券詳細

「駅すぱあと」の保持する回数券の詳細な情報を取得します。 回数券一覧で取得した回数券の名称ResultSet / Coupon / Nameを指定すると、回数券の詳細を取得できます。 経路シリアライズデータを指定すると、その経路で利用可能な回数券の詳細を取得できます。

GET /v1/{format}/coupon/detail

parameters

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

response

Name Description
ResultSet レスポンスの最下部を表す要素
ResultSet / apiVersion WebAPIバージョン
ResultSet / engineVersion エンジンバージョン
ResultSet / Coupon 回数券を表す要素
ResultSet / Coupon / index インデックス
※ jsonデータ形式のレスポンスにインデックスは含まれません。jsonにおけるindexの扱い
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=新幹線回数券(指定席)
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201404_01a">
  <Coupon index="1">
    <Name>新幹線回数券(指定席):東京都区内:静岡</Name>
    <Detail>
      <Count>6</Count>
      <ValidPeriod>3</ValidPeriod>
      <Direction>Both</Direction>
      <Price>
        <Amount>36900</Amount>
      </Price>
    </Detail>
  </Coupon>
  <Coupon index="2">
    <Name>新幹線回数券(指定席):東京都区内:浜松</Name>
    <Detail>
      <Count>6</Count>
      <ValidPeriod>3</ValidPeriod>
      <Direction>Both</Direction>
      <Price>
        <Amount>48540</Amount>
      </Price>
    </Detail>
  </Coupon>
  <Coupon index="3">
    <Name>新幹線回数券(指定席):東京都区内:名古屋市内</Name>
    <Detail>
      <Count>6</Count>
      <ValidPeriod>3</ValidPeriod>
      <Direction>Both</Direction>
      <Price>
        <Amount>62160</Amount>
      </Price>
    </Detail>
  </Coupon>
  <Coupon index="4">
    <Name>新幹線回数券(指定席):東京都区内:米原</Name>
    <Detail>
      <Count>6</Count>
      <ValidPeriod>3</ValidPeriod>
      <Direction>Both</Direction>
      <Price>
        <Amount>68580</Amount>
      </Price>
    </Detail>
  </Coupon>
  <Coupon index="5">
    <Name>新幹線回数券(指定席):東京都区内:京都市内</Name>
    <Detail>
      <Count>6</Count>
      <ValidPeriod>3</ValidPeriod>
      <Direction>Both</Direction>
      <Price>
        <Amount>78420</Amount>
      </Price>
    </Detail>
  </Coupon>
  <Coupon>
  :
  </Coupon>
</ResultSet>
GET /v1/json/coupon/detail?key=アクセスキーを入力してください&name=新幹線回数券(指定席)
{
  "ResultSet": {
    "apiVersion": "1.14.0.0",
    "engineVersion": "201404_01a",
    "Coupon": [
      {
        "Name": "新幹線回数券(指定席):東京都区内:静岡",
        "Detail": {
          "Count": "6",
          "ValidPeriod": "3",
          "Direction": "Both",
          "Price": {
            "Amount": "36900"
          }
        }
      },
      {
        "Name": "新幹線回数券(指定席):東京都区内:浜松",
        "Detail": {
          "Count": "6",
          "ValidPeriod": "3",
          "Direction": "Both",
          "Price": {
            "Amount": "48540"
          }
        }
      },
      {
        "Name": "新幹線回数券(指定席):東京都区内:名古屋市内",
        "Detail": {
          "Count": "6",
          "ValidPeriod": "3",
          "Direction": "Both",
          "Price": {
            "Amount": "62160"
          }
        }
      },
      {
        "Name": "新幹線回数券(指定席):東京都区内:米原",
        "Detail": {
          "Count": "6",
          "ValidPeriod": "3",
          "Direction": "Both",
          "Price": {
            "Amount": "68580"
          }
        }
      },
      {
        "Name": "新幹線回数券(指定席):東京都区内:京都市内",
        "Detail": {
          "Count": "6",
          "ValidPeriod": "3",
          "Direction": "Both",
          "Price": {
            "Amount": "78420"
          }
        }
      },
      {
        :
      }
    ]
  }
}