Path

/api/v1/{Project_token}/{ProjectUnit_token}/add

Http Method

POST

Content-type

application/form-data

form-data

{自定義欄位KEY}

設定如勾選[欄位必須填選]時為必要（選用｜必要）

建議檔案欄位限制3MB以下；大型檔案欄位請參考使用 上傳單一欄位檔案API

key

API金鑰；設定如勾選[驗證金鑰]時為必要（選用｜必要）

請勿於公開資訊端使用API金鑰。若於Client公開資訊端使用，請自行評估其風險及可行性或將程式碼混淆加密壓縮。

Responses

application/json

Example Value

{
    "result": true,
    "token": "a9ff560d543449869b6b7cda4e7b6218",
    "message": "",
    "validResult": true,
    "validMessage": "",
    "StatusCode": 201,
    "fields": [
        {
            "Key": "field_1",
            "Value": {
                "key": "field_1",
                "name": "科目名稱",
                "value": "科目三",
                "result": true,
                "message": ""
            }
        }
    ]
}

Example Value

{
    "result": false,
    "token": null,
    "message": "",
    "validResult": false,
    "validMessage": "缺少欄位參數【field_1】！\n",
    "StatusCode": 400,
    "fields": [
        {
            "Key": "field_1",
            "Value": {
                "key": "field_1",
                "name": "科目名稱",
                "value": null,
                "result": false,
                "message": "缺少欄位參數【field_1】！"
            }
        }
    ]
}

result

true：回傳狀態成功｜false：回傳狀態失敗（bool）

token

回傳新增成功資料鍵值（string）｜null

message

回傳狀態失敗訊息（string）

validResult

true：form-data驗證成功｜false：form-data驗證失敗（bool）

validMessage

form-data欄位驗證失敗訊息（string）

StatusCode

回傳狀態碼（int）

fields

form-data欄位驗證失敗訊息（array[object]）

EX：

[
    {
        "Key": "key",
        "Value": {
            "key": "key",
            "name": "API金鑰",
            "value": null,
            "result": false,
            "message": "缺少API金鑰欄位參數"
        }
    },
    {
        "Key": "field_1",
        "Value": {
            "key": "field_1",
            "name": "科目名稱",
            "value": null,
            "result": false,
            "message": "缺少欄位參數【field_1】！"
        }
    }
]

Example Code

• jQuery Ajax
• Vue Axios

var formdata = new FormData();
formdata.append('field_1', $('#field_1').val()); //欄位【文字】值設定
formdata.append('field_2', $('#field_2')[0].files[0]); //檔案欄位【檔案】值設定
formdata.append('field_3', $('#field_3').is(':checked')); //欄位【是否】設定值
formdata.append('sex', $("input:radio[name='sex']:checked").val()); //欄位【性別】設定值
$.ajax({
	url: 'https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/add',
	type: 'POST',
	data: formdata,
	processData: false,
	contentType: false,
	success: function(response) {
		if (response.result) //執行成功
		{
                    callback(response.data);
                    //上傳單一大型檔案
                    //var file_count = 0;
                    //var upload_rsp_count = 0;
                    //var upload_fail_msg = "";
                        
                    //if ($('#field_6')[0].files.length != 0) {
                        //file_count++;
                        //var uploader = $('#field_6').chunkUpload({
                            //api_host: 'https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/upload_file',
                            //token: response.data.token,
                            //field_key: 'field_6',
                            //progress: '#field_6_progress'
                        //}, function (response) {
                            //upload_rsp_count++;
                            //if (response.uploaded) {
                                //單一欄位檔案上傳完成
                                //console.log('uploaded');
                            //}
                            //if (!response.result) {
                                //upload_fail_msg += '【照片】上傳失敗！<br>';
                            //}
                        //});
                        //uploaders.push(uploader);
                    //}        
                    //var ref = setInterval(function () {
                        //if (file_count == upload_rsp_count) {
                            //全部檔案上傳完成
                            //$('#reset_hide').click();
                            //$('#captcha_img').click();
                            //clearInterval(ref);
                            //callback(response.data);
                        //}
                    //}, 500);
		}
		else
		{
			//取得失敗資訊
			alert(response.message);
			//取得欄位驗證資訊
			$.each(response.fields, function(index, field) {
				console.log(field);
			});
		}
	},
	error: function(xhr, ajaxOptions, thrownError) {
		console.log(xhr.status + '：' + thrownError);
	}
});
                                    

var formdata = new FormData();
formdata.append('field_1', $('#field_1').val()); //欄位【文字】值設定
formdata.append('field_2', $('#field_2')[0].files[0]); //檔案欄位【檔案】值設定
formdata.append('field_3', $('#field_3').is(':checked')); //欄位【是否】設定值
formdata.append('sex', $("input:radio[name='sex']:checked").val()); //欄位【性別】設定值
axios
.post('https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/add', formdata)
.then(response => {
    if (response.data.result) {//執行成功
        callback(response.data.data);
        //上傳單一大型檔案
        //var file_count = 0;
        //var upload_rsp_count = 0;
        //var upload_fail_msg = "";
                        
        //if ($('#field_6')[0].files.length != 0) {
            //file_count++;
            //var uploader = $('#field_6').chunkUpload({
                //api_host: 'https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/upload_file',
                //token: response.data.token,
                //field_key: 'field_6',
                //progress: '#field_6_progress'
            //}, function (response) {
                //upload_rsp_count++;
                //if (response.uploaded) {
                    //單一欄位檔案上傳完成
                    //console.log('uploaded');
                //}
                //if (!response.result) {
                    //upload_fail_msg += '【照片】上傳失敗！<br>';
                //}
            //});
            //uploaders.push(uploader);
        //}        
        //var ref = setInterval(function () {
            //if (file_count == upload_rsp_count) {
                //全部檔案上傳完成
                //$('#reset_hide').click();
                //$('#captcha_img').click();
                //clearInterval(ref);
                //callback(response.data.data);
            //}
        //}, 500);
    }
    else {
        //取得失敗資訊
        alert(response.data.message);
        //取得欄位驗證資訊
        $.each(response.data.fields, function(index, field) {
	        console.log(field);
        });
    }
})
.catch(function (error) {
    console.log(error);
});