صيغة الأخطاء ورموز الأخطاء

يجب أن تتمكن التكاملات من فهم الأخطاء ومعالجتها بسرعة.

صيغة الخطأ

{
  "type": "https://docs.ordinavo.de/errors/validation_failed",
  "title": "Validation failed",
  "status": 400,
  "code": "validation_failed",
  "detail": "One or more fields are invalid.",
  "traceId": "00-85f1ac0ed64147f499c20e04af2a1c19",
  "errors": {
    "location.postalCode": [
      "Postal code is required."
    ],
    "preferredTimeWindows[0].from": [
      "Start time must be before end time."
    ]
  }
}

رموز الأخطاء

Code	الوصف
`invalid_request`	صيغة الطلب غير صحيحة.
`validation_failed`	توجد حقول مطلوبة مفقودة أو قيم غير صالحة.
`unauthorized`	المصادقة مفقودة أو غير صالحة.
`forbidden`	لا يملك هذا التكامل صلاحية تنفيذ هذا الإجراء.
`not_found`	لم يتم العثور على المورد المطلوب.
`conflict`	يتعارض الطلب مع الحالة الحالية.
`idempotency_conflict`	تم استخدام مفتاح Idempotency نفسه مسبقًا مع محتوى مختلف.
`rate_limited`	تم تجاوز حد الاستخدام.
`unsupported_service_type`	نوع الخدمة المحدد غير مفعّل.
`internal_error`	حدث خطأ داخلي.

رموز الحالة

200 OK 201 Created 202 Accepted 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 409 Conflict 422 Unprocessable Entity 429 Too Many Requests 500 Internal Server Error