Path

/api/v1/{Project_token}/{ProjectUnit_token}/delete

Http Method

POST

Content-type

application/form-data

form-data

token

即將刪除欄位檔案所屬的資料的唯一鍵值（必要）

field

即將刪除此欄位檔案的對應欄位KEY（必要）

key

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

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

Responses

application/json

Example Value

{
    "result": true,
    "message": "",
    "validResult": true,
    "validMessage": "",
    "StatusCode": 200,
    "fields": [
        {
            "Key": "token",
            "Value": {
                "key": "token",
                "name": "資料鍵值",
                "value": "477f507aa6c94be29273d53c3400c2b7",
                "result": true,
                "message": ""
            }
        },
        {
            "Key": "field",
            "Value": {
                "key": "field",
                "name": "資料欄位KEY",
                "value": "photo",
                "result": true,
                "message": ""
            }
        }
    ]
}

result

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

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": "token",
        "Value": {
            "key": "token",
            "name": "資料鍵值",
            "value": "5a08aecbf0ab4a679b676e06ae9e7c92",
            "result": true,
            "message": ""
        }
    },
    {
        "Key": "field",
        "Value": {
            "key": "field",
            "name": "資料欄位KEY",
            "value": "field_key",
            "result": false,
            "message": "資料欄位KEY錯誤"
        }
    }
]

Example Code

• jQuery Ajax
• Vue Axios

var formdata = new FormData();
formdata.append('token', '[token]欄位值'); //欄位【token】設定值；即將刪除欄位檔案所屬的資料的唯一鍵值
formdata.append('field', '欄位KEY'); //欄位KEY；即將刪除此欄位檔案的對應欄位KEY
$.ajax({
	url: 'https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/delete',
	type: 'POST',
	processData: false,
	contentType: false,
	data: formdata,
	success: function(response) {
		if (response.result)
		{
			//執行成功
			callback(response.data);
		}
		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('token', '[token]欄位值'); //欄位【token】設定值；即將刪除欄位檔案所屬的資料的唯一鍵值
formdata.append('field', '欄位KEY'); //欄位KEY；即將刪除此欄位檔案的對應欄位KEY
axios
.post('https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/delete_file', formdata)
.then(response => {
    if (response.data.result) {
        //執行成功
        callback(response.data.data);
    }
    else {
        //取得失敗資訊
		alert(response.data.message);
		//取得欄位驗證資訊
		$.each(response.data.fields, function(index, field) {
			console.log(field);
		});
    }

})
.catch(function (error) {
    console.log(error);
});