Svarskoder för referens-API

Gäller för: Partnercenter | Partnercenterreferenser

Lämpliga roller: Referensadministratör | Användare av hänvisningar

REST-API:er för partnercenterreferenser returnerar ett JSON-objekt som innehåller en statuskod. Den här koden anger om din begäran lyckades eller varför den misslyckades.

Lyckade svar

En 2xx-statuskod anger att klientens begäran har tagits emot, förståtts och godkänts. Följande 2xx-statuskoder anger ett lyckat svar:

• 200: Framgång bekräftad
• 201: Resursen har skapats
• 202: Accepterad
• 204: Inget innehåll att returnera

Felsvar

Alla svar med statuskoden 4xx eller 5xx innehåller ett felmeddelande med information om felvillkoren för koden.

I följande tabell visas och beskrivs DE HTTP-statuskoder som kan returneras för felscenarier.

Fel i resurstyp

Felsvaret är ett enda JSON-objekt som innehåller en enda egenskap med namnet error. Det här objektet innehåller all information om felet. Du kan använda informationen som returneras här i stället för eller utöver HTTP-statuskoden.

I följande tabell och kodexempel beskrivs schemat för ett felsvar.

Exempel på felsvar

{
  "error": {
    "code": "unauthenticated",
    "message": "The caller is not authenticated.",
    "innerError": {
      "code": "99902",
      "message": "Request not authenticated",
      "details": null
    }
  }
}

Ett annat exempel med innerError.details-objektet ifyllt:

{
  "error": {
    "code": "invalidRequest",
    "message": "The request is malformed or incorrect.",
    "innerError": {
      "code": "99901",
      "message": "InvalidInput",
      "details": [
        {
          "InvalidReferralForCoSellConversion": [
            "If PartnerLed referral has no solution it cannot be converted to co-sell referral"
          ]
        }
      ]
    }
  }
}

Kodegenskap

Egenskapen code innehåller något av följande möjliga värden. Dina appar bör vara beredda att hantera något av dessa fel.

Meddelandeegenskap

Egenskapen message i roten innehåller ett felmeddelande som är avsett för utvecklaren att läsa. Felmeddelanden är inte lokaliserade och bör inte visas direkt för användaren. Din kod bör inte kontrollera mot message värden bara för att de kan ändras när som helst, och de innehåller ofta dynamisk information som är specifik för den misslyckade begäran. Du bör koda mot felkoder som returneras i code egenskaper och sedan kombinera den med meddelandetext för mer information.

InnerError-objekt

Objektet innererror kan rekursivt innehålla fler innererror objekt med mer specifika felkoder. När klientprogrammet hanterar ett fel bör det gå igenom alla tillgängliga felkoder och använda den mest detaljerade som de förstår.

Det finns några fler fel som din app kan stöta på i de kapslade innererror objekten. Appar krävs inte för att hantera dessa fel, men kan göra det om de vill. Tjänsten kan lägga till nya felkoder eller sluta returnera gamla när som helst, så det är viktigt att alla appar kan hantera [grundläggande felkoder].

Felkoder

Följande är felkoder som returneras av API:erna: