代理店削除＿API

概要

{success} KIZUNAを販売してくれる代理店の削除APIです。

　

{warning} 論理削除とすること

エンドポイント

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

リクエストパラメーター

パラメーター名 必須 型 桁 項目名 特記
id 〇 int 10 代理店ID 
{
    'id'    : 1,
}

レスポンス

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

ステータスコード：200

パラメーター名 必須 型 桁 項目名 特記
result 〇 boolean 1 結果 false
error 〇 List 255 リザルトエラー エラー文章を配列で返却 
{
  "result"   : false,
  "errors"   : {
    'error'        : ['削除できないデータです。'],
  },
  "data"     : "",
}