logo-pf
API docs by Redocly

社員マスタ (1.0.0)

Download OpenAPI specification:Download

社員マスタ

社員情報詳細取得

  • 概要：社員の詳細情報を取得する際に利用する。
query Parameters
response_type
required
string (リクエスト種別) <= 10 characters
Example: response_type=string

"json" または "xml" を指定する。

user_id
required
number (ユーザーID) <= 10 characters
Example: user_id=0

取得対象のユーザーIDを指定する。

Responses

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "user_id": 0,
  • "login_id": "test",
  • "last_name": "string",
  • "first_name": "string",
  • "kana_last_name": "string",
  • "kana_first_name": "string",
  • "employee_no": "string",
  • "sectorpost_info[]": [
    ],
  • "office_info[]": [
    ],
  • "role_model_info[]": [
    ],
  • "retirement_flg": 0,
  • "regist_date": "yyyy-MM-dd",
  • "update_date": "yyyy-MM-dd",
  • "access_date": "yyyy-MM-dd",
  • "user_phone": "string",
  • "user_mobile_phone": "string"
}

部署マスタ一覧取得

  • 概要：部署マスタの一覧情報を取得する際に利用する。
query Parameters
response_type
required
string (リクエスト種別) <= 10 characters
Example: response_type=string

"json" または "xml" を指定する。

Responses

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "sector_info[]": [
    ]
}

社員情報一覧取得

  • 概要：社員情報を検索する際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

retirement_flg
number (退職フラグ) <= 1 characters

取得対象ユーザーが未案内、招待中社員の場合、退職者以外となる。
0：全て
1：退職者以外
2：退職者のみ
Default 退職者以外

role_model_code
string (権限ロールモデルコード) <= 4 characters

権限ロールモデルコードで絞り込みを行いたい場合に指定する。
Default 指定なし
マスタ値の参照方法はAppendixの「権限ロールモデルコード」を参照

keyword
string (キーワード) <= 200 characters

検索ワードで絞り込みを行いたい場合に指定する。
＜検索できる項目＞
氏名、ログインID、社員コード ※半角スペースで区切ることで複数指定可能
例）氏名 ID コード
Default 指定なし

search_start_position
number (検索開始位置) <= 4 characters

検索結果一覧の社員情報取得開始位置を指定する。
例）検索開始位置：2、最大取得数：20の場合、検索結果一覧の21～40件目が返却される。

＜取得開始位置に社員情報が存在しない場合＞
空で返却される。

MIN 1
MAX 9999
Default 1

select_limit
number (最大取得数) <= 3 characters

社員情報の最大取得数を指定する。

MIN 1
MAX 100
Default 20

user_list_flg
number (取得対象ユーザー) <= 1 characters

1：登録済社員
2：未案内、招待中社員
Default 登録済み社員

Array of objects (勤務地情報)

勤務地情報で絞り込みを行いたい場合に指定する。
1 件のみ指定可能。

Array of objects (部署情報)

部署情報で絞り込みを行いたい場合に指定する。
1 件のみ指定可能。

Array of objects (役職情報)

役職情報で絞り込みを行いたい場合に指定する。
1 件のみ指定可能。

sort
number (並び順) <= 1 characters

並び順を設定したい場合に指定する。

取得対象ユーザーが登録済社員の場合
0:氏名（昇順）
1:氏名（降順）
2:社員コード（昇順）
3:社員コード（降順）
4:最終ログイン日（昇順）
5:最終ログイン日（降順）
6:最終更新日（昇順）
7:最終更新日（降順）
8:序列（昇順）
9:序列（降順）
Default 氏名（昇順）

取得対象ユーザーが未案内、招待中社員の場合
0:氏名（昇順）
1:氏名（降順）
2:最終招待日（昇順）
3:最終招待日（降順）
Default 氏名（昇順）

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "retirement_flg": 0,
  • "role_model_code": "string",
  • "keyword": "string",
  • "search_start_position": 0,
  • "select_limit": 0,
  • "user_list_flg": 0,
  • "office_info[]": [
    ],
  • "sector_info[]": [
    ],
  • "post_info[]": [
    ],
  • "sort": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "employee_info[]": [
    ],
  • "result_num": 0
}

