バージョン:1.0
3.プロバイダ検索APIa.リクエストURL
http://api.kakaku.com/Ver1/ProviderSearch.asp?パラメータ名=パラメータ値・・・・
b.リクエストパラメータ
*ZipCodeの指定が必須となります。
| パラメータ名 | 説明 | ||||||||
| ZipCode | 最安を知りたい地域の郵便番号を [XXX-XXXX] という形式で指定します。 |
||||||||
| TypeOfLine | 回線の種類を指定します。 ※省略可能です。
|
||||||||
| TypeOfResidence | 住居区分を指定します。 ※省略可能です。
|
||||||||
| TelSubscription | 電話加入権の有無を指定します。 ※省略可能です。
|
c.リターンパラメータ
ZipCodeで指定された地域の各プロバイダのプランを最安順で5件までXML形式で返します。指定された条件に該当するプランが存在しなかった場合、当該アイテムの属性は返しません。
| パラメータ名 | 説明 | データ型 |
| Ranking | ランキングの順位 | Integer |
| ProviderName | プロバイダ名 | String |
| ProviderImageUrl | プロバイダ画像イメージのURL | String |
| ProviderTopUrl | プロバイダページのURL | String |
| Carrier | 回線業者名 | String |
| PlanName | プラン名 | String |
| PlanPageUrl | プラン詳細ページへのURL | String |
| MaxDownLink | 回線速度(下り) | String |
| MaxUpLink | 回線速度(上り) | String |
| AverageMonthlyFee | 月額平均利用額 ※総合計を12ヶ月で割った金額 |
Integer |
| TotalFee | 総合計 = 初期費用 + (月額費用×利用月数) - (価格.comキャンペーン割引金額 + プロバイダキャンペーン割引金額) ※12ヶ月での総利用額 |
Integer |
| InitialFee | 初期費用 | Integer |
| MonthlyFee | 月額費用 ※実際に毎月支払う利用金額 |
Integer |
| KakakuCampaign | 価格.comキャンペーン割引金額 ※価格.comからの申込のみに適用されるキャンペーン割引金額 |
Integer |
| ProviderCampaign | プロバイダキャンペーン割引金額 ※プロバイダが提供しているキャンペーン割引金額 |
Integer |
d.サンプル
リクエスト
http://api.kakaku.com/Ver1/ProviderSearch.asp?ZipCode=112-0004&TypeOfLine=FTTH& TypeOfResidence=House&TelSubscription=Disable
の場合。
http://api.kakaku.com/Ver1/ProviderSearch.asp?ZipCode=112-0004&TypeOfLine=FTTH& TypeOfResidence=House&TelSubscription=Disable
の場合。
結果
e.エラー
| エラーコード | 内容 |
| PlanNotFound | 該当するプランがひとつもありませんでした。 |
| InvalidParameterValue | パラメータの値が入っていないか、不正です。 |
| InternalServerError | サーバは、処理を完了できませんでした。 |
PlanNotFoundの場合
<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>PlanNotFound</Message>
</Error>
InvalidParameterValueの場合
<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>InvalidParameterValue</Message>
</Error>
InternalServerErrorの場合
<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>InternalServerError</Message>
</Error>

