Codes et réponses d’erreur courants

Les erreurs dans l’API OneDrive sont renvoyées à l’aide de codes d’état HTTP standard, ainsi que d’un objet de réponse d’erreur JSON. Les codes d’état HTTP suivants doivent être prévus.

La réponse d’erreur est un seul objet JSON qui contient une propriété unique nommée error. Cet objet inclut tous les détails de l’erreur. Vous pouvez utiliser les informations renvoyées ici à la place, ou en plus du code d’état HTTP renvoyé. Voici un exemple de corps d’erreur JSON complet.

{
  "error": {
    "code": "invalidRange",
    "message": "Uploaded fragment overlaps with existing data.",
    "innererror": {
      "code": "fragmentOverlap"
    }
  }
}

Propriété du code

La propriété du code contient l’une des 15 valeurs possibles. Les applications doivent être prêtes à gérer l’une de ces erreurs.

L’objet innererror peut contenir de manière récursive plus d’objets innererror avec des codes d’erreur supplémentaires et plus spécifiques. Lors de la gestion d’une erreur, les applications doivent mettre tous les codes d’erreur disponibles en boucle et utiliser le code le plus détaillé qu’elles comprennent. Certains codes plus détaillés sont répertoriés en bas de cette page.

Pour vérifier qu’un objet d’erreur est une erreur que vous attendez, vous devez effectuer une boucle sur les objets innererror pour rechercher les codes d’erreur attendus. Par exemple :

public bool IsError(string expectedErrorCode)
{
    OneDriveInnerError errorCode = this.Error;
    while (null != errorCode)
    {
        if (errorCode.Code == expectedErrorCode)
            return true;
        errorCode = errorCode.InnerError;
    }
    return false;
}

Pour obtenir un exemple complet permettant de gérer correctement des erreurs, consultez la page relative à la gestion des codes OneDrive.

La propriété message à la racine contient un message d’erreur destiné au développeur. Les messages d’erreur ne sont pas localisés et ne doivent pas être affichés directement pour l’utilisateur. Lors de la gestion des erreurs, votre code ne doit pas utiliser les valeurs message, car elles sont susceptibles de changer à tout moment et contiennent souvent des informations dynamiques propres à la demande ayant échoué. Vous devez coder uniquement par rapport aux codes d’erreur renvoyés dans les propriétés code.

Pour plus d’informations sur la ressource renvoyée dans la réponse d’erreur, consultez la rubrique Type de ressource d’erreur.

Codes d’erreur détaillés

Voici quelques erreurs supplémentaires que votre application peut rencontrer dans les objets imbriqués innererror . Les applications ne sont pas tenues de les gérer, mais le peuvent si elles le souhaitent. Le service peut ajouter de nouveaux codes d’erreur ou arrêter de retourner les anciens à tout moment. Il est donc important que toutes les applications puissent gérer les 15 de base ci-dessus.