社員登録・招待

  • 概要：社員の登録招待を行う際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

mailaddress
required
string (メールアドレス) <= 100 characters

メールアドレスを指定する。

last_name
required
string (氏名(氏)) <= 15 characters

例）田中
※自動で全角変換される

first_name
required
string (氏名(名)) <= 15 characters

例）太郎
※自動で全角変換される

kana_last_name
required
string (氏名カナ(氏)) <= 20 characters

例）タナカ
※自動で全角変換される

kana_first_name
required
string (氏名カナ(名)) <= 20 characters

例）タロウ
※自動で全角変換される

employee_no
string (社員コード) <= 15 characters

例）000012345

Array of objects (部署役職情報)

部署役職情報を登録したい場合に指定する。
最大３件まで指定可能。

office_code
string (勤務地コード) <= 15 characters

マスタ値の参照方法はApeendixの「勤務地」を参照

office_name
string (勤務地名) <= 30 characters

マスタ値の参照方法はApeendixの「勤務地」を参照
※自動で全角変換される

Array of objects (権限ロールモデル情報)

権限ロールモデル情報を設定したい場合に指定する。
最大 10 件まで指定可能。
※API 実行ユーザーに権限管理の権限がある場合に指定した権限ロールモデルが設定される。
API 実行ユーザーに権限管理の権限がない場合は指定した権限ロールモデルに関係なく初期設定権限が設定される。

message
string (メッセージ) <= 400 characters

文章の改行を行う場合は\nを指定する。

user_phone
string (電話番号) <= 24 characters

例）03-5776-1147

user_mobile_phone
string (携帯電話番号) <= 24 characters

例）090-5776-1147

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "mailaddress": "string",
  • "last_name": "string",
  • "first_name": "string",
  • "kana_last_name": "string",
  • "kana_first_name": "string",
  • "employee_no": "string",
  • "sectorpost_info[]": [
    ],
  • "office_code": "string",
  • "office_name": "string",
  • "role_model_info[]": [
    ],
  • "message": "string",
  • "user_phone": "string",
  • "user_mobile_phone": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "user_id": 0,
  • "mailaddress": "string"
}

社員再招待

  • 概要：招待中の社員を再招待する際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

user_id
required
number (ユーザーID) <= 10 characters

ユーザーIDを指定する。

message
string (メッセージ) <= 400 characters

文章の改行を行う場合は\nを指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "user_id": 0,
  • "message": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "user_id": 0
}

退職

  • 概要：社員の退職を行う際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

user_id
number (ユーザーID) <= 10 characters

ユーザーIDを指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "user_id": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "user_id": 0
}

引継

  • 概要：各サービスのデータ引継依頼を行う場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

src_user_id
required
number (引継元ユーザーID) <= 10 characters

引継元社員のユーザーIDを指定する。

dst_user_id
required
number (引継先ユーザーID) <= 10 characters

引継先社員のユーザーIDを指定する。

target_flg
required
number (対象データ) <= 1 characters

引継対象データを指定する。
0:請求書
1:ワークフロー
2:契約書
3:TRADE

send_mail_flg
required
boolean (完了メール送信フラグ) <= 1 characters

引継完了メールの送信有無を指定する。
0:送信なし
1:送信あり

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "src_user_id": 0,
  • "dst_user_id": 0,
  • "target_flg": 0,
  • "send_mail_flg": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "src_user_id": 0,
  • "dst_user_id": 0,
  • "target_flg": 0,
  • "process_request_id": 0
}

引継処理一覧取得

  • 概要：引継処理の状況一覧を取得する場合に使用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

process_request_id
number (処理依頼ID) <= 10 characters

引継処理の依頼IDで絞り込む場合に指定する。
Default 指定なし

status
number (処理ステータス) <= 1 characters

引継処理のステータスで絞り込む場合に指定する。
Default 指定なし
1：処理待ち
2：処理中
3：完了
4：処理中止
5：エラー終了
6：一部エラー
7：データなし

search_start_position
number (検索開始位置) <= 4 characters

検索結果一覧の取得開始位置を指定する。

MIN 1
MAX 9999
Default 1

select_limit
number (最大取得数) <= 3 characters

引継処理一覧の最大取得数を指定する。

