パスワードリセット - リセット用メール送信 API
概要
{primary} パスワードリセット用のリンクが記載されたメールを送信します。
エンドポイント
| メソッド |
URI |
Headers |
| POST |
/api/password/send |
Default |
POSTパラメータ
| パラメーター名 |
型 |
内容 |
特記 |
| login_id |
string |
ログインID(メールアドレス) |
ここに入力されたメールアドレス宛にリセット用メールを送信します。 |
| organization_code |
string |
監理団体コード |
|
レスポンス
成功時
ステータスコード:200
| パラメーター名 |
型 |
内容 |
特記 |
| result |
boolean |
リクエスト結果 |
パスワードリセットしようとしているログインID(メールアドレス)と監理団体が正しい場合はtrue |
| errors |
array |
エラーメッセージ |
成功のためエラーがないので空配列が返ってきます |
| alert |
array |
アラート |
成功のためエラーがないので空配列が返ってきます |
| data |
array |
|
返す値が特にないので空配列が返ってきます |
{
"data": [],
"result": true,
"errors": [],
"alert": []
}
失敗時
ステータスコード:200
| パラメーター名 |
型 |
内容 |
特記 |
| result |
boolean |
リクエスト結果 |
パスワードリセットしようとしているログインID(メールアドレス)と監理団体が正しくない場合はfalse |
| errors |
array |
エラーメッセージ |
エラーメッセージが返却されてきます |
| alert |
array |
アラート |
アラートは返さないので空配列が返ってきます |
| data |
array |
|
返す値が特にないので空配列が返ってきます |
{
"data": [],
"result": false,
"errors": {
"organization_code": "監理団体が見つかりませんでした。"
},
"alert": []