CSVインポート一時保存API

概要

{primary} ・実習実施先の基本情報 or 技能実習生の基本情報 or 送出機関のデータのCSVインポートデータの一時保存を行います。

・一時保存データは破棄ボタンを押下することにより破棄することができます。

・実習実施先の基本情報、技能実習生の基本情報、送出機関それぞれ１つずつ一時データを保存しておくことができます。

・すでに一時保存データがある状態で再度一時保存を行うと、一時保存データが上書き保存されます。

・CSVインポートが終了するとその種別（実習実施先の基本情報or技能実習生の基本情報or送出機関）の一時保存データは破棄されます。

アクセス制御

  • 監理団体アカウントのみアクセス可能です。
  • 監理団体アカウントであれば、マスター・管理者・一般ともにアクセス可能です。

I/O情報

エンドポイント

メソッド URI Headers
POST /api/csv/{type}/temp Default

type：インポートするCSVの区分

  • type = 1 ：実習実施先 基本情報のCSVインポートを行います。
  • type = 10：技能実習生 基本情報のCSVインポートを行います。
  • type = 20：送出機関のCSVインポートを行います。

ROUTEパラメータ

パラメーター名 型 内容 特記
type int インポートファイル種類 Enum参照 
/api/csv/1/temp

POSTパラメータ

パラメーター名 型 内容 特記
original_data array インポートCSVの元データ csv_temp_storesテーブルのoriginal_dataカラムにjson形式で保存されます。
edited_data array インポートCSVの編集データ csv_temp_storesテーブルのedited_dataカラムにjson形式で保存されます。

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean CSVインポート結果
errors array 成功のためエラーがないので空配列が返ってきます
data array 空配列が返ってきます
alert array 空配列が返ってきます 
{
    "data"   : [],
    "result" : true,
    "errors" : [],
    "alert"  : []
}
失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean CSVインポート結果
error List 失敗した理由を配列
data array 空配列が返ってきます
alert array 空配列が返ってきます 
{
    "data"     : [],
    "result"   : false,
    "errors"   : {
        "type" : "種類は値が正しくありません。"
    },
    "alert"    : []
}

{danger} 失敗時は200以外のエラーコードが返却されます。共通ルールのレスポンスをチェック。

データストア

{primary} csv_temp_storesテーブルに一時データを保存します。

csv_temp_storesテーブルにてorganization_idとcsv_typeによりデータ検索をおこない、対象レコードが存在すればそのレコードをupdate、存在しなければinsertにてデータ保存を行います。

論理名 物理名 型 備考
ID id int 自動採番
監理団体ID organization_id int unsigned ログインsessionのorganization_idの値を使用
CSV種別 csv_type tinyint enum : CsvTypeの値を登録
元データ original_data json 配列データをjsonにcastしてDBに登録
編集データ edited_data json 配列データをjsonにcastしてDBに登録
作成日時 created_at datetime insert時のみ現在日時を登録
最終更新日時 updated_at datetime insert, update時ともに現在日時を登録