MIN 1
MAX 100
Default 20

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "process_request_id": 0,
  • "status": 0,
  • "search_start_position": 0,
  • "select_limit": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "takingover_info[]": [
    ],
  • "result_num": 0
}

引継処理エラー詳細取得

  • 概要：引継処理のエラー詳細を取得する場合に使用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

process_request_id
required
number (処理依頼ID) <= 10 characters

エラー詳細を取得する処理依頼IDを指定する。

search_start_position
number (検索開始位置) <= 4 characters

検索結果一覧の取得開始位置を指定する。

MIN 1
MAX 9999
Default 1

select_limit
number (最大取得数) <= 3 characters

エラー詳細一覧の最大取得数を指定する。

MIN 1
MAX 100
Default 20

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "process_request_id": 0,
  • "search_start_position": 0,
  • "select_limit": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "process_request_id": 0,
  • "error_detail[]": [
    ],
  • "result_num": 0
}

ロック解除

  • 概要：ロック中社員のロック解除を行う際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

user_id
required
number (ユーザーID) <= 10 characters

ロック中社員のユーザーIDを指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "user_id": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "user_id": 0
}

ログイン履歴一覧取得

  • 概要：社員のログイン履歴を取得する際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

user_id
required
number (ユーザーID) <= 10 characters

取得対象のユーザーIDを指定する。

login_date_from
string (取得開始日) <= 10 characters

取得開始日で絞込みを行いたい場合に指定する。
Default 取得終了日の7日前の日付
YYYY-MM-DD形式
例）2020-06-01

login_date_to
string (取得終了日) <= 10 characters

取得終了日で絞込みを行いたい場合に指定する。
Default 現在日付
YYYY-MM-DD形式
例）2020-06-01

search_start_position
number (検索開始位置) <= 4 characters

検索結果一覧の取得開始位置を指定する。

MIN 1
MAX 9999
Default 1

select_limit
number (最大取得数) <= 3 characters

一覧情報の最大取得数を指定する。

MIN 1
MAX 100
Default 20

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "user_id": 0,
  • "login_date_from": "yyyy-MM-dd",
  • "login_date_to": "yyyy-MM-dd",
  • "search_start_position": 0,
  • "select_limit": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "login_log_info[]": [
    ],
  • "result_num": 0
}

部署マスタ登録

  • 概要：部署の登録を行う場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

required
Array of objects (部署登録情報)

登録する部署情報を指定する。
最大50件まで指定可能。
登録部署は未配置の最後尾に配置される。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "sector_create_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "sector_create_info[]": [
    ]
}

役職マスタ登録

  • 概要：役職の登録を行う場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

post_name
required
string (役職名) <= 30 characters

例）代表取締役社長
※自動で全角変換される

post_code
string (役職コード) <= 4 characters
ranking
number (序列) <= 3 characters

役職の序列番号を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "post_name": "string",
  • "post_code": "string",
  • "ranking": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "post_id": 0,
  • "post_code": "string",
  • "post_name": "string",
  • "ranking": 0
}

役職マスタ一覧取得

  • 概要：役職マスタの一覧情報を取得する際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

post_code
string (役職コード) <= 4 characters

役職コードで絞り込みを行う場合に指定する。
Default　指定なし
マスタ値の参照方法はAppendixの「役職」を参照

post_name
string (役職名) <= 30 characters

役職名で絞り込みを行う場合に指定する。
Default　指定なし
マスタ値の参照方法はAppendixの「役職」を参照

search_start_position
number (検索開始位置) <= 4 characters

検索結果一覧の取得開始位置を指定する。

MIN 1
MAX 9999
Default　1

select_limit
number (最大取得数) <= 3 characters

一覧情報の最大取得数を指定する。

MIN 1
MAX 100
Default　20

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "post_code": "string",
  • "post_name": "string",
  • "search_start_position": 0,
  • "select_limit": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "post_info[]": [
    ],
  • "result_num": 0
}

勤務地マスタ登録

  • 概要：勤務地の登録を行う場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

office_name
required
string (勤務地名) <= 30 characters

例）株式会社Ｉｎｆｏｍａｒｔ
※自動で全角変換される

