ログインユーザー情報取得
リクエストURL
Section titled “リクエストURL”ホスト
https://api.next-engine.org
エンドポイント
/api_v1_login_user/info
リファレンス内容
Section titled “リファレンス内容”情報取得について
Section titled “情報取得について”入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります
情報取得と検索APIの違いは、以下の通りです
- 情報取得は、対象データを全て取得します(検索条件などの指定が不可能)
- 情報取得は、全フィールドを取得します(取得対象フィールドの指定が不可能)
入力パラメータ
Section titled “入力パラメータ”| パラメータ | 値 | 省略 | 備考 |
|---|---|---|---|
access_token | access_token取得により取得した値 | 必須(SDKの場合不要) | |
refresh_token | access_token取得により取得した値 | 可能(SDKの場合不要) | 【指定してaccess_tokenの有効期限が切れた場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます 【省略してaccess_tokenの有効期限が切れた場合】 出力パラメータ「result」の値がredirectになります(成功時以外の出力パラメータ参照) |
wait_flag | 1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却 | 可能(省略時は1以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
出力パラメータ
Section titled “出力パラメータ”| パラメータ名 | 値 | 備考 |
|---|---|---|
result | success | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
access_token | 入力パラメータで指定したaccess_token/新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります |
refresh_token | 入力パラメータで指定したrefresh_token/新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります |
access_token_end_date | 入力パラメータで指定したaccess_token/新たに発行されたaccess_tokenの有効期限日時 | |
refresh_token_end_date | 入力パラメータで指定したrefresh_token/新たに発行されたrefresh_tokenの有効期限日時 | |
count | 検索結果の件数 | |
data | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します |
ログインユーザー
Section titled “ログインユーザー”| 項目名 | フィールド名 | データ型 | 備考 |
|---|---|---|---|
| メイン機能担当者ID | pic_id | 数値型 | アプリを起動したユーザーの「メイン機能・ユーザー単位」で一意になるID |
| 担当者名 | pic_name | 文字列型 | |
| 担当者カナ | pic_kana | 文字列型 | |
| 部署名 | pic_post_name | 文字列型 | |
| 社会保険区分 | pic_social_insurance_id | 文字列型 | |
| 社会保険名 | pic_social_insurance_name | 文字列型 | |
| 誕生日 | pic_birth_date | 日時型 | |
| 郵便番号 | pic_zip_code | 文字列型 | |
| 住所1 | pic_address1 | 文字列型 | |
| 住所2 | pic_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 | 文字列型 | |
| uid | uid | 文字列型 | アプリを起動したユーザーの「購入アプリ・ユーザー単位」で一意になるID |
| ネクストエンジン担当者ID | pic_ne_id | 文字列型 | アプリを起動したユーザーの「ユーザー単位」で一意になるID |
| 削除フラグ | pic_deleted_flag | 文字列型 | |
| 作成日 | pic_creation_date | 日時型 | |
| 最終更新日 | pic_last_modified_date | 日時型 | |
| 作成担当者ID | pic_creator_id | 数値型 | |
| 作成担当者名 | pic_creator_name | 文字列型 | |
| 最終更新者ID | pic_last_modified_by_id | 数値型 | |
| 最終更新者名 | pic_last_modified_by_name | 文字列型 |
サンプル
リクエスト
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 “エラーコード”エンドポイント固有のエラーコードはありません。 共通エラーコードは メッセージコード一覧 を参照してください。
- 構造化スキーマビュー:
/openapi/operations/api_v1_login_user_info/(OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧:
/guides/param/message/(result/code/messageの意味)
同じカテゴリの他のエンドポイント (認証)
Section titled “同じカテゴリの他のエンドポイント (認証)”- アプリ利用企業一覧 —
POST /api_app/company - 企業情報取得 —
POST /api_v1_login_company/info - NEログインaccess_token取得 —
POST /api_neauth - NEログインuid・state取得 —
POST /users/sign_in