Scale Intelligence■ Docs
Docs / The model / Refusal

Refusal.

The one typed shape of every not-allowed and every error

Figure 1Refusalspecified
REFUSALvalue at none scopein plain words a customer could act onwhat_happenedtextwhich input it was aboutinputtextoptionalthe rule, and why it existsruleLawwhytextthe call or the route that fixes itway_outtextshape_of_the_fixjsonoptionalretry_can_helpboolLAWthrough rule
Refusal is a value at none scope. The drawing shows its fields and the objects that they point at.
kind
value
scope
none
key
none
store
none
family
kernel

Fields#

fieldtyperequirednote
what_happenedtextyesin plain words a customer could act on
inputtextnowhich input it was about
ruleLawyesthe rule, and why it exists
whytextyes
way_outtextyesthe call or the route that fixes it
shape_of_the_fixjsonno
retry_can_helpboolyes

Routes that use it#

No route takes or returns Refusal directly. The record holds it, and the objects that point at it reach it.