office_name_kana
required
string (勤務地名（カナ）) <= 50 characters

例）カブシキガイシャインフォマート
※自動で全角変換される

office_zip_code
required
string (郵便番号) <= 8 characters

例）105-0022

office_area_code
required
string (地域コード) <= 2 characters

地域コードを指定する。
コード値の参照方法はAppendixの「地域コード」を参照

office_address1
required
string (住所１（市区町村）) <= 100 characters

例）港区海岸１丁目

office_address2
required
string (住所２（番地、建物名等）) <= 100 characters

例）2-3 汐留芝離宮ビルディング13F

office_phone
required
string (電話番号) <= 24 characters

例）03-5776-1147

office_code
string (勤務地コード) <= 15 characters
office_fax
string (FAX番号) <= 15 characters

例）03-5776-1145

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "office_name": "string",
  • "office_name_kana": "string",
  • "office_zip_code": "string",
  • "office_area_code": "string",
  • "office_address1": "string",
  • "office_address2": "string",
  • "office_phone": "string",
  • "office_code": "string",
  • "office_fax": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "office_id": 0,
  • "office_code": "string",
  • "office_name": "string",
  • "office_name_kana": "string",
  • "office_zip_code": "string",
  • "office_area_code": "string",
  • "office_area_name": "string",
  • "office_address1": "string",
  • "office_address2": "string",
  • "office_phone": "string",
  • "office_fax": "string"
}

勤務地マスタ一覧取得

  • 概要：勤務地マスタの一覧情報を取得する際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

office_code
string (勤務地コード) <= 15 characters

勤務地コードで絞り込みを行う場合に指定する。
Default 指定なし
マスタ値の参照方法はAppendixの「勤務地」を参照

office_name
string (勤務地名) <= 30 characters

勤務地名で絞り込みを行う場合に指定する。
Default 指定なし
マスタ値の参照方法はAppendixの「勤務地」を参照

office_name_kana
string (勤務地名（カナ）) <= 50 characters

勤務地名（カナ）で絞り込みを行う場合に指定する。
Default 指定なし

office_address
string (住所) <= 100 characters

住所で絞り込みを行う場合に指定する。
Default 指定なし
マスタ値の参照方法はAppendixの「勤務地」を参照

search_start_position
number (検索開始位置) <= 4 characters

検索結果一覧の取得開始位置を指定する。

MIN 1
MAX 9999
Default 1

select_limit
number (最大取得数) <= 3 characters

一覧情報の最大取得数を指定する。

MIN 1
MAX 100
Default 20

sort
number (並び順) <= 1 characters

勤務地の並び順を指定する。
0:勤務地名(昇順)
1:勤務地名(降順)
2:勤務地コード(昇順)
3:勤務地コード(降順)
Default 勤務地名(昇順)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "office_code": "string",
  • "office_name": "string",
  • "office_name_kana": "string",
  • "office_address": "string",
  • "search_start_position": 0,
  • "select_limit": 0,
  • "sort": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "office_info[]": [
    ],
  • "result_num": 0
}

ロールモデル一覧取得

  • 概要：ロールモデルを検索する際に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

role_model_code
string (権限ロールモデルコード) <= 4 characters

権限ロールモデルコードで絞り込みを行いたい場合に指定する。
Default 指定なし
マスタ値の参照方法はAppendixの「権限ロールモデルコード」を参照

role_model_name
string (権限ロールモデル名) <= 15 characters

権限ロールモデル名で絞り込みを行いたい場合に指定する。
Default 指定なし
マスタ値の参照方法はAppendixの「権限ロールモデルコード」を参照

search_start_position
number (検索開始位置) <= 4 characters

検索結果一覧のロールモデル取得開始位置を指定する。
例）検索開始位置：2、最大取得数：20の場合、検索結果一覧の21～40件目が返却される

＜取得開始位置にロールモデルが存在しない場合＞
「全ての権限」、「初期設定権限」のみ返却される

MIN 1
MAX 9999
Default 1

select_limit
number (最大取得数) <= 3 characters

ロールモデルの最大取得数を指定する。

＜検索開始位置：1 を指定、または項目を省略した場合＞
指定した最大取得数に「全ての権限」、「初期設定権限」を含めて、ロールモデルを取得する。
例）最大取得数：20 の場合、「全ての権限」、「初期設定権限」とロールモデル 18 件の計 20 件を取得。

