パスワードリセット - 登録 API

概要

{primary} パスワードリセットを行います。

エンドポイント

メソッド URI Headers
POST /api/password/setting Default

ROUTEパラメータ

パラメーター名 型 内容 特記
organization_code string 監理団体コード 監理団体IDではない
login_id string ログインID メールアドレス
password string パスワード 新しく設定するパスワード
token string トークン

レスポンス

成功時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果 正常にパスワードリセットが行えた場合はtrue
errors array エラーメッセージ 成功のためエラーがないので空配列が返ってきます
alert array アラート 成功のためエラーがないので空配列が返ってきます
data[organization_code] string 監理団体コード 監理団体コード（監理団体IDではない） 
{
    "data": {
        "organization_code": "1111"
    },
    "result": true,
    "errors": [],
    "alert": []
}
失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果 バリデーションNG時やトークンが不正な場合はfalse
errors array エラーメッセージ 発生しているエラーのエラーメッセージが返されます。
alert array アラート アラートは返さないので空配列が返ってきます
data array 返す値が特にないので空配列が返ってきます 
// バリデーションNG時
{
    "data": [],
    "result": false,
    "errors": {
        "password": "パスワードは必須項目です。"
    },
    "alert": []
}

// POSTパラメータのトークンの値が不正ない場合
{
    "data": [],
    "result": false,
    "errors": {
        "token": "トークン不正のためパスワードをリセットすることができません。"
    },
    "alert": []
}