รหัสข้อผิดพลาด

การตอบกลับที่เป็นข้อผิดพลาดทุกรายการมีโครงสร้างเดียวกัน ให้อาศัยสถานะ HTTP และ error.code ส่วน error.message เป็นข้อความภาษาอังกฤษสำหรับให้คนอ่านและอาจเปลี่ยนแปลงได้

รูปแบบข้อผิดพลาด

{
  "detail": "…",
  "error": {
    "code": "api.cursor_invalid",
    "message": "The cursor is malformed or was issued for different filters.",
    "details": {"parameter": "cursor"},
    "request_id": "01JB7Q2M4X9V3K8T5N6P0R1S2A",
    "doc_url": "https://developers.sursa.com/errors/api.cursor_invalid"
  }
}

error.code คือรหัสในหน้านี้ error.request_id ตรงกับเฮดเดอร์ X-Request-Id และ error.doc_url ลิงก์มายังหน้านี้