＜検索開始位置：2 以上で指定した場合＞
「全ての権限」、「初期設定権限」と指定した最大取得数のロールモデルを取得する。
例）最大取得数：20 の場合、「全ての権限」、「初期設定権限」とロールモデル 20 件の計 22 件を取得。

MIN 1
MAX 100
Default 20

sort
number (並び順) <= 1 characters

ロールモデルの並び順を指定する。
0:ロールモデルコード(昇順)
1:ロールモデルコード(降順)
2:ロールモデル名(昇順)
3:ロールモデル名(降順)
Default ロールモデルコード(昇順)

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "role_model_code": "string",
  • "role_model_name": "string",
  • "search_start_position": 0,
  • "select_limit": 0,
  • "sort": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "role_model_info[]": [
    ],
  • "result_num": 0
}

権限個別設定取得

  • 概要：個人別設定のロールを取得する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

user_id
required
number (ユーザーID) <= 10 characters

個人別設定を取得する社員のユーザーIDを指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "user_id": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "user_id": 0,
  • "function_info[]": [
    ],
  • "service_authority_info[]": [
    ]
}

社員情報更新

  • 概要：社員情報を更新する際に利用する。案内中の社員を更新する場合は同時に招待も行う。
    ※項目に空を指定した場合は未入力として更新する。項目を省略した場合は更新対象外とする。
    ※社員情報詳細取得 API で取得した部署役職情報の取得順番に紐づけて部署役職情報を更新する。参考例をAppendixの「社員情報更新 補足」に記載する
    ※社員情報詳細取得 API で取得した権限ロールモデル情報の取得順番に紐づけて権限ロールモデル情報を更新する。参考例を補足に記載する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

user_id
required
number (ユーザーID) <= 10 characters

更新対象のユーザーIDを指定する。

mailaddress
string (メールアドレス) <= 100 characters

メールアドレスを指定する。
API実行後、直ぐに更新は行われず、指定のメールアドレス宛に本人確認のメールが送信される。
メールの案内にしたがって、変更の完了を行うとメールアドレスが更新される。
※変更の有効期限は、API実行から24時間。

last_name
string (氏名(氏)) <= 15 characters

例）田中
※自動で全角変換される

first_name
string (氏名(名)) <= 15 characters

例）太郎
※自動で全角変換される

kana_last_name
string (氏名カナ(氏)) <= 20 characters

例）タナカ
※自動で全角変換される

kana_first_name
string (氏名カナ(名)) <= 20 characters

例）タロウ
※自動で全角変換される

employee_no
string (社員コード) <= 15 characters

例）000012345

Array of objects (部署役職情報)

部署役職情報を更新する場合に指定する。
最大３件まで指定可能。

office_code
string (勤務地コード) <= 15 characters

マスタ値の参照方法はApeendixの「勤務地」を参照

office_name
string (勤務地名) <= 30 characters

マスタ値の参照方法はApeendixの「勤務地」を参照
※自動で全角変換される

Array of objects (権限ロールモデル情報)

権限ロールモデル情報を更新する場合に指定する。
最大 10 件まで指定可能。
※API 実行ユーザーに権限管理の権限がある場合のみ更新可能。
権限管理の権限がない場合は更新対象外となる。

message
string (メッセージ) <= 400 characters

文章の改行を行う場合は\nを指定する。

user_phone
string (電話番号) <= 24 characters

例）03-5776-1147

user_mobile_phone
string (携帯電話番号) <= 24 characters

例）090-5776-1147

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "user_id": 0,
  • "mailaddress": "string",
  • "last_name": "string",
  • "first_name": "string",
  • "kana_last_name": "string",
  • "kana_first_name": "string",
  • "employee_no": "string",
  • "sectorpost_info[]": [
    ],
  • "office_code": "string",
  • "office_name": "string",
  • "role_model_info[]": [
    ],
  • "message": "string",
  • "user_phone": "string",
  • "user_mobile_phone": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "user_id": 0
}

