定期券の払い戻し計算

払い戻し計算のもととなる定期券の組み合わせを複数取得します。

GET /v1/{format}/course/repayment

parameters

Name Type Description
format string レスポンスのデータ形式の指定。必須。
指定できる値:
- xml: xml形式のデータ
- json: json形式のデータ
key string アクセスキー。必須
serializeData string 経路シリアライズデータ。必須
checkEngineVersion string 完全な経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。
指定できる値:
- true: チェックする
- false: チェックしない
Default: true
startDate int 定期券有効開始日付。省略可。
Format: YYYYMMDD
Default: 現在日付
buyDate int 定期券購入日付。省略可。
Format: YYYYMMDD
Default: 有効開始日付と同日の扱い
repaymentDate int 定期券払戻日付。省略可。
Format: YYYYMMDD
Default: 現在日付
validityPeriod int 定期券有効期間。省略可。
指定できる値:
- 1: 1ヶ月
- 3: 3ヶ月
- 6: 6ヶ月
Default: 6
changeSection string 払い戻しに区間変更時の計算式を適用するか。省略可。
指定できる値:
- true: 適用する
- false: 適用しない
Default: false
separator string 区間分割。複数指定可。省略可。省略時は分割しない
詳しくはこちらを参照。

separator

区間分割は、レスポンスのSectionSeparatorのindexResultSet / TeikiRoute / SectionSeparator / indexを指定して以下のフォーマットで指定します。

[SectionSeparatorのindex],[分割する場合はtrue分割しない場合はfalseを指定]

indexが1のSectionSeparatorの部分で分割する場合

separator=1,true

response

Name Description
ResultSet レスポンスの最下部を表す要素
ResultSet / apiVersion WebAPIバージョン
ResultSet / engineVersion エンジンバージョン
ResultSet / RepaymentList 定期の払い戻し情報の一覧を表す要素
ResultSet / RepaymentList / buyDate 定期購入日
ResultSet / RepaymentList / repaymentDate 定期払い戻し日
ResultSet / RepaymentList / startDate 定期有効開始日
ResultSet / RepaymentList / validityPeriod 有効期間
単位: month
ResultSet / RepaymentList / RepaymentTicket 定期の払い戻し情報を表す要素
ResultSet / RepaymentList / RepaymentTicket / calculateTarget 計算対象かどうか
- True: 計算対象
- False: 計算対象外
ResultSet / RepaymentList / RepaymentTicket / feePriceValue 手数料
ResultSet / RepaymentList / RepaymentTicket / fromTeikiRouteSectionIndex 開始区間インデックス
ResultSet / RepaymentList / RepaymentTicket / index インデックス
※ jsonデータ形式のレスポンスにインデックスは含まれません。jsonにおけるindexの扱い
ResultSet / RepaymentList / RepaymentTicket / payPriceValue 購入金額
ResultSet / RepaymentList / RepaymentTicket / repayPriceValue 払戻金額
ResultSet / RepaymentList / RepaymentTicket / state 定期の状態
- 0x0001: パラメータエラー
- 0x0002: 計算されていない状態
- 0x8000: 未対応の会社が含まれている
- 0x4000: 計算する対象ではない
ResultSet / RepaymentList / RepaymentTicket / toTeikiRouteSectionIndex 終了区間インデックス
ResultSet / RepaymentList / RepaymentTicket / usedPriceValue 使用済金額
ResultSet / RepaymentList / RepaymentTicket / validityPeriod 有効期間
ResultSet / RepaymentList / TeikiRoute 定期の払い戻し用経路を表す要素
ResultSet / RepaymentList / TeikiRoute / SectionSeparator 定期券経路区間の区切りの状態を表す要素
ResultSet / RepaymentList / TeikiRoute / SectionSeparator / changeable - true: dividedの状態を変更可能
- false: 変更不可能
ResultSet / RepaymentList / TeikiRoute / SectionSeparator / divided - true: この区切りで定期が分割されている
- false: 分割されていない
ResultSet / RepaymentList / TeikiRoute / SectionSeparator / index インデックス
※ jsonデータ形式のレスポンスにインデックスは含まれません。jsonにおけるindexの扱い
ResultSet / RepaymentList / TeikiRouteSection 定期の払い戻し用経路の一区間を表す要素
ResultSet / RepaymentList / TeikiRouteSection / index インデックス
※ jsonデータ形式のレスポンスにインデックスは含まれません。jsonにおけるindexの扱い
ResultSet / RepaymentList / TeikiRouteSection / repaymentTicketIndex 払い戻しインデックス
ResultSet / RepaymentList / TeikiRouteSection /Point 地点 を表す要素
ResultSet / RepaymentList / TeikiRouteSection /Point / index インデックス
※ jsonデータ形式のレスポンスにインデックスは含まれません。jsonにおけるindexの扱い
ResultSet / RepaymentList / TeikiRouteSection /Point / Prefecture 都道府県を表す要素
ResultSet / RepaymentList / TeikiRouteSection /Point / Prefecture / code 都道府県コード
ResultSet / RepaymentList / TeikiRouteSection /Point / Prefecture / Name 都道府県の名称を表す要素
ResultSet / RepaymentList / TeikiRouteSection /Point / Station を表す要素
ResultSet / RepaymentList / TeikiRouteSection /Point / Station / code 駅コード
ResultSet / RepaymentList / TeikiRouteSection /Point / Station / Name 駅の名称を表す要素
ResultSet / RepaymentList / TeikiRouteSection /Point / Station / Type 交通種別を表す要素

