カテゴリー内の他の記事

在席情報の取得(GET)

フォローする

Index

在席情報の取得(ユーザーIDを指定)

ユーザーIDを指定して在席情報の内容を取得できます。

HTTP メソッド

GET

URI

クラウド版

https://(サブドメイン名).cybozu.com/g/api/v1/presence/users/{id}

パッケージ版(Windows環境)

http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/presence/users/{id}

パッケージ版(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 が「attend」の場合)
  • 不在(status.code が「absence」の場合)
  • 管理者またはアプリケーション管理者が追加したステータス(status.code が「管理者またはアプリケーション管理者が追加したステータス」の場合)
  • 登録がありません(status.code が空文字の場合)

※ ログインユーザーの言語設定によって表示が異なります。これは日本語に設定している場合です。

status.code 文字列

在席情報のステータスコード

  • attend
  • absence
  • 管理者またはアプリケーション管理者が追加したステータス
  • "" (空の文字列)

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

ログイン名を指定して在席情報の内容を取得できます。

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エンコードする必要があります。
例:
"user one"という名前のユーザーを指定する場合、
"user%20one"と入力します。

リクエストの例 

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 が「attend」の場合)
  • 不在(status.code が「absence」の場合)
  • 管理者またはアプリケーション管理者が追加したステータス(status.code が「管理者またはアプリケーション管理者が追加したステータス」の場合)
  • 登録がありません(status.code が空文字の場合)

※ ログインユーザーの言語設定によって表示が異なります。これは日本語に設定している場合です。

status.code 文字列

在席情報のステータスコード

  • attend
  • absence
  • 管理者またはアプリケーション管理者が追加したステータス
  • "" (空の文字列)

制限事項

共通仕様の制限事項 をご確認ください。

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。