部署マスタ更新

  • 概要：予約している組織図の部署情報更新を行う場合に利用する。
    部署情報の更新を行うためには、「部署マスタ一覧取得API」→「部署マスタ更新API」を実行する必要がある。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

sector_id
required
number (部署ID) <= 10 characters

更新を行う部署IDを指定する。

sector_code
string (部署コード) <= 15 characters
sector_name
string (部署名) <= 30 characters

例）フード事業部門
※自動で全角変換される

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "sector_id": 0,
  • "sector_code": "string",
  • "sector_name": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "sector_id": 0,
  • "sector_code": "string",
  • "sector_name": "string"
}

組織マスタ設定

  • 概要：組織図の変更を予約する場合に利用する。
    組織マスタ設定を行うためには、「部署マスタ一覧取得API」→「組織マスタ設定API」を実行する必要がある。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

open_date
required
string (公開日時) <= 16 characters

変更する組織図の予約公開日時を指定する。
現在日時より1時間以上先の日時が指定可能。
YYYY-MM-DD hh24:mm 形式
例）2020-06-01 15:00

required
Array of objects (部署リスト)

部署を配置して組織図を設定する。
最大50件まで指定可能。
部署リストに設定されない部署は、変更前組織図の配置順で未配置に移動される。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "open_date": "yyyy-MM-dd HH：mm",
  • "sector_list[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "open_date": "yyyy-MM-dd HH：mm",
  • "sector_list": [
    ]
}

役職マスタ更新

  • 概要：役職の更新を行う場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

post_id
required
number (役職ID) <= 10 characters

更新を行う役職IDを指定する。

post_code
string (役職コード) <= 4 characters
post_name
string (役職名) <= 30 characters

例）代表取締役社長
※自動で全角変換される

ranking
number (序列) <= 3 characters

役職の序列番号を指定する。

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "post_id": 0,
  • "post_code": "string",
  • "post_name": "string",
  • "ranking": 0
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "post_id": 0,
  • "post_code": "string",
  • "post_name": "string",
  • "ranking": 0
}

勤務地マスタ更新

  • 概要：勤務地の更新を行う場合に利用する。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

office_id
required
number (勤務地ID) <= 10 characters

更新する勤務地IDを指定する。

office_name
required
string (勤務地名) <= 30 characters

例）株式会社Ｉｎｆｏｍａｒｔ
※自動で全角変換される

office_name_kana
required
string (勤務地名（カナ）) <= 50 characters

例）カブシキガイシャインフォマート
※自動で全角変換される

office_zip_code
required
string (郵便番号) <= 8 characters

例）105-0022

office_area_code
required
string (地域コード) <= 2 characters

地域コードを指定する。
コード値の参照方法はAppendixの「地域コード」を参照

office_address1
required
string (住所１（市区町村）) <= 100 characters

例）港区海岸１丁目

office_address2
required
string (住所２（番地、建物名等）) <= 100 characters

例）2-3 汐留芝離宮ビルディング13F

office_phone
required
string (電話番号) <= 24 characters

例）03-5776-1147

office_code
string (勤務地コード) <= 15 characters
office_fax
string (FAX番号) <= 15 characters

例）03-5776-1145

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "office_id": 0,
  • "office_name": "string",
  • "office_name_kana": "string",
  • "office_zip_code": "string",
  • "office_area_code": "string",
  • "office_address1": "string",
  • "office_address2": "string",
  • "office_phone": "string",
  • "office_code": "string",
  • "office_fax": "string"
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "office_id": 0,
  • "office_code": "string",
  • "office_name": "string",
  • "office_name_kana": "string",
  • "office_zip_code": "string",
  • "office_area_code": "string",
  • "office_area_name": "string",
  • "office_address1": "string",
  • "office_address2": "string",
  • "office_phone": "string",
  • "office_fax": "string"
}

権限個別設定更新

  • 概要：個人別設定のロール更新及び適用を行う際に利用する。
    権限個別設定を行うためには、「社員詳細取得API」、または「ロールモデル一覧取得API」、または「権限個別設定取得API」を実行して、権限ロール情報を取得し、「権限個別設定更新API」を実行する必要がある。
Request Body schema:
response_type
required
string (リクエスト種別) <= 10 characters

"json"または"xml"を指定する。

