在席情報を取得する(GaroonユーザーIDを指定)
在席情報を取得する(GaroonユーザーIDを指定)
GaroonユーザーIDを指定して在席情報を取得します。
URL
クラウド版
https://sample.cybozu.com/g/api/v1/presence/users/USER_ID
パッケージ版
環境に合わせてそれぞれ以下を置き換えてください。
IP_ADDRESS_OR_HOST_NAME
:Garoonのインストール先のIPアドレスまたはホスト名INSTALL_IDENTIFER
:Garoonのインストール識別子
- Windows環境
- http://
IP_ADDRESS_OR_HOST_NAME
/scripts/INSTALL_IDENTIFER
/grn.exe/api/v1/presence/users/USER_ID
- Linux環境
- http://
IP_ADDRESS_OR_HOST_NAME
/cgi-bin/INSTALL_IDENTIFER
/grn.cgi/api/v1/presence/users/USER_ID
パスパラメーター
パラメーター名 | 説明 |
---|---|
USER_ID | 取得する在席情報のGaroonユーザーID |
HTTPメソッド
GET
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 5.0以降
必要なアクセス権
なし
リクエスト
パラメーター
なし
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/presence/users/1
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST APIの共通仕様 を参照してください。
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
user.id | 数値 | GaroonユーザーID |
user.code | 文字列 | ユーザーのログイン名 パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。 詳細は ユーザー情報の項目を変更する を参照してください。 |
user.name | 文字列 | ユーザーの表示名 |
updatedAt | 文字列 | 在席情報の更新日時 形式はISO8601のUTCタイムゾーンです。 |
notes | 文字列 | メモ 改行文字は「\n」です。 |
status | オブジェクト | 在席情報のステータス |
status.name | 文字列 | 在席情報のステータス名status.code ごとに内容が異なります。また、値の言語はAPIを実行するユーザーの言語設定に応じます。次に示すのは、日本語に設定した場合の値です。
|
status.code | 文字列 | 在席情報のステータスコード
|
レスポンスの例
|
|
サンプルコード
curlを使ったリクエスト
|
|
Garoon REST APIリクエストを送信するAPI を使ったリクエスト
|
|