example

GET /v1/xml/course/repayment?key=アクセスキーを入力してください&separator=1,true&serializeData=SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAgAAAAAAAAAIAAH_fwL_9wMAAAAAAAAAAgCPWAAA1VgAAHtZAAAAAAAACgCBAAABMgIADQAPJFEzAa0DAAC0AwAACgCBAAAC2AIAFQAWJFEzAb8DAADBAwAAAgABAAEAAQABAAEAAAAAAAAA--T3221233232319:F3321122120:A23121141:--960b1f43cd5e939c7535fb6834b4b46ba0f97e75
<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.14.0.0" engineVersion="201404_01a">
  <TeikiRoute>
    <TeikiRouteSection index="1" repaymentTicketIndex="1">
      <Point index="1">
        <Prefecture code="13">
          <Name>東京都</Name>
        </Prefecture>
        <Station code="22671">
          <Name>高円寺</Name>
          <Type>train</Type>
        </Station>
      </Point>
      <Point index="2">
        <Prefecture code="13">
          <Name>東京都</Name>
        </Prefecture>
        <Station code="22741">
          <Name>新宿</Name>
          <Type>train</Type>
        </Station>
      </Point>
    </TeikiRouteSection>
    <SectionSeparator index="1" divided="true" changeable="true"/>
    <TeikiRouteSection index="2" repaymentTicketIndex="2">
      <Point index="3">
        <Prefecture code="13">
          <Name>東京都</Name>
        </Prefecture>
        <Station code="22741">
          <Name>新宿</Name>
          <Type>train</Type>
        </Station>
      </Point>
      <Point index="4">
        <Prefecture code="13">
          <Name>東京都</Name>
        </Prefecture>
        <Station code="22907">
          <Name>初台</Name>
          <Type>train</Type>
        </Station>
      </Point>
    </TeikiRouteSection>
  </TeikiRoute>
  <RepaymentList buyDate="2014-03-24" repaymentDate="2014-03-24" startDate="2014-03-24" validityPeriod="6">
    <RepaymentTicket index="1" fromTeikiRouteSectionIndex="1" toTeikiRouteSectionIndex="1" payPriceValue="22680" usedPriceValue="300" feePriceValue="210" repayPriceValue="22170" calculateTarget="True" validityPeriod="6" state="0"/>
    <RepaymentTicket index="2" fromTeikiRouteSectionIndex="2" toTeikiRouteSectionIndex="2" payPriceValue="24300" usedPriceValue="240" feePriceValue="210" repayPriceValue="23850" calculateTarget="True" validityPeriod="6" state="0"/>
  </RepaymentList>
</ResultSet>
GET /v1/json/course/repayment?key=アクセスキーを入力してください&separator=1,true&serializeData=SHlUczAxLjAwLjA0rAQBAAAAJFEzAQIAAgAAAAAAAAAIAAH_fwL_9wMAAAAAAAAAAgCPWAAA1VgAAHtZAAAAAAAACgCBAAABMgIADQAPJFEzAa0DAAC0AwAACgCBAAAC2AIAFQAWJFEzAb8DAADBAwAAAgABAAEAAQABAAEAAAAAAAAA--T3221233232319:F3321122120:A23121141:--960b1f43cd5e939c7535fb6834b4b46ba0f97e75
{
  "ResultSet": {
    "apiVersion": "1.14.0.0",
    "engineVersion": "201404_01a",
    "TeikiRoute": {
      "TeikiRouteSection": [
        {
          "repaymentTicketIndex": "1",
          "Point": [
            {
              "Prefecture": {
                "code": "13",
                "Name": "東京都"
              },
              "Station": {
                "code": "22671",
                "Name": "高円寺",
                "Type": "train"
              }
            },
            {
              "Prefecture": {
                "code": "13",
                "Name": "東京都"
              },
              "Station": {
                "code": "22741",
                "Name": "新宿",
                "Type": "train"
              }
            }
          ]
        },
        {
          "repaymentTicketIndex": "2",
          "Point": [
            {
              "Prefecture": {
                "code": "13",
                "Name": "東京都"
              },
              "Station": {
                "code": "22741",
                "Name": "新宿",
                "Type": "train"
              }
            },
            {
              "Prefecture": {
                "code": "13",
                "Name": "東京都"
              },
              "Station": {
                "code": "22907",
                "Name": "初台",
                "Type": "train"
              }
            }
          ]
        }
      ],
      "SectionSeparator": {
        "divided": "true",
        "changeable": "true"
      }
    },
    "RepaymentList": {
      "buyDate": "2014-03-24",
      "repaymentDate": "2014-03-24",
      "startDate": "2014-03-24",
      "validityPeriod": "6",
      "RepaymentTicket": [
        {
          "fromTeikiRouteSectionIndex": "1",
          "toTeikiRouteSectionIndex": "1",
          "payPriceValue": "22680",
          "usedPriceValue": "300",
          "feePriceValue": "210",
          "repayPriceValue": "22170",
          "calculateTarget": "True",
          "validityPeriod": "6",
          "state": "0"
        },
        {
          "fromTeikiRouteSectionIndex": "2",
          "toTeikiRouteSectionIndex": "2",
          "payPriceValue": "24300",
          "usedPriceValue": "240",
          "feePriceValue": "210",
          "repayPriceValue": "23850",
          "calculateTarget": "True",
          "validityPeriod": "6",
          "state": "0"
        }
      ]
    }
  }
}