REST API - argument

Types
vapi
std
errors

vapi std errors: argument locations

The argument_locations structure describes which part(s) of the input to the operation caused the error.

Some types of errors are caused by the value of one of the inputs to the operation, possibly due to an interaction with other inputs to the operation. This structure is intended to be used as the payload to identify those inputs when the operation reports errors like vapi.std.errors.invalid_argument or vapi.std.errors.not_found. See vapi.std.errors.error.data.

Representation:

JSON

{
    "primary": "string",
    "secondary": [
        "string",
        "string"
    ]
}

Attributes:

Name	Type	Description
Required
primary	string	String describing the location of the input that triggered the error.
secondary	string[]	Array (possibly empty) of strings describing the locations of other inputs that caused the the primary input to trigger the error.