初回パスワード登録 - 状態確認 API

概要

{primary} KIZUNAの初回会員認証後の初回パスワード登録を行う際、初回パスワード登録を行う状態かどうかを判定します。

エンドポイント

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

GETパラメータ

パラメーター名 型 内容 特記
organization_id int 監理団体ID

レスポンス

成功時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果 会員認証済み且つ初回パスワード未登録の場合にtrue
errors array エラーメッセージ 成功のためエラーがないので空配列が返ってきます
alert array アラート 成功のためエラーがないので空配列が返ってきます
data[is_registered] boolean 初回パスワード登録済みか？ 初回パスワード未登録の場合にfalseを返します。 
{
    "data": {
        "is_registered": false
    },
    "result": true,
    "errors": [],
    "alert": []
}
失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果 初回パスワード登録済み または 初回パスワード登録する対象データが存在しない場合はfalse
errors array エラーメッセージ
alert array アラート アラートは返さないので空配列が返ってきます
data[is_registered] boolean 認証済みか？ 既に初回パスワード登録済みの場合のみ、trueを返します。 
// 初回パスワード登録する対象データが存在しない場合
{
    "data": {
        "is_registered": false
    },
    "result": false,
    "errors": [
        "対象のデータが存在しません。"
    ],
    "alert": []
}

// 初回パスワードが登録済みの場合
{
    "data": {
        "is_registered": true
    },
    "result": false,
    "errors": [
        "既に登録済みです。"
    ],
    "alert": []
}