代理店詳細取得＿API

概要

{success} KIZUNAを販売してくれる代理店の詳細取得APIです。

エンドポイント

メソッド URI Headers
GET /api/agency/{id} Default

リクエストパラメーター

パラメーター名 必須 型 桁 項目名 特記
id 〇 int 10 代理店ID 
/api/agency/1

レスポンス

成功時
パラメーター名 型 桁 項目名 特記
id int 10 ID
code string 13 代理店CODE
name string 100 名前
email string 255 連絡先メアド
phone1 string 5 連絡先電話番号
phone2 string 4 連絡先電話番号
phone3 string 4 連絡先電話番号
address string 255 担当住所
corporation_name string 255 法人名（任意）
corporation_address string 255 法人住所（任意）
corporation_url string 255 法人URL（任意）
organization_total_count int 10 総獲得件数 紐づいている監理団体の総件数
organization_payment_count int 10 当月支払分の獲得件数 開いている月の1日時点で入金済みとなっている　&&　この監理団体が獲得した　監理団体数
payment_account_bank_name string 100 支払先銀行名
payment_account_branch_name string 100 支払先銀行支店名
payment_account_type string 4 支払先口座種類
payment_account_number string 7 支払先口座番号
payment_account_holder string 50 支払先口座名義
remarks string 65535 備考 
{
  "result"   : true,
  "errors"   : "",
  "data"     : {
    'id'                          : 1,
    'name'                        : 'テスト太郎'
    'email'                       : 'agency@example.com'
    'phone1'                      : '090'
    'phone2'                      : '1234'
    'phone3'                      : '5678'
    'address'                     : '東京都千代田区東神田1-1-1'
    'corporation_name'            : '株式会社エアコン達人'
    'corporation_address'         : '大阪府大阪市北区梅田1-1-1'
    'corporation_url'             : 'https://cmps.jp'
    'organization_total_count'    : 6
    'organization_payment_count'  : 5
    'payment_account_bank_name'   : 'りそな銀行'
    'payment_account_branch_name' : '池袋'
    'payment_account_type'        : '普通'
    'payment_account_number'      : '1234567'
    'payment_account_holder'      : '株式会社エアコン達人'
    'remarks'                     : 'メモメモめもめも'
  },
}

{primary} 何もなければ空配列で返却します。

失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果
error List 配列 
{
  "result"   : false,
  "errors"   : {
    'error'       : ['失敗しました'],
  },
  "data"     : "",
}