Tõrkevastuste standardiseerimine (eelversioon)

Oluline

• See on tootmisvalmis eelvaate funktsioon.
• Tootmisvalmis eelvaadetele kehtivad täiendavad kasutustingimused.

[See artikkel on väljalaskeeelne dokumentatsioon ja seda võidakse muuta.]

Tõrkevastused peavad olema standardiseeritud, et tagada tõrketeadete järjepidevus ja arusaadavus. Järgmises tabelis on loetletud vastus kehas oodatava tõrkeobjekti skeem.

Nimi	Andmetüüp	Nõutav	Kirjeldus
veakood	String	Jah	Lühike ja hõlpsasti tuvastatav veakategooria.
errorMessage	String	Nr	Arendajasõbralik sõnum vea kohta lisateabe saamiseks.
activityId	String	Nr	Taotluse kordumatu tunnus.
üksikasjad	Objekt	Nr	Lisateave vea kohta. Sisu võib olenevalt veatüübist erineda. Järgmises näites kujutatakse juhtumit, kus kasutajal pole õigeid õigusi. { "resourceType": "ümbrik", "resourceId": "<envelopeId>" }

Järgmises tabelis on loetletud mõned stsenaariumid ja eeldatavad tõrkekoodid.

Stsenaarium	Tõrkekood	HTTP-olekukood
Kliendisuhete halduse (CRM) süsteem, millega kasutaja on ühendatud, erineb sisendis määratud süsteemist.	INVALID_CRM_CONNECTION	400
CRM-i kirjesüsteemi ei leitud või see kustutati.	RECORD_NOT_FOUND	404
Kasutaja pole autenditud. (See stsenaarium ilmneb tavaliselt siis, kui luba aegub.)	INVALID_TOKEN_SPECIFIED	401
Kasutajal pole õigust toimingut teha. (Teisisõnu, kasutajal on ebapiisavad õigused).	INSUFFICIENT_PERMISSIONS	403
Konnektorile saadeti liiga palju taotlusi.	REQUEST_THROTTLED	429
Ilmnes käsitlemata teenusetõrge.	INTERNAL_SERVER_ERROR	500

Seotud teave

Extend Sales agent partneritaotlustega
Ehituslaiendused müügiagendi jaoks