CSVインポート一時保存取得API

概要

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

アクセス制御

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

I/O情報

エンドポイント

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

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

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

ROUTEパラメータ

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

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean インポートCSV一時保存データ取得結果
errors array 成功のためエラーがないので空配列が返ってきます
data array 空配列が返ってきます
original_dataはインポートCSVの元データです
edited_dataは編集データです
alert array 空配列が返ってきます 
{
    "data": {
        "original_data": [
            {
                "id"                    : 999,
                "name"                  : "テスト送出機関",
                "address"               : "東京都千代田区東神田",
                "country"               : 1,
                "supervisor_name"       : "テスト 吾郎",
                "supervisor_rank"       : "部長",
                "abbreviated_name"      : "T",
                "reference_number"      : "12345678901",
                "sending_agency_number" : "1111"
            }
        ],
        "edited_data": [
            {
                "id"                    : 999,
                "name"                  : "テスト送出機関",
                "address"               : "東京都千代田区東神田",
                "country"               : 9,
                "supervisor_name"       : "テスト 悟郎",
                "supervisor_rank"       : "チーフー",
                "abbreviated_name"      : "G",
                "reference_number"      : "23456789012",
                "sending_agency_number" : "2222"
            }
        ]
    },
    "result": true,
    "errors": [],
    "alert": []
}
失敗時

ステータスコード：200

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

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