ユーザー情報を取得する
ユーザー情報を取得する
GaroonユーザーIDをリクエストのパラメーターとして受け取り、ユーザー情報をレスポンスとして返すAPIです。 ユーザー情報の項目のうち、システム管理者が非公開に設定したもの、およびカスタマイズ項目は取得できません。 なお、クラウド版Garoonではカスタマイズ項目以外のユーザー情報の項目を非公開にできません。
API名
BaseGetUsersById
使用可能なGaroonのバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| user_id/text() | base:IDType | 1~ 無制限 | 情報取得するGaroonユーザーID |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| user | base:UserType | 1~ 無制限 | 取得したユーザの情報 |
例
|
|
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_CMMN_00105 | 指定したユーザーが存在しない場合 |
ログイン名からユーザーを取得する
ログイン名をリクエストのパラメーターとして受け取り、ユーザー情報をレスポンスとして返すAPIです。 ユーザー情報の項目のうち、システム管理者が非公開に設定したもの、およびカスタマイズ項目は取得できません。 なお、クラウド版Garoonではカスタマイズ項目以外のユーザー情報の項目を非公開にできません。
API名
BaseGetUsersByLoginName
使用可能なGaroonのバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| login_name/text() | base:NonBlankStringType | 1~ 無制限 | 情報取得するユーザーのログイン名 |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| user | base:UserType | 1~ 無制限 | 取得したユーザの情報 |
例
|
|
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_CMMN_00105 | 指定したユーザーが存在しない場合 |
ユーザーの更新情報を取得する
GaroonユーザーIDとversionをリクエストのパラメーターとして受け取り、ユーザーの更新情報を返すAPIです。
API名
BaseGetUserVersions
使用可能なGaroonのバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| user_item | base:ItemVersionType | 0~ 無制限
|
更新情報を取得するGaroonユーザーIDとバージョン |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| user_item | base:ItemVersionResultType | 0~ 無制限
|
取得したユーザーの更新情報 |
例
|
|
制限事項
- クラウド版では、ユーザー画像情報は取得できません。
