Skip to Content
🚀 Welcome to Humansoft Open API Documentation

Delete Warning Letter

API สำหรับลบจดหมายเตือน 1 ใบ พร้อมไฟล์แนบทั้งหมด และนำการ์ดจดหมายเตือนออกจาก News Feed ของพนักงาน ลบได้เฉพาะจดหมายเตือนที่พนักงานยังไม่รับทราบ (approve_flag = 01)

การลบไม่สามารถกู้คืนได้

Endpoint

POST /api/v1/open-apis/warning-letter/delete

สิทธิ์ที่ต้องการ: API Key ต้องมีสิทธิ์ ข้อมูลการยื่นเอกสาร (document:manage)

Request Body

ส่งแบบ application/json

ParameterTypeRequiredDescriptionExample
warning_letter_idstringYesID ของจดหมายเตือนที่ต้องการลบ (Base64)"MjAyNTExMjdENDU3M0M0MjE2Mzk="
langstringNoภาษาของ message: TH (ค่าเริ่มต้น) หรือ EN"EN"

Request Body Example

{ "warning_letter_id": "MjAyNTExMjdENDU3M0M0MjE2Mzk=" }

Response Format

Success Response

{ "code": 200, "message": "ลบจดหมายเตือนสำเร็จ", "payload": { "warning_letter_id": "20251127D4573C421639" } }
FieldTypeDescription
warning_letter_idstringID ของจดหมายเตือนที่ถูกลบ (raw)

Success Response with Warnings

จดหมายเตือนถูกลบแล้ว แต่งานต่อเนื่องบางส่วนไม่สำเร็จ — ระบบคืน HTTP 200 พร้อม warnings (ไม่ต้องส่งคำขอซ้ำ)

{ "code": 200, "message": "ลบจดหมายเตือนสำเร็จ", "payload": { "warning_letter_id": "20251127D4573C421639" }, "warnings": [ "an attachment could not be removed from storage" ] }
ข้อความใน warningsความหมาย
news feed could not be removedนำการ์ดจดหมายเตือนออกจาก News Feed ไม่สำเร็จ
an attachment could not be removed from storage / attachment storage cleanup failedลบไฟล์แนบออกจากที่จัดเก็บไฟล์ไม่สำเร็จ

Error Response

ข้อมูลไม่ผ่านการตรวจสอบ (422)

{ "code": 422, "message": "การตรวจสอบข้อมูลล้มเหลว", "errors": ["'warning_letter_id' is required"] }
ข้อความใน errorsสาเหตุ
'warning_letter_id' is requiredไม่ได้ส่ง warning_letter_id
'warning_letter_id' is invalid (expected the base64 of an alphanumeric id)warning_letter_id ไม่ใช่ Base64 ของ ID ที่ถูกต้อง

ไม่พบจดหมายเตือน (404)

{ "code": 404, "message": "ไม่พบจดหมายเตือน" }

พนักงานรับทราบแล้ว (409)

{ "code": 409, "message": "พนักงานรับทราบจดหมายเตือนนี้แล้ว ไม่สามารถแก้ไขหรือลบได้" }
HTTP StatusDescription
400เกิดข้อผิดพลาดระหว่างลบ (message: กระบวนการล้มเหลว) — จดหมายเตือนยังไม่ถูกลบ
403API Key ไม่มีสิทธิ์ document:manage
404ไม่พบจดหมายเตือน — ID ไม่มีอยู่ ถูกลบไปแล้ว หรือเป็นของบริษัทอื่น
409พนักงานรับทราบจดหมายเตือนแล้ว ลบไม่ได้
422Parameter ไม่ผ่านการตรวจสอบ
500เกิดข้อผิดพลาดที่เซิร์ฟเวอร์ (message: เกิดข้อผิดพลาดที่เซิร์ฟเวอร์) — จดหมายเตือนยังไม่ถูกลบ

Code Examples

curl -X POST "https://openapi.humansoft.co.th/api/v1/open-apis/warning-letter/delete" \ -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "warning_letter_id": "MjAyNTExMjdENDU3M0M0MjE2Mzk=" }'

Notes

  • API นี้ไม่อนุญาตให้ลบจดหมายเตือนที่พนักงานรับทราบแล้ว
  • การลบไม่ส่งแจ้งเตือนถึงพนักงาน และแจ้งเตือนเรื่องจดหมายเตือนนี้ที่พนักงานได้รับไปก่อนหน้ายังคงอยู่ในรายการแจ้งเตือนของพนักงาน
  • หลังลบ จดหมายเตือนจะไม่แสดงใน Get List และ Get Detail จะคืน HTTP 404

  • Get Detail - ตรวจสถานะ approve_flag ก่อนลบ
  • Delete File - ลบเฉพาะไฟล์แนบบางไฟล์
  • Get List - ค้นหารายการจดหมายเตือน
Last updated on