回数券一覧
「駅すぱあと」の保持する回数券の一覧を取得します。
GET /v1/{format}/coupon/list
parameters
※ Requiredの「△」は、特定の条件においてそのパラメータが必須になることを示します。詳しくはパラメータのDescriptionを参照してください。
Name | Type | Required | Description |
---|---|---|---|
format | string | ◯ | レスポンスのデータ形式の指定。必須 指定できる値: - xml: xml形式のデータ - json: json形式のデータ ※クエリパラメータではなくパスに値を指定します。 |
key | string | ◯ | アクセスキー 。必須 |
name | string | --- | 回数券名称。省略可。省略時は全ての回数券を対象とします。 Example: 新幹線 |
response
Name | Description |
---|---|
ResultSet | レスポンスの最下部を表す要素 |
ResultSet / apiVersion | WebAPIバージョン |
ResultSet / engineVersion | エンジンバージョン |
ResultSet / Coupon | 回数券を表す要素 |
ResultSet / Coupon / index | インデックス ※ jsonデータ形式のレスポンスにインデックスは含まれません。JSON形式のレスポンスデータを利用する際の注意事項 |
ResultSet / Coupon / Name | 回数券の名称を表す要素 |
example
GET /v1/xml/coupon/list?key=アクセスキーを入力してください
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.27.0.0" engineVersion="202210_01a">
<Coupon index="1">
<Name>新幹線回数券(グリーン車)</Name>
</Coupon>
<Coupon index="2">
<Name>新幹線回数券(指定席)</Name>
</Coupon>
<Coupon index="3">
<Name>新幹線回数券(自由席)</Name>
</Coupon>
<Coupon>
:
</Coupon>
</ResultSet>
GET /v1/json/coupon/list?key=アクセスキーを入力してください
{
"ResultSet": {
"apiVersion": "1.27.0.0",
"engineVersion": "202210_01a",
"Coupon": [
{
"Name": "新幹線回数券(グリーン車)"
},
{
"Name": "新幹線回数券(指定席)"
},
{
"Name": "新幹線回数券(自由席)"
},
{
:
}
]
}
}