コンテンツにスキップ

ログインユーザー情報取得

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_login_user/info

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります

情報取得と検索APIの違いは、以下の通りです

  • 情報取得は、対象データを全て取得します(検索条件などの指定が不可能)
  • 情報取得は、全フィールドを取得します(取得対象フィールドの指定が不可能)
パラメータ省略備考
access_tokenaccess_token取得により取得した値必須(SDKの場合不要)
refresh_tokenaccess_token取得により取得した値可能(SDKの場合不要)【指定してaccess_tokenの有効期限が切れた場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます 【省略してaccess_tokenの有効期限が切れた場合】 出力パラメータ「result」の値がredirectになります(成功時以外の出力パラメータ参照)
wait_flag1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却可能(省略時は1以外とする)詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
パラメータ名備考
resultsuccesssuccess以外の場合の出力パラメータは成功時以外の出力パラメータ参照
access_token入力パラメータで指定したaccess_token/新たに発行されたaccess_token有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
refresh_token入力パラメータで指定したrefresh_token/新たに発行されたrefresh_tokenaccess_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります
access_token_end_date入力パラメータで指定したaccess_token/新たに発行されたaccess_tokenの有効期限日時
refresh_token_end_date入力パラメータで指定したrefresh_token/新たに発行されたrefresh_tokenの有効期限日時
count検索結果の件数
data検索結果の連想配列(JSONのオブジェクト型)検索対象の全フィールドを返却します
項目名フィールド名データ型備考
メイン機能担当者IDpic_id数値型アプリを起動したユーザーの「メイン機能・ユーザー単位」で一意になるID
担当者名pic_name文字列型
担当者カナpic_kana文字列型
部署名pic_post_name文字列型
社会保険区分pic_social_insurance_id文字列型
社会保険名pic_social_insurance_name文字列型
誕生日pic_birth_date日時型
郵便番号pic_zip_code文字列型
住所1pic_address1文字列型
住所2pic_address2文字列型
携帯番号pic_mobile文字列型
電話番号pic_phone文字列型
メールアドレスpic_mail_address文字列型
入社日pic_entering_company_date日時型
退職日pic_retirement_date日時型
担当店舗コードリストpic_charge_shop_id_list文字列型
テンプレートフラグpic_template_flag文字列型
スキンカラーpic_skin_color文字列型
言語コードpic_language_code文字列型
uiduid文字列型アプリを起動したユーザーの「購入アプリ・ユーザー単位」で一意になるID
ネクストエンジン担当者IDpic_ne_id文字列型アプリを起動したユーザーの「ユーザー単位」で一意になるID
削除フラグpic_deleted_flag文字列型
作成日pic_creation_date日時型
最終更新日pic_last_modified_date日時型
作成担当者IDpic_creator_id数値型
作成担当者名pic_creator_name文字列型
最終更新者IDpic_last_modified_by_id数値型
最終更新者名pic_last_modified_by_name文字列型

サンプル

リクエスト

Terminal window
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \
"https://api.next-engine.org/api_v1_login_user/info"

レスポンス

{
"result":"success",
"count":"1",
"data":[
{
"pic_id":"10002",
"pic_name":"xxxxxxxxxxxxxx",
"pic_kana":"xxxxxxxxxxxxxx",
"pic_post_name":"xxxxxxxxxxxxxx",
"pic_social_insurance_id":null,
"pic_social_insurance_name":null,
"pic_birth_date":"0000-00-00",
"pic_zip_code":"",
"pic_address1":"",
"pic_address2":"",
"pic_mobile":"",
"pic_phone":"",
"pic_mail_address":"xxxxx@xxxx.xxx",
"pic_entering_company_date":"0000-00-00",
"pic_retirement_date":"0000-00-00",
"pic_charge_shop_id_list":null,
"pic_template_flag":"1",
"pic_skin_color":null,
"pic_language_code":null,
"pic_creation_date":"2017-01-11 18:24:04",
"pic_last_modified_date":"2017-03-07 15:10:24",
"pic_creator_id":"9999",
"pic_creator_name":"xxxxxxxxxx",
"pic_last_modified_by_id":"10002",
"pic_last_modified_by_name":"xxxxxxxxxx",
"uid":"xxxxxxxxxxxxxx",
"pic_ne_id":xxxxxxxxx"
}
],
"access_token":"xxxxxxxxxx",
"access_token_end_date":"2017-04-13 18:24:53",
"refresh_token":"xxxxxxxxxx",
"refresh_token_end_date":"2017-04-15 18:24:53"
}

エンドポイント固有のエラーコードはありません。 共通エラーコードは メッセージコード一覧 を参照してください。

同じカテゴリの他のエンドポイント (認証)

Section titled “同じカテゴリの他のエンドポイント (認証)”