Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ValidationError

ValidationError is returned by the API when there are issues with the given input which need to be solved to make the request succeed.

Hierarchy

  • ValidationError

Index

Properties

defaultMessage

defaultMessage: string

A message that explains the error code in the context of the request

errorCode

A key you can use to identify the actual error

references

references: string[]

Reference contains the JSON paths for the fields related to this error e.g. ['attendees[0].email'] will indicate the error applies to the first attendee's email input value

In practice this method is needed when you have multiple entities with the same field which could cause a specific error. For example a list of attendees, each one has a field 'email'; to identify which attendee's email is invalid.

Generated using TypeDoc