代理店一覧取得＿API

概要

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

エンドポイント

メソッド URI Headers
GET /api/agency/list/{page}/{per_page}?search=〇〇 Default

リクエストパラメーター

/api/agency/list/0/50?search=〇〇

ROUTEパラメータ

パラメーター名 必須 型 桁 項目名 特記
page 〇 int 10 現在のページ 何回実行したか何P目かを表す 以降加算される
per_page 〇 int 3 リクエスト件数 50なら50件返却

GETパラメータ

パラメーター名 必須 型 桁 項目名 特記
search string 255 検索文字 名前/メアド/法人名　空白区切り　でLIKE検索 絞り込み検索時のみ付加されます。

{primary} pageが0の時は＝1ページ目　/　1の時は2ページ目と同義となります。

レスポンス

成功時
パラメーター名 型 桁 項目名 特記
id int 10 代理店のID
code string 13 代理店CODE
name string 255 代理店の名前
organization_payment_count int 10 総獲得件数 代理店に紐づく監理団体数
created_at string 255 代理店作成日 /区切り 
{
  "result"   : true,
  "errors"   : "",
  "data"     : [
    {
      'id'                         : 1,
      'name'                       : 'テスト代理店',
      'organization_payment_count' : 5,
      'created_at'                 : '2020/03/05',
    },
    {
      'id'                         : 10,
      'name'                       : 'テスト代理店',
      'organization_payment_count' : 6,
      'created_at'                 : '2020/03/05',
    },
  ],
}

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

失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果
errors List 配列 

{
  "result"   : false,
  "errors"   : {
    'error'       : ['失敗しました'],
  },
  "data"     : "",
}