従業員追加
OpenAPI説明
当該OpenAPIは従業員を新規追加する際に利用します。
制約・前提条件
部門との相関関係につき、
所属部門が部門マスタに登録済であること；
従業員の主務開始日は部門の有効開始日から終了日に含まれる必要があります；
OpenAPI権限
当該OpenAPIはテナント権限が必要です。
リクエストURI
/api/openapi/users
リクエスト形式
POST
リクエスト例
{
"employeeId": "EMP-001",
"fullName": "張三",
"email": "san.zhang@spendia.jp",
"onboardDate": "2020-01-01",
"birthday": "1990-01-01",
"gender": "0",
"staffType": "01",
"job": "01",
"approvalLevel": "111",
"staffLevel": "1",
"loginCode": "A_001",
"notificationStrategyCode": "policy_strategy_code",
"mobile":"123456789",
"countryCode":"JP",
"company": {
"oid": "051dbcbe-02d5-45b0-9159-1e28da3b0412",
"code": "COM-1"
},
"department": {
"oid": "051dbcbe-12d5-45b0-9159-1e28da3b0414",
"code": "DEPT-1"
},
"managerEmployeeId": "EMP-2",
"customFields": [
{
"fieldCode": "date",
"value": "2020-3-21"
}
],
"postCustomFields": [
{
"fieldCode": "order",
"value": "15"
}
],
"fromDate": "2021-04-07",
"accountTypeCode": "1",
"isMFAEnabled": false
}
リクエスト項目
Employee
| 項目名 | タイプ | 必須 | キー | 規則 | 説明 |
|---|---|---|---|---|---|
| employeeId | String | ○ | ○ | 最大32文字 | 従業員番号 |
| fullName | String | ○ | 最大100文字 | 従業員名前 | |
| String | ○ | 最大128文字 | メールアドレス | ||
| onboardDate | Date | 日付フォーマット：yyyy-MM-dd | 入職日 | ||
| birthday | String | 日付フォーマット：yyyy-MM-dd | 誕生日 | ||
| gender | String | システム値セット：性別 最大50文字 | 性別 | ||
| staffType | String | システム値セット：従業員タイプ 最大50文字 | 従業員タイプ | ||
| job | String | システム値セット：職務 最大50文字 | 職務 | ||
| approvalLevel | String | システム値セット：承認レベル 最大10桁数字 | 承認レベル | ||
| staffLevel | String | システム値セット：ランク 最大50文字 | ランク | ||
| loginCode | String | 最大20文字 | 企業IDログイン用の従業員ID | ||
| company | EntitySummary | ○ | oidとcode の片方を指定 | 従業員所属会社 | |
| department | EntitySummary | ○ | oidとcode の片方を指定 | 従業員所属部門 | |
| managerEmployeeId | String | 最大32文字 | 所属上役従業員番号 | ||
| customFields | CustomField[] | 最大10個、イメージタイプをサポートしない | 従業員カスタマイズ項目リスト | ||
| postCustomFields | CustomField[] | 最大10個、イメージタイプをサポートしない | 職務カスタマイズ項目リスト | ||
| notificationStrategyCode | String | 最大20文字 | 授業員の受信ポリシーコード | ||
| mobile | String | フォーマットは国コードによる。 日本の場合、09012345687 | 電話番号 | ||
| countryCode | String | 英大文字2桁 CN（+86／中国） JP（+81／日本） US（+1／アメリカ） | 電話番号の国番号コード | ||
| fromDate | String | 日付フォーマット：yyyy-MM-dd | 主務開始日 | ||
| accountTypeCode | String | 1:テナント主務、2:テナント兼務 | テナント間兼務区分 | ||
| isMFAEnabled | Boolean | デフォルト：有効 | 二要素認証ログイン true：有効 false：無効 |
EntitySummary
| 項目名 | タイプ | 必須 | 規則 | 説明 |
|---|---|---|---|---|
| oid | UUID | 36桁 | エンティティOID | |
| name | String | 最大50文字 | エンティティ名称 | |
| code | String | 最大50文字 | エンティティCode | |
| path | String | エンティティパス（部門のみ） |
CustomField
| パラメータ名 | タイプ | 必須 | キー | 規則 | 説明 |
|---|---|---|---|---|---|
| fieldCode | String | ○ | ○ | 最大50文字 | カスタマイズ項目コード |
| value | String | 最大500文字 | カスタマイズ項目値、カスタマイズ項目の設定が必須の場合はカスタマイズ項目値は必須入力です |
OpenAPIリターン例
成功例
{
"message": "success",
"oid": "3249b50a-1e29-4cae-93ea-bfec4955fafa",
"key": "EMP-1"
}
失敗例
{
"message": "パラメータ:gender,最大50文字",
"errorCode": "0013"
}
項目説明
| 項目名 | タイプ | 説明 |
|---|---|---|
| message | String | エラーメッセージを返す |
| errorCode | String | エラーコードを返す |
| oid | UUID | 従業員OID |
| key | String | 従業員番号 |
エラーコード説明
| errorCode | message | 説明 |
|---|---|---|
| 0013 | {0}は{1}文字以内で指定してください | |
| 120001 | テナントの権限がありません | |
| 120003 | {0}は指定必須の項目です | |
| 120210 | 指定したメールアドレスが正しくありません | |
| 120222 | 個人情報拡張項目は最大10個まで設定可能です。 | |
| 120223 | 個人情報拡張項目のコードが必須入力です。 | |
| 120225 | 個人情報拡張項目の値が必須入力です。 | |
| 120227 | 個人情報拡張項目のコードが重複しています。 | |
| 121301 | 会社は存在しない | |
| 121307 | 部門が存在しません。 | |
| 6013009 | 日付フォーマットはyyyy-MM-ddです | |
| 6040014 | メールアドレスは既に存在している | メールアドレスはインスタンス単位で重複できませんので、社内のみならず、他の会社のユーザーさんに紐づかれても登録できません。 |
| 6047044 | 従業員番号は既に存在している | |
| 6047060 | 所属上役の従業員番号は無効です | |
| 6047061 | 性別は存在しません | |
| 6047062 | 従業員タイプは存在しません | |
| 6047063 | 職務は存在しません | |
| 6047064 | ランクは存在しません | |
| 6061005 | カスタマイズ項目:{0} を入力してください | |
| 6061006 | カスタマイズ項目:{0} の値は正しくありません | |
| 6061007 | カスタマイズ項目:{0} の値は規則に従っていません | |
| 6061008 | カスタマイズ項目:{0} の整数部は{0}桁以内で指定してください | |
| 6061009 | カスタマイズ項目:{0} の小数部は{0}桁以内で指定してください | |
| 6061010 | カスタマイズ項目:{0} が時間フォーマットではありません。 | |
| 6061011 | カスタマイズ項目:{0} は日付フォーマットyyyy-MM-ddで指定してください | |
| 8702002 | 操作が失敗しました。会社が未指定の部門が存在します。 | |
| 8702003 | 社員の所属会社が所属部門の会社と一致していません | |
| 12458005 | 従業員IDは2０桁以内のアルファベット、数字だけです | |
| 12458006 | 入力された従業員IDは既に存在するので、改めて入力ください。 | |
| 136791002 | 受信ポリシーコード，【アルファベット，数字，-，_】以外の文字を入力しないでください | |
| 136791003 | 受信ポリシー{0},存在しないまた既に無效になった | |
| 136791004 | 20桁以内の文字を入力してください | |
| 6047054 | 無効な部門コードです。 | |
| 6047055 | 無効な会社コードです。 | |
| 0010 | パラメータ {0} のフォーマットが不正です。 | |
| 6047034 | 従業員番号は従業員が見つからない | |
| 6047044 | 従業員番号は既に存在している | |
| 6047068 | 承認レベルはNullです | |
| 120224 | 個人情報拡張項目の検証に失敗しました:{0} | |
| 60390001 | 有効な所属情報が存在しません | |
| 60390003 | {0}に有効な所属情報（主務）が登録されていないため、ログインできません。管理者に確認してください。 | |
| 60390006 | 部門が所属情報の有効期間（{0}〜{1}）に無効です（{2}〜{3}に無効されました） | 所属部門が主務の有効期間に無効になっていますので、登録できません。 |
| 60390007 | 部門が所属情報の有効期間（{0}〜{1}）に無効です（{2}〜{3}に存在しません） | 所属部門が主務の有効期間に存在しないので、登録できません。 |
| 60390008 | 開始日が{0}の所属情報が既に存在します | |
| 60390010 | 当従業員は、{0}〜{1}の期間内に、同一会社同一部門の有効な所属情報が既に存在します({2}〜{3}) | |
| 60390011 | 所属会社と所属部門の会社と一致しません | |
| 60390012 | 所属情報(期間：{0}〜{1})の会社と部門（期間：{2}〜{3}）の所属会社と一致しません | |
| 60390013 | 開始日を{0}から{1}へ修正するには、既存の所属期間({2}〜{3})を跨ぎます | |
| 60390014 | 終了日を{0}から{1}へ修正するには、既存の所属期間({2}〜{3})を跨ぎます | |
| 60390015 | 開始日を{0}から{1}へ変更するには、既存の所属期間({2}〜{3})を跨ぎます | |
| 60390016 | 主務が所属情報の有効期間（{0}〜{1}）に無効です（{2}〜{3}に無効されました） | |
| 60390017 | 主務が所属情報の有効期間（{0}〜{1}）に無効です（{2}〜{3}に存在しません） | |
| 60390018 | 主務有効期間外の兼務が存在します({0}〜{1}) | |
| 60000006 | 国コード検証規則はないです、国コード:{0} | |
| 220002 | 電話番号のフォーマットが正しくない | |
| 6040013 | 携帯番号は既に存在している | 携帯番号はインスタンス単位で重複できませんので、社内のみならず、他の会社のユーザーさんに紐づかれても登録できません。 |
| 6047478 | テナント間兼務区分1また2を入力してください。（1:テナント間主務、2:テナント間兼務） | |
| spd.9596.004 | 従業員番号{0} はダミーメールなので、テナント間兼務区分1-主務を設定することができません | ダミーとはaccount@common.spendia.jp形式のメールアドレスです。 |
| 2009 | clientIdの取得に失敗しました。 | |
| 120015 | 開始日は終了日より未来に設定することはできません。 | |
| 120226 | 個人情報拡張項目のコードが存在しません:{0}。 | |
| 120252 | 最大10個まで設定可能です | |
| 120917 | 値セットが変更されており、操作に失敗しました。{0}の設定をご確認ください | |
| 120918 | {0}の拡張項目選択値が変更されています。設定内容をご確認ください | |
| 6040005 | 会社は無効です | |
| 6040020 | 1つのメールボックスは複数のユーザーと連動し、エラーデータが存在する | |
| 6040021 | 一つ携帯番号に複数な従業員が紐づいてあります、エラーデータが存在します | |
| 6047007 | メールアドレスを空白している | |
| 6047018 | 他の未知エラー | |
| 6047020 | 携帯番号を空白している | |
| 6047021 | 携帯番号は存在している | |
| 6047028 | 部門は無効でした | |
| 6047029 | 会社に合わない | |
| 6047049 | 部門コードは漢字を含むことができません | |
| 6047050 | 部門コードは不正な文字を含むことができません | |
| 6047051 | 部門コードは36位以上を超えることができません | |
| 6047057 | 退職予定の従業員番号が存在しません。 | |
| 9500006 | {0}が有効な日付範囲外です。（1970/01/01 00：00:01～2038/01/19 03:14:07） | |
| 12020015 | テナントは存在しない | |
| 60390019 | 所属情報期間外の伝票が存在しますので、保存できません。 | |
| 60390020 | 当所属情報に伝票が存在しますので、無効化できません | |
| spd.9596.005 | 従業員番号{0} は他のテナントで職務が存在している、テナント間兼務区分の変更は不可 | テナントグループ利用の場合、グループ会社に兼務があった場合、変更不可になります。 |
| THIRD_PARTY_APPLICATION_004 | 認識できないクライアントマークまたはクライアントには権限がない | |
| spd.13871.001 | {0}：{1}~{2}文字の範囲で入力してください |
従業員更新 →