初回パスワード登録 - 登録 API

概要

{primary} KIZUNAの初回会員認証後の初回パスワード登録を行います。

エンドポイント

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

POSTパラメータ

パラメーター名 型 内容 特記
organization_id int 監理団体ID 必須項目。
password string パスワード 必須項目。8~20文字の英数字記号で入力。パスワード(確認)と一致しない場合はエラー。
password_confirmation string パスワード(確認) 必須項目。8~20文字の英数字記号で入力。

レスポンス

成功時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果 パスワードの登録処理に成功した場合はtrue
errors array エラーメッセージ 成功のためエラーがないので空配列が返ってきます
alert array アラート 成功のためエラーがないので空配列が返ってきます
data array 返却するものがないので空配列が返ってきます 
{
    "data": [],
    "result": true,
    "errors": [],
    "alert": []
}
失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果 既に初回パスワード登録済み もしくは パスワードの登録処理に失敗した場合はfalse
errors array エラーメッセージ バリデーションエラー時にエラーメッセージを返します。
alert array アラート アラートは返さないので空配列が返ってきます
data[is_registered] bool 初回パスワード登録済みか？ 初回パスワード登録済みの場合のみtrueを返します。 
// バリデーションエラー例
{
    "data": [],
    "result": false,
    "errors": {
        "password": "パスワードは8～20字で入力してください。",
        "password_confirmation": "パスワード(再確認)は必須項目です。"
    },
    "alert": []
}

// 既に登録済みの場合
{
    "data": {
        "is_registered": true
    },
    "result": false,
    "errors": [
        "既に登録済みです。"
    ],
    "alert": []
}