※本APIの仕様に関するお問い合わせはメールにて承っております。
AKASHIコンタクトセンターまでメールにてお問い合わせください。(宛先:akashi_cc@ak4.jp)
1 基本的な使い方
下記をエンドポイントとして、アクセストークンを付加のうえリクエストを送信することで、各APIに応じた機能がご利用できます。
※ログイン後URLのドメインを確認し、エンドポイントを指定してください。
エンドポイント | https://atnd.ak4.jp/api/cooperation |
---|---|
https://atnd-awj.ak4.jp/api/cooperation |
例:打刻情報取得API
企業ID:sample001
アクセストークン:xxxxxxxxxxxxxxxxxxxx
の場合
curl -X GET "https://atnd.ak4.jp/api/cooperation/sample001/stamps?token=xxxxxxxxxxxxxxxxxxxx&start_date=20170501&end_date=20170531"
2 機能一覧
公開APIでは下記の機能がご利用になれます。
各APIはトークンに紐づいた従業員の権限によって実行が許可または却下されます。
API機能 | 概要 |
組織作成 | 組織を新しく作成する。※組織の更新はできません。 |
---|---|
組織取得 | 指定した組織を取得する。 |
従業員新規登録・更新 | 従業員の新規登録、または情報を更新する。 |
従業員取得 | トークンに紐づく従業員、及び管理下の従業員の情報を取得する。 |
従業員退職/削除 | 従業員を退職、または削除する。 |
打刻実行 | トークンに紐づいた従業員の打刻処理を行う。 |
打刻情報取得 | 自身、及び管理下の従業員の特定期間の打刻情報を取得する。 |
アラート情報取得 | トークンに紐づいた従業員のアラートを取得する。 |
アクセストークン再発行 | アクセストークンを再発行する。 |
打刻情報取得(複数従業員) | 管理下の複数人の従業員の特定期間の打刻情報を取得する。 |
勤務実績取得(複数従業員) | 管理下の複数人の従業員の特定期間の勤務実績情報を取得する。 |
個別就業設定 | 従業員の個別就業設定を設定する。 |
異動日を指定した異動 | 異動日を指定して組織/雇用区分の異動を行う。 |
権限と管理先指定 | 管理権限設定の指定と管理先の指定を行う。 |
権限と管理先予約 | 管理権限設定の指定と管理先の指定を予約する。 |
3 準備
AKASHIの公開APIご利用にあたり、下記手順を事前に行う必要があります。
- AKASHIの利用申し込み
AKASHIサービスサイト(https://ak4.jp)よりご利用申し込みをします。 - API利用を可能にする設定
従業員設定の「変更」メニュー内、利用機能設定にて「公開API利用可否」を「利用する」に設定します。 - アクセストークンの発行
マイページからAPIトークンを発行します
4 制限事項
AKASHIの公開APIは下記の仕様/制限がございます
- 各APIはアクセストークン保持者の権限に応じて利用可否が決定されます。
- アクセストークンについて
- アクセストークンの有効期限は1ヶ月と1日です。
- アクセストークンの再発行はマイページ、またはアクセストークン再発行APIをご利用ください。
- 機種依存文字として以下の2つのグループを定義しています。
各機能の入力制限にて機種依存文字(1), 機種依存文字(2)として記載します。- 機種依存文字(1)
- 機種依存文字(2)
- 機種依存文字(1)
5 API共通仕様
5.1 共通仕様
API共通の仕様を記載します。ただし、全APIで同一の仕様となるわけではなく、異なる部分は各APIの説明をご確認ください。
5.1.1 処理成否
APIの処理成否のレスポンスはJSONとし、形式は以下の通り。
(1)成功時
項目名 | データ型 | 概要 |
success | Boolean | 取得の成功失敗を示します。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果を格納する。内部の値は各APIにて定義する。 |
(2)失敗時
項目名 | データ型 | 概要 |
success | Boolean | 取得の成功失敗を示します。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
errors | Array | エラーメッセージの配列 |
code | String | エラーコード |
message | String | エラーメッセージ |
5.1.2 値が無い場合のレスポンス形式
各データ型において値が無い場合のレスポンス形式は、以下の通りです。
データ型 | 値 | 備考 |
String | null | |
---|---|---|
Integer | null | |
Boolean | - | 必ずtrue/falseが設定される。 |
Array | [] | |
Object | null | ※処理成否におけるresponse,errorsは例外とする |
6 API機能詳細
6.1 組織作成API 一覧に戻る
6.1.1 機能定義
組織情報を新規作成する。※更新はできません
6.1.2 API定義
(1) リクエスト
URL・メソッド
URL | /[AKASHI企業ID]/organizations |
---|---|
メソッド | POST |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
AKASHI企業ID | ○ | String | AKASHI企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
組織(organizations) | ○ | Array | 生成する組織を配列で指定 |
組織名(name) | ○ | String | 組織の名称 種別:UTF-8 かつ 機種依存文字(1)と/を含まない 文字列長:最大32文字 |
組織名・英語(name_en) | String | 組織の名称 種別:UTF-8 かつ 機種依存文字(1)と/を含まない 文字列長:最大64文字 |
|
組織コード(code) | String | 組織コード 種別:a~zA~Z0~9と-のみ 文字列長:最大32文字 |
|
親組織(parent_organization) | String | 生成する組織が所属する親組織。最上位("企業"を含まない)の親組織から/区切りで記述する 種別:UTF-8 かつ 機種依存文字(1)を含まない |
(2) リクエスト例
POST /api/cooperation/[AKASHI企業ID]/organizations {"token": "xxxxxxxxxxxxxxxx", "organizations": [ {"name": "第一事業本部", "code": "001", "parent_organization": ""}, {"name": "営業部", "code": "0011", "parent_organization": "第一事業本部"}, {"name": "一課", "code": "00111", "parent_organization": "第一事業本部/営業部"}, ] }
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト |
count | Integer | 新規作成された組織の件数 |
organizations | Array | 取得された組織の配列 |
organizationId | Integer | 組織のID |
name | String | 組織名 |
code | String | 組織コード |
label | String | 組織のラベル |
parentId | Integer | 親の組織id |
displayPunchTypes | Array | 表示する打刻ボタンの配列 |
punchType | Integer | 打刻種別 |
displayName | String | 表示名 |
errors | Array | 失敗の原因となったエラーについてのエラーメッセージの配列 |
code | String | エラーコード |
messages | String | エラーメッセージ |
(4) レスポンス例
{ "success": true, "response": { "count": 2, "organizations": [ { "organizationId": 1, "name": "第一事業本部", "code": "001", "label": "", "parentId": 0, "displayPunchTypes": [ {"punchType": 1, displayName: "出社"}, {"punchType": 2, displayName: "退社"} ], }, { "organizationId": 2, "name": "営業部", "code": "0011", "label": "", "parentId": 1, "displayPunchTypes": [ {"punchType": 11, displayName: "出社"}, {"punchType": 12, displayName: "退社"} ], } { "organizationId": 3, "name": "一課", "code": "00111", "label": "", "parentId": 2, "displayPunchTypes": [ {"punchType": 11, displayName: "出社"}, {"punchType": 12, displayName: "退社"} ], } ] } }
6.2 組織取得API 一覧に戻る
6.2.1 機能定義
組織の一覧を取得します。直系親取得有無が「有」で指定されている場合は、指定された組織と、その組織の親("企業"まで辿る)・子孫となる組織の一覧を取得する。
6.2.2 API定義
(1) リクエスト
URL・メソッド
URL | /[AKASHI企業ID]/organizations |
---|---|
メソッド | GET |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
AKASHI企業ID | ○ | String | AKASHI企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
直系親取得有無 (includesParents) |
○ | Integer | 直系の親組織も取得対象と含める場合は1,含めない場合は0。 |
組織id(orgId) | Integer | 指定された場合、直系親取得有無に関わらず、その組織の情報のみ取得する。 |
(2) リクエスト例
GET /api/cooperation/[AKASHI企業ID]/organizations?token=xxxxxxxxxxxxxxxxxxxx&includesParents=1
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 組織の取得の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 取得結果のオブジェクト |
count | Integer | 取得された組織の件数 |
organizations | Array | 取得された組織の配列 |
organizationId | Integer | 組織のID |
name | String | 組織名 |
code | String | 組織コード |
label | String | 組織のラベル |
parentId | Integer | 親の組織id |
displayPunchTypes | Array | 表示する打刻ボタンの配列 |
punchType | Integer | 打刻種別 |
displayName | String | 表示名 |
errors | Array | 失敗の原因となったエラーについてのエラーメッセージの配列 |
code | String | エラーコード |
message | String | エラーメッセージ |
(4) レスポンス例
{ "success": true, "response": { "count": 1, "organizations": [ { "organizationId": 1, "name": "企業", "code": null, "label": null, "parentId": null, "displayPunchTypes": [ {"punchType": 1, displayName: "出社"}, {"punchType": 2, displayName: "退社"} ], },{ "organizationId": 2, "name": "営業部", "code": "A", "label":"A", "parentId": 1, "displayPunchTypes": […], },{ "organizationId": 4, "name": "営業一課", "code": "A-1", "label":"A-1", "parentId": 2, "displayPunchTypes": […], },{ "organizationId": 3, "name": "総務部", "code": "B", "label":"B", "parentId": 1, "displayPunchTypes": […], } ] } }
6.3 従業員 新規登録・更新API 一覧に戻る
6.3.1 機能定義
従業員情報を更新します。
6.3.2 API定義
(1) リクエスト
URL・メソッド
URL | /[AKASHI企業ID]/staffs/ |
---|---|
メソッド | PATCH |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
AKASHI企業ID | ○ | String | AKASHI企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
従業員(staffs) | ○ | Array | |
従業員id(staff_id) | Integer | AKASHIの従業員id。指定されている場合は更新、未指定の場合は新規登録する。※1 | |
従業員番号(staff_code) | String | 重複不可 種別:a~z, A~Z, 0~9, -, _のみ 文字列長:最大20文字 |
|
姓(last_name) | ○ | String | 種別:機種依存文字(2)を含まない 文字列長:最大30文字 |
名(first_name) | ○ | String | 種別:機種依存文字(2)を含まない 文字列長:最大30文字 |
姓・英語(last_name_en) | String | 種別:機種依存文字(2)を含まない 文字列長:最大30文字 |
|
名・英語(first_name_en) | String | 種別:機種依存文字(2)を含まない 文字列長:最大30文字 |
|
姓(カナ)(last_name_kana) | String | 種別:全角カタカナと0123456789() 。「」、・゛゜ー] のみ 文字列長:最大30文字 |
|
名(カナ)(first_name_kana) | String | 種別:全角カタカナと0123456789() 。「」、・゛゜ー] のみ 文字列長:最大30文字 |
|
組織(organization) | △ | String | 登録済組織を最上位("企業")の親組織から/区切りで記述する。※1※2△:従業員作成の場合必須。 |
雇用区分 (employment_category) |
String | 登録済雇用区分名称※1 | |
IDm番号(idm_number) | String | 重複不可 種別:0~9a~fA~Fのみ 文字列長:16文字 |
|
メールアドレス(email) | String | 重複不可 メールアドレスとして有効な文字列 |
|
電話番号(tel) | String | 種別:0~9-のみ 文字列長:最大13文字 |
|
性別(sex) | String | 男/女 | |
タグ(tag) | String | 複数の場合カンマ区切り 種別:UTF-8 かつ 機種依存文字(1)を含まない 文字列長:最大255文字 |
|
備考(remarks) | String | 種別:UTF-8 かつ 機種依存文字(1)を含まない 文字列長:最大5,000文字 |
|
入社日(entry_date) | Date | YYYY/MM/DD形式の日付 | |
利用開始日(use_start_date) | Date | YYYY/MM/DD形式の日付 | |
年休基準日(paid_holiday_base_date) | Date | YYYY/MM/DD形式の日付 | |
認証連携以外でログインしない(use_other_login_method) | Boolean | true/false。Boolean型以外を指定した場合はtrueと判断される |
※1:該当するデータがない場合、エラーとなる。
※2:最上位の所属にしたい場合は「企業」を指定する
最上位の「企業」は下位組織がある場合は記載しない
(2) リクエスト例
POST /api/cooperation/[AKASHI企業ID]/staffs/ {"token": "xxxxxxxxxxxxxxxx", "staffs": [ {"staff_id": 1, "last_name": "山田", "first_name": "太郎", "organization": "企業",・・・}, {"last_name": "佐藤", "first_name": "花子", "organization": "営業部/営業1課",・・・} ] }
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト。 |
login_company_code | String | AKASHI企業ID |
staffs | Array | 従業員の配列 |
staff_id | Integer | 従業員Id |
staff_code | String | 従業員番号 |
String | メールアドレス | |
organization_id | Integer | 組織のid |
employment_category_id | Integer | 雇用区分のid |
errors | Array | エラーメッセージの配列 |
code | String | エラーコード |
staff_id | String | 従業員id。従業員更新の場合のみ。 |
name | String | リクエストの姓+名。 |
message | String | エラーメッセージ |
(4) レスポンス例
{ "success":true, "response": { "login_company_code": "com123", "staffs ": [ { "staff_id": 123 "staff_code": "s001", "email": "sample@example.com" "organization_id": 1, "employment_category_id": 1 }, {・・・} ] }, "errors": [ {"code":" ERR300402","staff_id": "1", name: "山田太郎", "message":"組織が存在しません。"}, {"code":" ERR300402","staff_id": "1", name: "山田太郎", "message":"従業員番号が既に登録されています。"}, {"code":" ERR300402","staff_id": "", name: "山田太郎", "message": "組織が存在しません。"}, {"code":" ERR300402","staff_id": "", name: "", "message": "姓は必ず入力してください。"} ] }
6.4 従業員取得API 一覧に戻る
6.4.1 機能定義
トークンに該当する従業員、及び管理下の従業員の情報を取得する。
6.4.3 API 定義
(1) リクエスト
URL・メソッド
URL | /[AKASHI企業ID]/staffs/[従業員id] |
---|---|
メソッド | GET |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
AKASHI企業ID | ○ | String | AKASHI企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
取得従業員(target) | String | 取得する従業員のトークン | |
従業員id | Integer | 取得対象の従業員id (従業員番号ではありません) |
|
ページ番号(page) | Integer | 管理下にある従業員をすべて取得する場合のページ位置 ※1ページに取得できるのは20人分までとなります ※レスポンスに記載されるTotalCountを参考に0から始まるページを指定してください。 |
(2) リクエスト例
トークンを指定して、特定の従業員情報を取得する場合
GET /api/cooperation/[AKASHI企業ID]/staffs?token=xxxxxxxxxxxxxxxxxxxxxxxx&target=yyyyyyyyyyyyyyyyyyyyyyyyy
従業員idを指定して、特定の従業員情報を取得する場合
GET /api/cooperation/[AKASHI企業ID]/staffs/21?token=xxxxxxxxxxxxxxxxxxxxxxxx
管理下の従業員情報のうち、21人目から40人目を取得する場合
GET /api/cooperation/[AKASHI企業ID]/staffs?token=xxxxxxxxxxxxxxxxxxxxxxxx&page=1
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト |
login_company_code | String | AKASHI企業ID |
Count | Integer | 取得された従業員数 |
TotalCount | Integer | 取得することができる従業員数 |
staffs | Array | 取得した従業員情報の配列 |
staffId | Integer | 従業員id |
lastName | String | 姓 |
firstName | String | 名 |
lastNameKana | String | カナ(姓) |
firstNameKana | String | カナ(名) |
organization | Object | 組織(メイン) |
organizationId | Integer | 組織id |
name | String | 組織名 |
subgroups | Array | 組織(サブグループ)の配列 |
organizationId | Integer | 組織id |
name | String | 組織名 |
employmentCategory | Object | 雇用区分 |
employmentCategoryId | Integer | 雇用区分ID(雇用区分"従業員"の場合はnull) |
name | String | 雇用区分名称(雇用区分"従業員"の場合は"従業員") |
tag | String | タグ |
staffNum | String | 従業員番号 |
idmNum | String | IDm番号 |
cardTypeId | Integer | カード種別 |
remarks | String | 備考 |
permissionGroup | Object | 権限グループ |
permissionGroupId | Integer | 権限グループID |
permissionType | Integer | 権限種別(1: 企業管理者、2: 一般管理者、3:従業員) |
name | String | 権限グループ名 |
managedOrganizations | Array | 管理対象組織(指定されている組織のみ。配下の組織は含めない) |
organizationId | Integer | 組織id |
name | String | 組織名 |
errors | Array | 失敗の原因となったエラーについてのエラーメッセージの配列 |
code | String | エラーコード |
message | String | エラーメッセージ |
(4) レスポンス例
{ "success": true, "response": { "login_company_code": 1, "Count": 1, "totalCount": 1, "staffs": [ "staffId": 456, "lastName": "児玉", "firstName": "太郎", "lastNameKana": "コダマ", "firstNameKana": "タロウ", "organization": {"organizationId": 1, "name": "営業部"}, "subgroups": [ {"organizationId": 2, "name": "開発部"} ], employmentCategory: { "employmentCategoryId": 1, "name": "正社員" }, "tag": null, "staffNum": "2015000012", "idmNum": null, "cardTypeId": null, "remarks": "備考欄の記述", "permissionGroup": { "permissionGroupId": 456, "permissionType": 2, "name": "一般管理者" }, "managedOrganizations": [{ "organizationId": 456, "name": "総務部" }] ] } }
6.5 従業員退職削除API 一覧に戻る
6.5.1 機能定義
従業員を退職または削除します。
6.5.2 API定義
(1) リクエスト
URL・メソッド
URL | /[AKASHI企業ID]/staff/[従業員id] |
---|---|
メソッド | DELETE |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
AKASHI企業ID | ○ | String | AKASHI企業ID |
---|---|---|---|
従業員id | ○ | Integer | AKASHIの従業員ID |
トークン(token) | ○ | String | アクセストークン |
退職日(retirement_date) | Date | 退職日:指定されている場合→退職処理 未指定の場合→削除処理 形式:YYYY/MM/DD |
(2) リクエスト例
DELETE /api/cooperation/[AKASHI企業ID]/staff/[従業員id]/ {"token": "xxxxxxxxxxxxxxxx", "retirement_date": "2017/03/31"}
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト。 |
login_company_code | String | AKASHI企業ID |
staff_id | Integer | 従業員id |
staff_code | String | 従業員番号 |
String | メールアドレス | |
errors | Array | エラーメッセージの配列 |
code | String | エラーコード |
message | String | エラーメッセージ |
(4) レスポンス例
{ "success":true, "response": { "login_company_code": "sample001", "staff_id": 123 "staff_code": "s001", "email": "sample@example.com" } }
6.6 打刻API 一覧に戻る
6.6.1 機能定義
従業員の打刻処理を行う。
6.6.2 API 定義
(1) リクエスト
URL・メソッド
URL | /[AKASHI企業ID]/stamps |
---|---|
メソッド | POST |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
AKASHI企業ID | ○ | String | AKASHI企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
打刻種別(type) | Integer | 打刻種別 11 : 出勤 12 : 退勤 21 : 直行 22 : 直帰 31 : 休憩入 32 : 休憩戻 省略された場合、打刻履歴を元に出勤または退勤の打刻種別が決定する |
|
打刻日時(stampedAt) | DateTime | クライアントでの打刻日時 ※実際の打刻はAKASHIの打刻サーバ側の時刻となります。 形式:YYYY/MM/DD HH:MM:SS |
|
タイムゾーン(timezone) | String | クライアントのタイムゾーンを+09:00の形の文字列で指定 |
(2) リクエスト例
POST /api/cooperation/[AKASHI企業ID]/stamps {"token": "xxxxxxxxxxxxxxxx", "type": 11, "stampedAt": "2017/03/14 08:57:23", "timezone": "+09:00" }
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト。 |
login_company_code | String | AKASHI企業ID |
staff_id | Integer | 従業員id |
type | Integer | 打刻種別 |
stampedAt | DateTime | サーバ側での打刻日時を返す。 |
errors | Array | エラーメッセージの配列 |
code | String | エラーコード |
message | String | エラーメッセージ |
(4) レスポンス例
{ "success":true, "response": { "login_company_code": "sample001", "staff_id": 123 "type": 11, "stampedAt": "2017/03/14 08:57:00" } }
6.7 打刻情報取得API 一覧に戻る
6.7.1 機能定義
自身、及び管理下の従業員の特定期間の打刻情報を取得する。
6.7.2 API定義
(1) リクエスト
URL・メソッド
URL | /[ログイン企業ID]/stamps/[従業員id] |
---|---|
メソッド | GET |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
ログイン企業ID | ○ | String | 企業のログイン企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
開始日時(start_date) | ○ | DateTime | 打刻取得期間の開始日時 yyyymmddHHMMSSの形式で指定する。 |
終了日時(end_date) | ○ | DateTime | 打刻取得期間の終了日時yyyymmddHHMMSSの形式で指定する。 開始日時、終了日時で指定できる最長期間は6ヶ月までとなります。 また1回のリクエストで取得できる打刻は1000件までとなります。 |
従業員id | Integer | 取得対象の従業員id (従業員番号ではありません) |
(2) リクエスト例
自身の打刻情報を取得する場合
GET /api/cooperation/[ログイン企業ID]/stamps?token=xxxxxxxxxxxxxxxxxxxx&start_date=20170501000000&end_date=20170531000000
従業員idを指定して、特定の従業員の打刻情報を取得する場合
GET /api/cooperation/[ログイン企業ID]/stamps/21?token=xxxxxxxxxxxxxxxxxxxx&start_date=20170501000000&end_date=20170531000000
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト |
login_company_code | String | ログイン企業ID |
staff_id | Integer | 従業員ID |
count | Integer | 従業員の打刻数 |
stamps | Array | 打刻データの配列 |
stamped_at | DateTime | 打刻日時 |
type | Integer | 打刻種別 |
local_time | DateTime | 打刻機のローカル打刻時刻 |
timezone | String | 打刻機のタイムゾーン |
attributes | Object | 実績参照結果 |
method | Integer | 打刻方法 |
org_id | Integer | 組織ID |
workplace_id | Integer | 勤務地ID |
latitude | Float | 緯度 |
longitude | Float | 経度 |
ip | String | 打刻機のIPアドレス |
errors | Array | 失敗の原因となったエラーメッセージの配列 |
code | String | エラーコード |
message | String | エラーメッセージ |
(4) レスポンス例
{ "success":true, "response": { "login_company_code": "sample001", "staff_id": 123, "count": 1, "stamps": [ { "stamped_at": "2015/10/22 09:01:00", "type": 11, "local_time": "2015/10/22 09:00:34", "timezone": "+9.0", "attributes": { "org_id": 12, "workplace_id":1, "ip": "192.168.1.234" } }, { "stamped_at": "2015/10/22 18:01:00", "type": 12, "local_time": "2015/10/22 18:00:34", "timezone": "+9.0", "attributes": { "org_id": 12, "workplace_id":1, "ip": "192.168.1.234" } } ] } }
6.8 アラート情報取得API 一覧に戻る
6.8.1 機能定義
トークンにて認証した従業員のアラート情報を取得します。
6.8.2 API 定義
(1) リクエスト
URL・メソッド
URL | /[AKASHI企業ID]/alerts |
---|---|
メソッド | GET |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
AKASHI企業ID | ○ | String | AKASHI企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
(2) リクエスト例
GET /api/cooperation/[AKASHI企業ID]/alerts?token=xxxxxxxxxxxxxxxxxxxx
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト |
login_company_code | String | AKASHI企業ID |
staff_id | Integer | 従業員id |
count | Integer | 取得されたアラートの件数 |
alerts | Array | 取得されたアラートの配列 |
month | String | アラートの発生した月度 |
date | String | アラートの発生した日付 |
alert_type | Integer | アラート種別 1:打刻忘れ 2:欠勤疑い 3:休憩過小/超過 4:出勤打刻乖離 5:退勤打刻乖離 6:休日出勤 7:遅刻 8:早退 9:残業時間閾値超え 10:無断出勤 |
errors | Array | 失敗の原因となったエラーについてのエラーメッセージの配列 |
code | String | エラーコード |
message | String | エラーメッセージ |
(4) レスポンス例
{ "success":true, "response": { "login_company_code": "sample001", "staff_id": 123 "count": 3, "alerts": [ {"month": "2017/03/01", "date": "2017/04/15", "alert_type": 1}, {"month": "2017/04/01", "date": "2017/04/16", "alert_type": 2}, {"month": "2017/04/01", "date": "2017/04/16", "alert_type": 6}, ] } }
6.9 アクセストークン再発行API 一覧に戻る
6.9.1 機能定義
トークンにて認証した従業員のアクセストークンを再発行します。
再発行時に有効期限切れのトークンが存在する場合、自動的に削除されます。
6.9.2 API定義
(1) リクエスト
URL・メソッド
URL | /token/reissue/[ログイン企業ID] |
---|---|
メソッド | POST |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
ログイン企業ID | ○ | String | ログイン企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
(2) リクエスト例
POST /api/cooperation/token/reissue/comp001 {"token": "xxxxxxxxxxxxxxxx"}
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト |
login_company_code | String | ログイン企業ID |
staff_id | Integer | 従業員ID |
agency_manager_id | Integer | - |
token | String | アクセストークン |
expired_at | String | アクセストークンの有効期限 (yyyy/mm/dd HH:MM:SS) |
errors | Array | 失敗の原因となったエラーメッセージの配列 |
code | String | エラーコード |
message | String | エラーメッセージ |
(4) レスポンス例
{ "success":true, "response": { "login_company_code": "sample001", "staff_id": 123, "agency_manager_id": 45, "token": "xxxxxxxxxxxxxxxxxxxxxxxx", "expired_at": "2017/10/09 00:00:00" } }
6.10 打刻情報取得API(複数従業員) 一覧に戻る
6.10.1 機能定義
自身、及び管理下の従業員の特定期間の打刻情報を取得する。
6.10.2 API定義
(1) リクエスト
URL・メソッド
URL | /[ログイン企業ID]/multiple_stamps |
---|---|
メソッド | GET |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
ログイン企業ID | ○ | String | 企業のログイン企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
開始日時(start_date) | ○ | DateTime | 打刻取得期間の開始日時 yyyymmddHHMMSSの形式で指定する。 |
終了日時(end_date) | ○ | DateTime | 打刻取得期間の終了日時yyyymmddHHMMSSの形式で指定する。 開始日時、終了日時で指定できる最長期間は1日までとなります。 また1回のリクエストで取得できる打刻は1000件までとなります。 |
従業員id(staff_ids) | ○ | Integer | 取得対象の従業員id(従業員番号ではありません)をコンマ区切りで並べたもの(最大50人) |
(2) リクエスト例
GET /api/cooperation/[ログイン企業ID]/multiple_stamps?token=xxxxxxxxxxxxxxxxxxxx&start_date=20170501000000&end_date=20170531000000&staff_ids=1,2,3,4
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト |
login_company_code | String | ログイン企業ID |
multiple_stamps | Array | 従業員ごとの打刻情報の配列 |
staff_id | Integer | 取得した打刻に紐づく従業員のid |
count | Integer | 従業員の打刻数 |
stamps | Array | 打刻データの配列 |
stamped_at | DateTime | 打刻日時 |
type | Integer | 打刻種別 |
local_time | DateTime | 打刻機のローカル打刻時刻 |
timezone | String | 打刻機のタイムゾーン |
attributes | Object | 実績参照結果 |
method | Integer | 打刻方法 |
org_id | Integer | 組織ID |
workplace_id | Integer | 勤務地ID |
latitude | Float | 緯度 |
longitude | Float | 経度 |
ip | String | 打刻機のIPアドレス |
errors | Array | 失敗の原因となったエラーメッセージの配列 |
code | String | エラーコード |
message | String | エラーメッセージ |
(4) レスポンス例
{ "success": true, "response": { "login_company_code": "R20180404", "multiple_stamps": [ { "staff_id": 1, "count": 4, "stamps": [ { "stamped_at": "2018/10/16 09:58:08", "type": 11, "local_time": "2018/10/16 09:58:10", "timezone": "+9.00", "attributes": { "method": 3, "org_id": 1, "workplace_id": null, "latitude": null, "longitude": null, "ip": "192.168.56.1" } } ] } ] } }
6.11 勤務実績取得API(複数従業員) 一覧に戻る
6.11.1 機能定義
自身、及び管理下の従業員の特定期間の実績情報を取得する。
6.11.2 API定義
(1) リクエスト
URL・メソッド
URL | /[ログイン企業ID]/working_records |
---|---|
メソッド | GET |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
ログイン企業ID | ○ | String | 企業のログイン企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
開始日時(start_date) | ○ | DateTime | 実績取得期間の開始日時 yyyymmddの形式で指定する。 |
終了日時(end_date) | DateTime | yyyymmddの形式で指定する。期間は最大31日である。 | |
従業員id(staff_ids) | ○ | Integer | 取得対象の従業員id(従業員番号ではありません)をコンマ区切りで並べたもの。一度に指定できるのは50idまでとなる。 |
休憩実績の取得を行うかどうか(include_break_results) | Integer | 1を指定した場合、取得する勤務実績に休憩実績を含める。この場合、end_dateを指定することはできない。 | |
実働時間(まるめなし)の取得を行うかどうか(include_actual_working_hours_no_rounding) | Integer | 1を指定した場合、取得する勤務実績に実働時間(まるめなし)を含める。 |
(2) リクエスト例
GET /api/cooperation/[ログイン企業ID]/working_records?token=xxxxxxxxxxxxxxxxxxxx&start_date=20180903&end_date=20180930&staff_ids=1,2,3,4
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト |
login_company_code | String | ログイン企業ID |
response | Array | 従業員ごとの勤務実績情報の配列 |
staff_id | Integer | 取得した打刻に紐づく従業員のid |
working_records | Array | 実績データの配列 |
date | String | yyyy/mm/dd形式の日付 |
working_day_category | Integer | 労働区分 0:労働日 1:所定休日 2:法定休日 |
start_time | DateTime | 実績開始時刻 |
end_time | DateTime | 実績終了時刻 |
rounded_start_time | DateTime | 丸め実績開始時刻 |
rounded_end_time | DateTime | 丸め実績終了時刻 |
attendance_punch_time | DateTime | 出勤打刻時刻 |
leaving_punch_time | DateTime | 退勤打刻時刻 |
actual_working_hours_no_rounding | Integer | 実働時間(まるめなし)分単位 |
break_time_results | Array | 休憩実績の配列 |
result_break_time_start_time | DateTime | 休憩開始時刻 |
result_break_time_end_time | DateTime | 休憩終了時刻 |
rounded_break_time_start_time | DateTime | 丸め休憩開始時刻 |
rounded_break_time_end_time | DateTime | 丸め休憩終了時刻 |
errors | Array | 失敗の原因となったエラーメッセージの配列 |
code | String | エラーコード |
message | String | エラーメッセージ |
(4) レスポンス例
{ "success": true, "response": [ { "staff_id": 1, "working_records": [ { "date": "2018/09/03", "working_day_category": 0, "start_time": "2018/09/03 09:00:00", "end_time": "2018/09/03 22:00:00", "rounded_start_time": "2018/09/03 09:00:00", "rounded_end_time": "2018/09/03 22:00:00", "start_punch_time": null, "end_punch_time": null, "actual_working_hours_no_rounding":480, "break_time_results": [ { "result_break_time_start_time": "2018/09/03 12:00:00", "result_break_time_end_time": "2018/09/03 13:00:00", "rounded_break_time_start_time": "2018/09/03 12:00:00", "rounded_break_time_end_time": "2018/09/03 13:00:00" } ] } ] } ] }
6.12 個別就業設定API 一覧に戻る
6.12.1 機能定義
個別就業設定を更新する。
6.12.2 API定義
(1) リクエスト
URL・メソッド
URL | /[ログイン企業ID]/working_condition_settings |
---|---|
メソッド | PATCH |
パラメータ
(2) -1リクエスト例
POST /api/cooperation/[ログイン企業ID]/working_condition_settings
{
"token": "【発行したトークン】",
"working_condition_settings": [
{"staff_code":"s001", "effective_date":"2023/02/02", "recount_method":"実績基準", "working_category":"普通労働制", "fixed_working_time":"08:30", "weekly_working_days":"予定時刻設定の労働日数を用いる", "rest_period":"利用しない", "handling_of_leaving_punch":"当日の退勤打刻として扱う", "holiday_working_minutes_type":"予定時刻に合わせる", "morning_holiday_working_minutes":"04:10", "afternoon_holiday_working_minutes":"04:20", "calculation_of_time_over_the_reference_time":"基準時刻を越えた時間を算出しない", "early_or_late_judgement_time_with_half_holiday":"利用しない", "outside_workplace_type":"予定時刻に合わせる", "behavior_of_directly_punch":"予定内の直行/直帰打刻は予定の時刻が実績時刻に入る", "use_fixed_overtime":"OFF", "overtime_basis":"所定時間外", "use_cut_overtime_to_start_time":"OFF", "use_cut_overtime_to_end_time":"OFF", "display_alert_shift_create":"利用する", "standard_working_hours":"実働時間", "allowed_minus":"許容する", "time_frame_aggregation_flg":"OFF", "time_frame_aggregation_agreement":"未同意", "night_work_limited":"制限しない", "work_interval":"制限しない", "limited_weekly_28hours":"制限しない", "max_continuous_working_days_per_month":"6", "max_working_minutes_per_month":"187:00/170:00/187:00/178:30/187:00/178:30/187:00/187:00/178:30/187:00/178:30/187:00", "monthly_scheduled_holidays":"5/5/5/5/5/5/5/5/5/5/5/5" }
]
}
(2)-2 リクエスト例(裁量労働制)
POST /api/cooperation/[ログイン企業ID]/working_condition_settings
{
"token": "【発行したトークン】",
"working_condition_settings": [
{"staff_code":"s001","working_condition_template_name":"","effective_date":"","recount_method":"再集計しない","working_category":"裁量労働制","fixed_working_time":"8:00","weekly_working_days":"予定時刻設定の労働日数を用いる","plan_start_and_end_time_sun":"","plan_start_and_end_time_mon":"09:00-18:00","plan_start_and_end_time_tue":"09:00-18:00","plan_start_and_end_time_wed":"09:00-18:00","plan_start_and_end_time_thu":"09:00-18:00","plan_start_and_end_time_fri":"09:00-18:00","plan_start_and_end_time_sat":"09:00-18:00","plan_start_and_end_time_hol":"09:00-18:00","plan_break_start_and_end_time_sun":"","plan_break_start_and_end_time_mon":"12:00-13:00","plan_break_start_and_end_time_tue":"12:00-13:00","plan_break_start_and_end_time_wed":"12:00-13:00","plan_break_start_and_end_time_thu":"12:00-13:00","plan_break_start_and_end_time_fri":"12:00-13:00","plan_break_start_and_end_time_sat":"12:00-13:00","plan_break_start_and_end_time_hol":"12:00-13:00","rest_period":"利用しない","handling_of_leaving_punch":"当日の退勤打刻として扱う","holiday_working_minutes_type":"予定時刻に合わせる", "morning_holiday_working_minutes":"4:00","afternoon_holiday_working_minutes":"4:00","calculation_of_time_over_the_reference_time":"基準時刻を越えた時間を算出する","reference_start_time":"9:00","reference_end_time":"18:00","early_or_late_judgement_time_with_half_holiday":"利用しない","late_judgement_time_with_morning_off":"14:00","early_judgement_time_with_afternoon_off":"12:00","outside_workplace_type":"予定時刻に合わせる","behavior_of_directly_punch":"予定内の直行/直帰打刻は予定の時刻が実績時刻に入る","use_fixed_overtime":"OFF","display_early_or_late_on_summaries":"ON","display_midnight_workings_on_summaries":"ON","deemed_working_time":"8:00","use_deemed_working_minutes_for_working_minutes_on_fixed_holiday":"用いる","working_category_editable":"入力不可","substituted_working_holiday_editable":"入力不可","overtimes_editable":"入力不可","plan_times_editable":"入力不可","result_times_editable":"入力不可","result_breaks_editable":"入力不可","going_out_for_personal_purposes_editable":"入力不可","result_times_on_vacation_editable":"入力不可","punch_on_vacation_enabled":"打刻不可","ampm_holidays_usable":"取得不可","estimated_times_editable":"入力不可","display_alert_shift_create":"利用する","night_work_limited":"制限しない","work_interval":"制限しない","limited_weekly_28hours":"制限しない","max_continuous_working_days_per_month":"6", "max_working_minutes_per_month":"176:00/160:00/176:00/168:00/176:00/168:00/176:00/176:00/168:00/176:00/168:00/176:00","monthly_scheduled_holidays":"4/4/4/4/4/4/4/4/4/4/4/4","standard_working_hours":"実働時間","allowed_minus":"許容する","time_frame_aggregation_flg":"ON","time_frame_aggregation_agreement":"未同意","time_frame_aggregation_items":""
}
]
}
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト。 |
login_company_code | String | AKASHI企業ID |
staffs | Array | 従業員の配列 |
staff_id | Integer | 従業員Id |
staff_code | String | 従業員番号 |
String | メールアドレス | |
errors | Array | エラーメッセージの配列 |
code | String | エラーコード |
staff_code | String | 従業員番号 |
String | メールアドレス | |
message | String | エラーメッセージ |
(4) レスポンス例
{ "success": true, "response": { "login_company_code": "test001", "staffs": [ { "staff_id": 51, "staff_code": "i001", "email": null } ] } } { "success": false, "errors": [ { "code": "ERR302205", "staff_code": "i001", "email": null, "message": "個別就業テンプレートが存在しません。" } ] }
6.13 異動日を指定した異動API 一覧に戻る
6.13.1 機能定義
異動日を指定して従業員を異動させる。
6.13.2 API定義
(1) リクエスト
URL・メソッド
URL | /[ログイン企業ID]/importer_factory/organizations |
---|---|
メソッド | POST |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
ログイン企業ID | ○ | String | 企業のログイン企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
異動日(organization_change_date) | ○ | Date | 日付 yyyy/mm/dd |
異動日以降の異動を削除する(is_delete_change_history_after_change_date) | String | Yes/No または 空欄。空欄または列がない場合はNoとみなす。 | |
異動先所属組織(new_organization_path) | String | ||
異動先所属組織コード(new_organization_code) | String | ||
サブ組織(sub_organization_path) | String | 複数指定する場合は末尾に数字が必要 例)sub_organization_path2 |
|
サブ組織コード(sub_organization_code) | String | 複数指定する場合は末尾に数字が必要 例)sub_organization_code2 |
|
雇用区分(employment_category) | ○ | String |
(2) リクエスト例
POST /api/cooperation/[ログイン企業ID]/importer_factory/organizations
{
"token": "【発行したトークン】",
"organizations": [
{"staff_code": "s001", "organization_change_date": "2023/2/1", "is_delete_change_history_after_change_date": "YES", "new_organization_path": "組織A", "employment_category": "正社員", "sub_organization_code": "org002"},
{"staff_email": "s002@example.com", "organization_change_date": "2023/2/2", "is_delete_change_history_after_change_date": "NO", "employment_category": "正社員", "new_organization_code": "org002", "sub_organization_path": "組織A"}
]
}
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト。 |
login_company_code | String | AKASHI企業ID |
staffs | Array | 従業員の配列 |
staff_id | Integer | 従業員Id |
staff_code | String | 従業員番号 |
String | メールアドレス | |
errors | Array | エラーメッセージの配列 |
code | String | エラーコード |
target | String | 対象の従業員idまたはメールアドレス |
message | String | エラーメッセージ |
(4) レスポンス例
{"success":true,"response":{"login_company_code":"test001","staffs":[{"staff_id":51,"staff_code":"i001","email":null}]}} {"success":false,"errors":[{"code":"ERR302102","target":"s002@example.com","message":"指定された従業員が見つかりません。(従業員番号: (空白), メールアドレス: s002@example.com)"}]}
6.14 権限と管理先指定API 一覧に戻る
6.14.1 機能定義
管理権限設定の指定と管理先の指定を行う。
6.14.2 API定義
(1) リクエスト
URL・メソッド
URL | /[ログイン企業ID]/importer_factory/permissions |
---|---|
メソッド | PATCH |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
ログイン企業ID | ○ | String | 企業のログイン企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
管理先組織(manage_organization_path) | ○ | String | 複数指定する場合は末尾に数字が必要 例)manage_organization_path2 |
管理先組織コード(manage_organization_code | ○ | String | 複数指定する場合は末尾に数字が必要 例)manage_organization_code2 |
下位組織の管理(即時反映・パス)(manage_subordinate_organizations_immed_path) | String | 「下位組織を管理対象にしない」「下位組織を直接管理対象とする」「サブ組織所属を除く+直下組織管理者を直接管理する」 | |
下位組織の管理(即時反映・コード)(manage_subordinate_organizations_immed_code) | String | 「下位組織を管理対象にしない」「下位組織を直接管理対象とする」「サブ組織所属を除く+直下組織管理者を直接管理する」 | |
管理対象従業員番号(managed_staff_code) | String | 複数指定する場合は末尾に数字が必要 例)managed_staff_code2 |
(2) リクエスト例
POST /api/cooperation/[ログイン企業ID]/importer_factory/permissions
{
"token": "【発行したトークン】",
"permissions": [
{"staff_code":"s001", "manager_permission_name":"管理権限-編集", "manage_organization_path":"組織1", "manage_organization_code":"org002", "managed_staff_code1":"s002", "managed_staff_code2":"s003"}
]
}
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト。 |
login_company_code | String | AKASHI企業ID |
staffs | Array | 従業員の配列 |
staff_id | Integer | 従業員Id |
staff_code | String | 従業員番号 |
String | メールアドレス | |
errors | Array | エラーメッセージの配列 |
code | String | エラーコード |
target | String | 対象の従業員idまたはメールアドレス |
message | String | エラーメッセージ |
(4) レスポンス例
{ ""success"": true, ""response"": { ""login_company_code"": ""test001"", ""staffs"": [ { ""staff_id"": 51, ""staff_code"": ""i001"", ""email"": null } ] } } { ""success"": false, ""errors"": [ { ""code"": ""ERR302102"", ""target"": ""i001"", ""message"": ""管理権限「aaaaa」は登録されていません。"" } ] }
6.15 権限と管理先予約API 一覧に戻る
6.15.1 機能定義
管理権限設定の指定と管理先の指定を予約する。
6.15.2 API定義
(1) リクエスト
URL・メソッド
URL | /[ログイン企業ID]/importer_factory/permissions_reserve |
---|---|
メソッド | POST |
パラメータ
パラメータ | 必須 | データ型 | 概要 |
ログイン企業ID | ○ | String | 企業のログイン企業ID |
---|---|---|---|
トークン(token) | ○ | String | アクセストークン |
予約管理先組織(reservation_manage_organization_path) | △ | String | |
予約管理先組織コード(reservation_manage_organization_code) | △ | String | |
管理先予約日(manage_organization_reservation_date) | ○ | Date | 日付 yyyy/mm/dd |
追加/削除(manage_organization_reservation_add_or_delete) |
○ | String | 追加/削除 |
登録/取消(manage_organization_reservation_registration_or_cancel) | ○ | String | 登録/取消 |
下位組織の管理(manage_subordinate_organizations) | ○ | String | 「下位組織を管理対象にしない」「下位組織を直接管理対象とする」「サブ組織所属を除く+直下組織管理者を直接管理する」 |
予約付与権限(reservation_manager_permission_name) | String | ||
付与権限予約日(manager_permission_reservation_date) | Date | 日付 yyyy/mm/dd |
(2) リクエスト例
POST /api/cooperation/[ログイン企業ID]/importer_factory/permissions_reserve
{
"token": "【発行したトークン】",
"permissions_reserve": [
{"staff_code":"s001", "manager_permission_reservation_date":"2023/2/3", "reservation_manager_permission_name":"管理権限-編集", "manage_organization_reservation_date":"2023/2/3", "reservation_manage_organization_path":"組織1", "reservation_manage_organization_code":"", "manage_subordinate_organizations":"下位組織を管理対象にしない", "manage_organization_reservation_add_or_delete":"追加", "manage_organization_reservation_registration_or_cancel":"登録"}
]
}
(3) レスポンス
項目名 | データ型 | 概要 |
success | Boolean | 処理の成功失敗を示す。成功の場合はtrue、失敗の場合はfalse。 |
---|---|---|
response | Object | 処理結果のオブジェクト。 |
login_company_code | String | AKASHI企業ID |
staffs | Array | 従業員の配列 |
staff_id | Integer | 従業員Id |
staff_code | String | 従業員番号 |
String | メールアドレス | |
errors | Array | エラーメッセージの配列 |
code | String | エラーコード |
target | String | 対象の従業員idまたはメールアドレス |
message | String | エラーメッセージ |
(4) レスポンス例
{
""success"": true,
""response"": {
""login_company_code"": ""test001"",
""staffs"": [
{
""staff_id"": 51,
""staff_code"": ""i001"",
""email"": null
}
]
}
}
{
""success"": false,
""errors"": [
{
""code"": ""ERR302102"",
""target"": ""i001"",
""message"": ""管理権限「ああああ」は登録されていません。""
}
]
}