Lorsqu'une requête échoue, success est false et une liste errors indique ce qui s'est mal passé. Le statut HTTP n'est jamais 200. Vérifiez success dans chaque réponse avant de considérer un enregistrement comme sauvegardé.
{
"success": false,
"errors": [
"Unable to find record"
]
}
La plupart des entrées de errors sont de simples messages. Quelques-unes sont des objets avec un code que vous pouvez utiliser à la place du texte, et data qui décrit l'enregistrement concerné.
{
"success": false,
"errors": [
{
"code": "record_not_found",
"data": {
"modelName": "Customer",
"externalId": "CUST-1001"
}
}
]
}
Lorsqu'une requête fait référence à un enregistrement qui doit exister au préalable, comme le parent d'un client, la réponse peut inclure une liste missingRecords. Chaque entrée indique le type d'enregistrement et l'identifiant que vous avez utilisé pour celui-ci. Créez ces enregistrements, puis renvoyez la requête initiale.
{
"success": false,
"errors": [
{
"code": "record_not_found",
"data": {
"modelName": "Customer",
"externalId": "PARENT-1001"
}
}
],
"missingRecords": [
{
"model": "Customer",
"externalId": "PARENT-1001"
}
]
}
Les messages ci-dessous sont cités textuellement, ce qui vous permet de rechercher sur cette page le texte que vous avez reçu.