従業員の職務情報個別取得
OpenAPI説明
当該OpenAPIは従業員番号で従業員の職務情報を取得します。
OpenAPI権限
当該OpenAPIはテナント権限が必要です
リクエストURI
/api/openapi/users/posts/by/employeeId
リクエスト形式
GET
リクエストパラメータ例
/api/openapi/users/posts/by/employeeId?employeeId=EMP-001
リクエストパラメータ説明
パラメータ名 | タイプ | 必須 | 規則 | 説明 |
---|---|---|---|---|
employeeId | String | ○ | 最大32文字 | 従業員番号 |
baseDate | String | 日付フォーマット:yyyy-MM-dd | 基準日 なし:システム時点に有効な職務情報 あり:基準日時点に有効な職務情報 |
OpenAPIリターン例
{
"employeeId": "EMP-001",
"fullName": "張三",
"email": "san.zhang@spendia.jp",
"onboardDate": "2019-12-27",
"status": "NORMAL",
"posts": [
{
"companyCode": "CMP-002",
"departmentCode": "D1",
"fromDate": "2022-12-27",
"toDate": "9999-12-31",
"staffLevel": "3",
"job": "1231",
"approvalLevel": "123",
"managerEmployeeId": "007",
"staffType": "01",
"isPrimary": true,
"postCustomFields": [
{
"fieldCode": "user-group1",
"value": "mail_001"
},
{
"fieldCode": "secondJob",
"value": "456"
}
]
},
{
"companyCode": "CMP-002",
"departmentCode": "DEV2",
"fromDate": "2023-1-27",
"endDate": "9999-12-31",
"staffLevel": "5",
"job": "12345",
"approvalLevel": "123",
"managerEmployeeId": "008",
"staffType": "02",
"isPrimary": false,
"postCustomFields": [
{
"fieldCode": "user-group1",
"value": "mail_001"
},
{
"fieldCode": "secondJob",
"value": "456"
}
]
}
]
}
OpenAPIリターン項目
項目名 | タイプ | 規則 | 説明 |
---|---|---|---|
employeeId | String | 最大32文字 | 従業員番号 |
fullName | String | 最大100文字 | 従業員名前 |
String | 最大128文字 | メールアドレス | |
onboardDate | Date | 日付フォーマット:yyyy-MM-dd | 入職日 |
status | String | NORMAL-在職 LEAVING-退職待ち RESIGNED-退職済 | |
posts | Post[] | 職務情報リスト |
Post
項目名 | タイプ | 規則 | 説明 |
---|---|---|---|
companyCode | String | 従業員所属会社 | |
departmentCode | String | 従業員所属部門 | |
fromDate | Date | 日付フォーマット:yyyy-MM-dd | 開始日 |
toDate | Date | 日付フォーマット:yyyy-MM-dd | 終了日 |
staffLevel | String | ランク | |
job | String | 職務 | |
approvalLevel | String | 承認レベル | |
managerEmployeeId | String | 所属上役従業員番号 | |
staffType | String | 従業員タイプ | |
isPrimary | Boolean | 職務フラグ 主務:true 兼務:false | |
postCustomFields | CustomField[] | 職務カスタマイズ項目リスト |
CustomField
パラメータ名 | タイプ | 規則 | 説明 |
---|---|---|---|
fieldCode | String | 最大50文字 | カスタマイズ項目コード |
value | String | 最大50文字 | カスタマイズ項目値、カスタマイズ項目の設定が必須の場合はカスタマイズ項目値は必須入力です |
失敗例
{
"message": "テナントの権限がありません",
"errorCode": "120001"
}
項目説明
項目名 | タイプ | 説明 |
---|---|---|
message | String | メッセージを返す |
errorCode | String | エラーコードを返す |
エラーコード説明
errorCode | message | 説明 |
---|---|---|
120001 | テナントの権限がありません | |
6013009 | 日付フォーマットはyyyy-MM-ddです | |
120003 | パラメータ:{0}は指定必須の項目です |