user_id
required
number (ユーザーID) <= 10 characters

更新する社員のユーザーIDを指定する。

required
Array of objects (機能情報)

ESサービス利用設定の機能情報を指定する。
マスタ値の参照方法はAppendixの「権限の状態」を参照

required
Array of objects (サービス権限情報)

サービス別利用設定の権限情報を指定する。
マスタ値の参照方法はAppendixの「権限の状態」を参照

Responses

Request samples

Content type
{
  • "response_type": "string",
  • "user_id": 0,
  • "function_info[]": [
    ],
  • "service_authority_info[]": [
    ]
}

Response samples

Content type
{
  • "request_id": "string",
  • "result": 0,
  • "error_list[]": [
    ],
  • "warn_list[]": [
    ],
  • "user_id": 0
}

Appendix

補足資料

ReleaseNote

更新日 API 内容
2022/12/14 - 初版
2023/5/31 各API
エラーコード一覧		 社員登録・招待 API
・リクエストにuser_phoneを追加
・レスポンスにuser_idを追加

社員再招待 API
・リクエスト/レスポンスのmailaddressをuser_idに変更

社員情報更新 API
・リクエストにuser_phoneを追加
・リクエスト/レスポンスのlogin_idをuser_idに変更

ロールモデル一覧 API
・レスポンスにauthority_codeを追加
・レスポンスのauthority_valueをservice_nameに変更

社員情報一覧取得 API
・レスポンスにuser_id, login_lock_flgを追加
・レスポンスのemployee_noの説明を修正

社員情報詳細取得 API
・リクエスト/レスポンスのlogin_idをuser_idに変更
・レスポンスのemployee_infoを削除
・レスポンスのemployee_noの説明を修正
・レスポンスにuser_phoneを追加

エラーコード一覧
・各APIのmailaddress, login_idからuser_idへのパラメータ変更に伴う、関連メッセージの修正
・社員登録・招待 API、社員情報更新APIにuser_phoneのエラーを追加
2023/8/21 退職API
引継API
引継処理一覧取得API
引継処理エラー詳細取得API
ロック解除API
ログイン履歴一覧取得API
部署マスタ登録API
部署マスタ更新API
組織マスタ設定API
部署マスタ一覧取得API
役職マスタ登録API
役職マスタ更新API
役職マスタ一覧取得API
勤務地マスタ登録API
勤務地マスタ更新API
勤務地マスタ一覧取得API
権限個別設定更新API
権限個別設定取得API
コード値定義
エラーコード一覧		 新規追加

コード値定義 新規追加
エラーコード一覧
・新規追加APIのエラーコード追加
2023/8/21 社員登録・招待 API
社員情報更新 API
社員情報詳細取得 API
エラーコード一覧		 社員登録・招待 API
社員情報更新 API
・リクエストにuser_mobile_phoneを追加

社員情報詳細取得 API
・レスポンスにuser_mobile_phoneを追加

エラーコード一覧
・社員登録・招待 API、社員情報更新 APIにuser_mobile_phoneのエラーコードを追加
2023/8/21 引継API
引継処理一覧取得 API
引継処理エラー詳細取得 API		 項目名、パラメータ名を変更
・依頼ID → 処理依頼ID
・request_id → process_request_id
2023/8/21 ESサービス利用設定の権限
サービス別利用設定の権限
 ページ追加
2023/8/21 エラーコード一覧 各メッセージ修正
2023/11/20 社員情報更新 API
エラーコード一覧		 社員情報更新 API
リクエストにmailaddressを追加

エラーコード一覧
社員情報更新 APIにmailaddressのエラーコードを追加
2023/11/20 ログイン履歴一覧取得API レスポンス：login_result
（ログイン詳細）の備考に以下の種別を追加
・ログイン成功(2要素認証)
・ログイン失敗(2要素認証)
・ログイン成功(バックアップコード)
・ログイン失敗(バックアップコード)
・2要素認証スキップ
2023/11/20 退職API
エラーコード一覧		 メッセージ修正
2023/11/20 引継API
エラーコード一覧		 リクエスト：target_data
レスポンス：target_data
・対象にTRADEを追加
2023/11/20 引継処理一覧取得API レスポンス：target_data
・対象にTRADEを追加