Errors - vPlan

In the event that the request results in an error of any kind, the API will respond with a JSON error. If you receive any other kind of error there must be a connection issue somewhere down the line.

An error will always be in the following format:

Exception

reference

string <uuid>

read-onlyrequired

Error reference, used for support requests

errors

array [object {5}]

read-onlyrequired

A list of errors

Usually only one error is found within this list

>= 1 items

code

integer

required

Error code. May be the status code, but could also be a specific vPlan error code

message

string

required

Error message

description

required

Additional information about the error

reference

string <uuid>

required

Error reference, used for support requests

timestamp

string <date-time>

required

Date and time of the occurrence of the error