在席情報を取得する(ログイン名を指定)

目次

在席情報を取得する(ログイン名を指定)

ログイン名を指定して在席情報を取得します。

URL

クラウド版

https://sample.cybozu.com/g/api/v1/presence/users/code/LOGIN_NAME

パッケージ版

環境に合わせてそれぞれ以下を置き換えてください。

  • 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/code/`LOGIN_
Linux 環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/presence/users/code/`LOGIN_
パスパラメーター
パラメーター名 説明
LOGIN_NAME 取得する在席情報のログイン名
指定する値を URL エンコードしてください。
たとえば「user one」というログイン名の場合は、「user%20one」を指定します。

HTTP メソッド

GET

利用できるバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 5.0 以降

必要なアクセス権

なし

リクエスト

パラメーター

なし

リクエストの例
URL

https://sample.cybozu.com/g/api/v1/presence/users/code/c000001

ヘッダー
1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。

レスポンス

プロパティ
プロパティ名 説明
user.id 数値 ユーザー ID
user.code 文字列 ユーザーのログイン名
パッケージ版 Garoon の場合、ログイン名を公開する設定が必要です。
詳細は ユーザー情報の項目を変更する (External link) を参照してください。
user.name 文字列 ユーザーの表示名
updatedAt 文字列 在席情報の更新日時
形式は ISO8601 の UTC タイムゾーンです。
notes 文字列 メモ
改行文字は「\n」です。
status オブジェクト 在席情報のステータス
status.name 文字列 在席情報のステータス名
status.code ごとに内容が異なります。
また、値の言語は API を実行するユーザーの言語設定に応じます。次に示すのは、日本語に設定した場合の値です。
  • 「attend」の場合:「在席」
  • 「absence」の場合:「不在」
  • 管理者またはアプリケーション管理者が追加したステータス:追加したステータス
  • 空の文字列の場合:「登録がありません」
status.code 文字列 在席情報のステータスコード
  • attend
  • absence
  • 管理者またはアプリケーション管理者が追加したステータス
  • 空の文字列
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "user": {
    "id": "1",
    "code": "c000001",
    "name": "Noboru Satoh(Satoh Noboru); Sales Department"
  },
  "updatedAt": "2017-09-26T06:25:18Z",
  "notes": "This is presence note.",
  "status": {
    "name": "At desk",
    "code": "attend"
  }
}

サンプルコード

curl を使ったリクエスト
1
2
curl -X GET 'https://sample.cybozu.com/g/api/v1/presence/users/code/c000001' \
-H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' 
Garoon REST API リクエストを送信する API を使ったリクエスト
1
await garoon.api('/api/v1/presence/users/code/c000001', 'GET', {});