2.9 部署の API
2.9.1 部署リストの取得 (/api/v2/department)
概要
部署リストを取得します。
リクエストアドレスの例
https://link.japancv.co.jp/api/v2/department
リクエスト方法
GET
認証パラメーター
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
通常のレスポンス
レスポンスのフィールド
パラメーター名 | 型 | 説明 |
id | long | 部署ID |
name | string | 部署名 |
parent_id | long | 上位部署の ID。0 は企業を示します |
leader_id | long | 部署長の ID |
leader_name | string | 部署長の名前 |
user_num | int | 部署内の人数 |
children | list<department> | 下位部署のリスト |
department フィールドの説明
パラメーター名 | 型 | 説明 |
id | long | 部署ID |
name | string | 部署名 |
parent_id | long | 上位部署の ID。0 は企業を示します |
leader_id | long | 部署長の ID |
leader_name | string | 部署長の名前 |
user_num | int | 部署内の人数 |
children | list<department> | 下位部署のリスト |
2.9.2 部署コードでの部署の検索 (/api/v2/department/search/code)
概要
部署コードから部署情報を取得します。
リクエストアドレスの例
https://link.japancv.co.jp/api/v2/department/search/code
リクエスト方法
GET
リクエストパラメーター
パラメーター名 | 型 | 必須 | 説明 |
code | string | Yes | 部署コード。長さ制限は 45 |
認証パラメーター
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
通常のレスポンス
レスポンスのフィールド
パラメーター名 | 型 | 説明 |
id | long | 部署ID |
name | string | 部署名 |
parent_id | long | 上位部署の ID。0 は企業を示します |
leader_id | long | 部署長の ID |
code | string | 部署コード |
エラーレスポンスのフィールド
コード | メッセージ | 説明 |
30001 | Param Invalid | 無効なパラメーターです |
30004 | Missing Param | 部署コードが指定されていません |
2.9.3 ID での部署の検索 (/api/v2/department/{id})
概要
部署 ID から部署情報を取得します。
リクエストアドレスの例
https://link.japancv.co.jp/api/v2/department/{id}
リクエスト方法
GET
リクエストパラメーター
パラメーター名 | 型 | 必須 | 説明 |
id | long | Yes | 部署ID |
認証パラメーター
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
通常のレスポンス
レスポンスのフィールド
パラメーター名 | 型 | 説明 |
id | long | 部署ID |
name | string | 部署名 |
parent_id | long | 上位部署の ID。0 は企業を示します |
leader_id | long | 部署長の ID |
code | string | 部署コード |
エラーレスポンスのフィールド
コード | メッセージ | 説明 |
30001 | Param Invalid | 部署IDが存在しません |
30001 | Param Invalid |
2.9.4 部署の作成 (/api/v2/department)
概要
部署作成のインターフェースです。
リクエストアドレスの例
https://link.japancv.co.jp/api/v2/department
リクエスト方法
POST: form-data
リクエストパラメーター
パラメーター名 | 型 | 必須 | 説明 |
parentId | long | Yes | 上位部署 ID |
name | string | Yes | 名前。長さ制限は 50。空の値で登録しないでください |
leaderId | long | No | 部署長の ID |
code | string | No | 部署コード。長さ制限は 45 |
認証パラメーター
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
通常のレスポンス
レスポンスのフィールド
パラメーター名 | 型 | 説明 |
id | long | 部署ID |
name | string | 部署名 |
parent_id | long | 上位部署の ID。0 は企業を示します |
leader_id | long | 部署長の ID |
code | string | 部署コード |
エラーレスポンスのフィールド
コード | メッセージ | 説明 |
30001 | Param Invalid | 上位の部署を選択ください |
610 | Similar record Exist | 同じ名前の部署が同じレベルに存在します |
620 | Record non-existent Error | 上位部署の ID が存在しません |
30001 | Param Invalid | 無効なパラメーターです。上位部署のIDは空にはできません |
30001 | Param Invalid | 無効なパラメーターです。部署名は空にはできません |
30001 | Param Invalid | 無効なパラメーターです。部署名の長さ制限は 50です |
30001 | Param Invalid | 無効なパラメーターです。部署コードの長さ制限は 45です |
30001 | Param Invalid | 無効なパラメーターです。部署長が存在しません |
30001 | Param Invalid | 無効なパラメーターです。部署コードはすでに存在します |
30001 | Param Invalid | 無効なパラメーターです。部署IDの型変換失敗しました |
30001 | Param Invalid | 無効なパラメーターです。上位部署IDの型変換失敗しました |
30001 | Param Invalid | 無効なパラメーターです。部署長IDの型変換失敗しました |
30001 | Param Invalid | 無効なパラメーターです。の型変換失敗しました |
2.9.5 部署の更新 (/api/v2/department/update)
概要
部署インターフェースを更新します。
リクエストアドレスの例
https://link.japancv.co.jp/api/v2/department/update
リクエスト方法
POST: form-data
リクエストパラメーター
パラメーター名 | 型 | 必須 | 説明 |
id | long | Yes | 部署ID |
parentId | long | Yes | 上位部署 ID。上位部署IDが存在しない場合、エラーとなる可能性があります。ご注意ください |
name | string | Yes | 名前。長さ制限は 50です |
leaderId | long | No | 部署長の ID |
code | string | No | 部署コード。長さ制限は 45です |
認証パラメーター
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
通常のレスポンス
レスポンスのフィールド
パラメーター名 | 型 | 説明 |
id | long | 部署ID |
name | string | 部署名 |
parent_id | long | 上位部署の ID。0 は企業を示します |
leader_id | long | 部署長の ID |
code | string | 部署コード |
エラーレスポンスのフィールド
コード | メッセージ | 説明 |
610 | Similar record Exist | 同じ名前の部署が同じレベルに存在します |
620 | Record non-existent Error | 上位部署の ID が無効です(現在のノードの上位部署は指定できません) |
620 | Record non-existent Error | 部署IDは存在しません |
30001 | Param Invalid | 無効なパラメーターです。部署長が存在しません |
30001 | Param Invalid | 無効なパラメーターです。部署 ID は空にはできません |
30001 | Param Invalid | 無効なパラメーターです。部署IDの型変換失敗しました |
30001 | Param Invalid | 無効なパラメーターです。上位部署IDの型変換失敗しました |
30001 | Param Invalid | 無効なパラメーターです。部署長IDの型変換失敗しました |
30001 | Param Invalid | 無効なパラメーターです。会社IDの型変換失敗しました |
30001 | Param Invalid | 無効なパラメーターです。部署名の長さ制限は 50です |
30001 | Param Invalid | 無効なパラメーターです。部署コードの長さ制限は 45です |
30001 | Param Invalid | 無効なパラメーターです。部署名は空にはできません |
30001 | Param Invalid | 無効なパラメーターです。上位部署の ID は存在しません |
2.9.6 部署の削除 (/api/v2/department/delete)
概要
部署を削除します。
リクエストアドレスの例
https://link.japancv.co.jp/api/v2/department/delete
リクエスト方法
GET
リクエストパラメーター
パラメーター名 | 型 | 必須 | 説明 |
id | long | Yes | 部署ID |
認証パラメーター
パラメーター名 | 型 | 必須 | 説明 |
app_key | string | Yes | Appキー |
sign | string | Yes | シグネチャ。1.3.1 シグネチャ(sign)の計算の項を参照してください |
timestamp | string | Yes | タイムスタンプ |
通常のレスポンス
エラーレスポンスのフィールド
コード | メッセージ | 説明 |
610 | Similar record Exist | 部署にユーザーが存在しているため、部署を削除できません |
610 | Similar record Exist | 部署に下位部署があります |
620 | Record non-existent Error | 上位部署の ID が存在しません |
30001 | Param Invalid | 無効なパラメーターです |
30004 | Missing Param | 部署コードが指定されていません |
最終更新