不在設定
メンバーの不在状態を設定します。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}/absence
HTTP Method
PUT (Content-Type: application/json; charset=UTF-8)
Path Parameters
パラメーター | タイプ | 上限 | 必須 | 説明 |
---|---|---|---|---|
domainId | Integer | Y | ドメイン ID | |
externalKey | String | 100 字 | Y | メンバーの External Key |
Request parameters
Request Body
パラメーター | タイプ | 上限 | 必須 | 説明 |
---|---|---|---|---|
reason | int | Y | 不在設定値 ● 100: 解除 ● 200: 出張 ● 300: 研修 ● 400: 病欠 ● 500: 休暇 ● 600: 休職 ● 700: その他 200~700を設定した場合、ユーザー画面の 「環境設定 > 個人情報 > ステータス」 の項目には「不在」と表示され「ステータスメッセージ」に詳細が表示されます。 |
|
from | String | Y | 開始日 例 ) yyyy-MM-dd hh:mm:ss |
|
to | String | Y | 終了日 例 ) yyyy-MM-dd hh:mm:ss |
|
timeZone | String | Y | タイムゾーンコード。付録のタイムゾーンコード参照。 | |
message | Object | N | 送信先へ送るメッセージ | |
message.inside | String | 300 字 | N | 組織内のメンバーにメールで送信するメッセージ (アドバンスト/ベーシック/プレミアムプランのみ) |
message.outside | String | 300 字 | N | 外部にメールで送信するメッセージ (アドバンスト/ベーシック/プレミアムプランのみ) |
Request Example
PUT https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123/absence
{
"reason": 500,
"from": "2017-06-21T09:00:00",
"to": "2017-06-29T23:00:00",
"timeZone": "Asia/Seoul",
"message": {
"inside": "test message",
"outside": "test message"
}
}
Response
呼び出しに成功すると HTTP 200 コードを返します。
Error Code
呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST APIエラーコードを参照してください。