準備機関 - 新規登録・編集 API

概要

{primary} 新規登録APIが走る前に重複しているデータがあるかどうかのチェックを行います。

監理団体アカウントのみ利用できます。

エンドポイント

メソッド URI Headers
POST /api/application/preparation_agency/valid Default

ROUTEパラメータ

パラメーター名 型 内容 特記

リクエストパラメータ

パラメーター名 必須 型 内容 特記
preparation_agency_type 〇 int 種別 1:準備機関 5:公的機関
name 〇 string 機関名称

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
duplicate_flag boolean true: 重複しているデータがある。 false:重複しているデータがない 
{
    "result"   : true,
    "errors"   : "",
    "data"     : [],
}
失敗時

ステータスコード：200

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

{danger} 失敗時は200以外のエラーコードが返却されます。共通ルールのレスポンスをチェック。

バリデーション

画面項目名 フィールド名 チェック内容 備考
種別 preparation_agency_type required
機関名称 name required
max:255