アカウント詳細取得_API


概要

{success} KIZUNAを運営する本システムにログインできるアカウントの詳細取得APIです。


エンドポイント

メソッド URI Headers
GET /api/account/{id} Default

リクエストパラメーター

パラメーター名 内容 特記
id int アカウントID
/api/account/1

レスポンス

成功時
パラメーター名 内容 特記
id int id
name string アカウント名称
login_id string アカウントログインID
{
  "result"   : true,
  "errors"   : "",
  "data"     : {
    'id'                        : 1,
    'name'                      : '管理者',
    'login_id'                  : 'admin@gmail.com',
  },
}

{primary} 何もなければ空配列で返却します。

 

{warning} パスワードは返却しません。

失敗時

ステータスコード:200

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

データ取得

SELECT
    *
FROM
    `cmps_accounts`
WHERE
    `cmps_accounts`.`id` = $this->route('id')
AND `cmps_accounts`.`deleted_at` IS NULL

RUN