従業員アバター画像の更新
リクエスト
エンドポイント
実行先のURLについて詳しくは、「APIエンドポイント」をご覧ください。
| HTTPメソッド | APIパス | 用途 | マスタ管理プラスオプション必須 |
|---|---|---|---|
| PUT | /api/v22.10/members/<従業員のID>/avatar | 従業員のアバター画像の更新 | 〇 |
パスパラメータ
| エンドポイント内の表記 | 必須 | データ形式 | デフォルト値 | 説明 |
|---|---|---|---|---|
| <従業員のID> | 〇 | 文字列 |
ー | 従業員のID |
クエリパラメータ
不要
リクエストヘッダ
Content-Type: multipart/form-data |
Authorization: Bearer {APIトークン} |
リクエストボディ
| 項目名 | 必須 | データ形式 | デフォルト値 | 説明 |
|---|---|---|---|---|
| changeDate | ー | 文字列 (YYYY-MM-DD形式) |
実行日を表す文字列 | アバター画像の変更日 |
| file | 〇 |
バイナリ |
ー | アバター画像データ。ファイル形式は、jpeg、png、bmpのいずれか |
レスポンス
レスポンスボディ
| 項目名 | データ形式 | 説明 |
|---|---|---|
| id | 文字列 | 従業員のID |
| name | 文字列 | 従業員の名前 |
| 文字列 | 従業員のメールアドレス | |
| avatarId | 文字列 | アバター画像のID |
| changeDate | 文字列 (YYYY-MM-DD形式) | アバター画像の変更日 |
実行例
| exampleテナントの従業員ID「A0bc1DefGHijk2lmNo3p2q」に対するcurlコマンドでの実行 |
|---|
// APIトークンを $API_TOKEN 変数に登録 |
// 登録するアバター画像がカレントディレクトリの「avater.png」に保存 |
curl \ |
-X POST 'https://example.igms.iij.jp/api/v22.10/members/A0bc1DefGHijk2lmNo3p2q/avatar' \ |
-H "Authorization: Bearer $API_TOKEN" \ |
-F file=@avater.png |
| レスポンスボディ例 |
|---|
{"id":"A0bc1DefGHijk2lmNo3p2q","name":"IIJ 太郎","email":"iij-taro@example.jp"} |