代理店新規作成・更新＿API

概要

{success} KIZUNAを販売してくれる代理店の新規作成・更新APIです。

エンドポイント

メソッド URI Headers
POST /api/agency Default

リクエストパラメーター

パラメーター名 必須 型 桁 項目名 特記
id △ int 10 ID 更新時必須：新規作成時NULL
name 〇 string 100 名前
email 〇 string 255 連絡先メアド
phone1 〇 string 5 TEL 市外局番
phone2 〇 string 4 TEL 市内局番
phone3 〇 string 4 TEL 加入者番号
address 〇 string 255 担当住所
corporation_name 〇 string 255 法人名（任意）
corporation_address 〇 string 255 法人住所（任意）
corporation_url 〇 string 255 法人URL（任意）
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 備考

※　新規作成時：代理店CODEを自動生成するように

{
    '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'                     : 'メモメモめもめも',
}

レスポンス

成功時
パラメーター名 必須 型 桁 項目名 特記
result 〇 boolean - 結果 true
id 〇 int 10 代理店ID 
{
  "result"   : true,
  "errors"   : "",
  "data"     : {
    'id': 1,
  },
}
失敗時

ステータスコード：200

パラメーター名 必須 型 桁 項目名 特記
result 〇 boolean 1 結果 false
$param:$err string 255 パラメータエラー $param（パラメーター）:$err（エラー内容） 
{
  "result"   : false,
  "errors"                      : {
    $param           : $err,
    $param           : $err,
  },
  "data"     : "",
}