מקרי שגיאה

אם אמורה להיות שגיאה, הרשות להגנה על מידע (DPA) צפויה להחזיר קוד סטטוס HTTP יחד עם תגובת HTTP. פורמט זה חייב לכלול אובייקט JSON עם מידע נוסף לגבי השגיאה. גוף התגובה לשגיאה חייב להכיל מופע של ErrorResponse.

{
  "errorMessage": string,
  "cause": enum(ErrorCause)
}

תגובה לשגיאות DPA חייבת לעמוד בדרישות הבאות:

  • המשתמש נמצא כרגע בנדידה ושאילתת DPA מושבתת למשתמש הזה. הרשות להגנה על מידע (DPA) מחזירה שגיאת 403 שסיבתה היא USER_ROAMING כסיבת השגיאה.
  • הרשות להגנה על מידע (DPA) מחזירה קוד שגיאה 404 NOT_FOUND המציין כי GTAF מפתח המשתמש לא חוקי (כלומר, מפתח המשתמש לא קיים) עם INVALID_NUMBER.
  • הרשות להגנה על מידע (DPA) מחזירה קוד שגיאה 410 GONE עם WHERE_CPID כגורם לשגיאה, ומציין ל-GTAF שהלקוח צריך לקבל מפתח משתמש חדש אם key_type = CPID ותוקף ה-CPID פג.
  • הרשות להגנה על מידע (DPA) מחזירה קוד שגיאה 501 NOT_IMPLEMENTED שמציין כי היא לא תומכת בשיחה זו עם סיבת השגיאה SERVICE_UNAVAILABLE.
  • הרשות להגנה על מידע (DPA) מחזירה 429 בקשות TOO רבות עם הודעת שגיאה של TOO_MANY_Bidding עם הכותרת Try-after שמציינת ש-GTAF מבצע יותר מדי בקשות ל-DPA.
  • הרשות להגנה על מידע (DPA) מחזירה שגיאת 409 התנגשות שמציינת שלא ניתן להשלים את הבקשה עקב התנגשות עם המצב הנוכחי של הרשות להגנה על מידע.
  • השירות לא זמין באופן זמני. הרשות להגנה על מידע (DPA) מחזירה שירות מסוג 503, שאינו זמין, עם הכותרת 'ניסיון חוזר אחרי', שמציינת מתי אפשר לנסות להגיש בקשה חדשה.
  • הרשות להגנה על מידע (DPA) מחזירה את קוד השגיאה 500 INTERNAL server ERROR עבור כל שאר השגיאות שלא צוינו ERROR_CAUSE_UNSPECIFIED כסיבת השגיאה.

אם אירעו שגיאות במהלך הרכישה, קודי השגיאות הבאים מייצגים תוצאות של עסקאות שנכשלו:

  • הרשות להגנה על מידע (DPA) מחזירה קוד שגיאה 400 גרועה של בקשה, המודיעה ל-GTAF שמזהה התוכנית שנרכש אינו חוקי.
  • הרשות להגנה על מידע (DPA) מחזירה קוד שגיאה 402 של תשלום נדרש, המציין ש-GTAF לא מכיל מספיק יתרה להשלמת הרכישה.
  • הרשות להגנה על מידע (DPA) מחזירה קוד שגיאה 409 CONFLICT שמעיד על כך שה-GTAF לא עומד בתנאים של תמהיל המוצרים הנוכחי של המשתמש. לדוגמה, אם המדיניות של תוכנית הנתונים של המפעיל אוסרת על השילוב בין תוכניות בתשלום מראש ותוכניות בתשלום מראש, ניסיון לרכוש מינוי בתשלום מראש עבור משתמש שמשלמים מראש יוביל לשגיאה 409 CONFLICT.
  • הרשות להגנה על מידע (DPA) מחזירה את קוד השגיאה 403 FORBIDDEN, המציין בפני GTAF שהעסקה הנוכחית היא כפילות של עסקה שהונפקה בעבר. ה-DPA אמור להחזיר את השגיאות הבאות בתגובה:
    • אם העסקה הקודמת נכשלה, הסיבה לשגיאה היא הסיבה לכשל.
    • אם העסקה הקודמת הושלמה בהצלחה, DUPLICATE_TRANSACTION.
    • אם העסקה הקודמת עדיין ממתינה בתור, REQUEST_QUEUED.