在席情報の取得(ユーザーIDを指定)
ユーザーIDを指定して在席情報の内容を取得できます。
HTTP メソッド
GET
URI
クラウド版
https://(サブドメイン名).cybozu.com/g/api/v1/presence/users/{id}
パッケージ版(Windows環境)
以下は、ヘルプに記載している Windows のディレクトリー構成でインストールしたときの例です。インストールするディレクトリーを変更している場合は、パスを読み替えてください。
http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/presence/users/{id}
パッケージ版(Linux環境)
以下は、ヘルプに記載している Linux のディレクトリー構成でインストールしたときの例です。インストールするディレクトリーを変更している場合は、パスを読み替えてください。
http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/presence/users/{id}
使用可能なガルーンのバージョン
-
クラウド版 Garoon
- パッケージ版 Garoon バージョン 5.0.0以降
必要なアクセス権
なし
リクエストパラメータ
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
id | 数値 | 必須 |
取得する在席情報のユーザーIDを指定します。 |
リクエストの例
GET /g/api/v1/presence/users/1 HTTP/1.1 Host: {subdomain}.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Typeヘッダは不要です。
レスポンスの例
処理が成功すると、在席情報の内容がJSON形式で返されます。
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
user.id | 数値 |
GaroonユーザーID |
user.code | 文字列 |
Garoonユーザーのログイン名 |
user.name | 文字列 |
Garoonユーザーの表示名 |
updatedAt | 文字列 |
在席情報の更新日時 形式はISO8601のUTCタイムゾーンです。 |
notes | 文字列 |
メモ 改行文字は「\n」です。 |
status | オブジェクト |
在席情報のステータス |
status.name | 文字列 |
在席情報のステータス名
※ ログインユーザーの言語設定によって表示が異なります。これは日本語に設定している場合です。 |
status.code | 文字列 |
在席情報のステータスコード
|
JavaScript サンプル
XMLHttpRequest
在席情報の取得(ログイン名を指定)
ログイン名を指定して在席情報の内容を取得できます。
HTTP メソッド
GET
URI
クラウド版
https://(サブドメイン名).cybozu.com/g/api/v1/presence/users/code/{code}
パッケージ版(Windows環境)
http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/presence/users/code/{code}
パッケージ版(Linux環境)
http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/presence/users/code/{code}
使用可能なガルーンのバージョン
-
クラウド版 Garoon
- パッケージ版 Garoon バージョン 5.0.0以降
必要なアクセス権
なし
リクエストパラメータ
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
code | 文字列 | 必須 |
取得する在席情報のログイン名を指定します。 ユーザーが入力した値はURLエンコードする必要があります。 |
リクエストの例
GET /g/api/v1/presence/users/code/user%2520one HTTP/1.1 Host: {subdomain}.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Typeヘッダは不要です。
レスポンスの例
処理が成功すると、在席情報の内容がJSON形式で返されます。
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
user.id | 数値 |
GaroonユーザーID |
user.code | 文字列 |
Garoonユーザーのログイン名 |
user.name | 文字列 |
Garoonユーザーの表示名 |
updatedAt | 文字列 |
在席情報の更新日時 形式はISO8601のUTCタイムゾーンです。 |
notes | 文字列 |
メモ 改行文字は「\n」です。 |
status | オブジェクト |
在席情報のステータス |
status.name | 文字列 |
在席情報のステータス名
※ ログインユーザーの言語設定によって表示が異なります。これは日本語に設定している場合です。 |
status.code | 文字列 |
在席情報のステータスコード
|
JavaScript サンプル
XMLHttpRequest
制限事項
共通仕様の制限事項 をご確認ください。
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。