従業員グループの従業員取得
OpenAPI説明
当該APIは従業員グループの従業員情報の取得に利用します。
リクエストURI
/api/openapi/userGroup/users?companyCode=company-003&userGroupCode=GROUP-001
リクエスト形式
GET
リクエストパラメータ説明
| フィールド名 | カテゴリ | 必須 | 規則 | 説明 |
|---|---|---|---|---|
| companyCode | String | 最大36文字 | 会社コード 会社のtokenで登録する場合、該当項目は無効です | |
| userGroupCode | String | ○ | 最大50文字 | 従業員グループコード |
OpenAPIリターン例
{
"companyCode": "company-003",
"userGroupCode": "GROUP-001",
"userList": [
"EMP-001",
"EMP-002",
"EMP-003",
"EMP-004"
]
}
OpenAPIリターン項目
| フィールド名 | カテゴリ | 規則 | 説明 |
|---|---|---|---|
| companyCode | String | 最大36文字 | 会社コード 会社のtokenで登録する場合、該当項目は無効です |
| userGroupCode | String | 最大50文字 | 従業員グループコード |
| userList | List | 従業員リスト |
失敗例
{
"message": "{0}は指定必須の項目です",
"errorCode": "120003"
}
項目説明
| フィールド名 | カテゴリ | 説明 |
|---|---|---|
| message | String | エラーメッセージ |
| errorCode | String | エラーコード |
エラーコード説明
| errorCode | message | 説明 |
|---|---|---|
| 120003 | {0}は指定必須の項目です | |
| 0013 | {0}は{1}文字以内で指定してください | |
| spd.12366.003 | 従業員グループ:{0}は存在しないか、無効になっています | |
| spd.12366.005 | 会社:{0}は存在しないか、無効になっています |