Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Message

Contains information returned from endpoints (typically only when an error occurs). Messages should NOT be presented to end users directly (although message codes could translated and presented if they provide useful guidance on how to recover from an error).

Hierarchy

  • Message

Index

Properties

code: string

A unique code to identify this message. May be used during translation to present recovery information to the end user.

data: any[]

Any additional information the server believes may be useful when triaging the error later.

severity: "ERROR" | "FATAL" | "NONE"

The message severity. Possible values are ERROR, FATAL, and NONE.