error

error
error

Error Message that is returned as part of HTTP response in case of an error during the API invocation

JSON Example
{
    "apiErrorCode": 0,
    "extension": {
        "anyObjects": [
            {}
        ]
    },
    "httpStatusCode": 0,
    "inputBodyLocation": {
        "columnNumber": 0,
        "lineNumber": 0
    },
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "message": "string",
    "moreInformation": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "type": "string",
    "validationFailures": [
        {
            "failureMessage": "string",
            "violationPath": "string"
        }
    ]
}
integer As int32 As int32
apiErrorCode
Optional

The error code of the error

extension
extension
Optional

extension

integer As int32 As int32
httpStatusCode
Optional

The status code of the error

InputBodyLocation
inputBodyLocation
Optional

Location of parsing exception

array of link
links
Optional

links

string
message
Required

The error message

array of name-value
moreInformation
Optional

Some more information about the error

string
type
Optional

Used to identify schema type. For each schema its equivalent value should be used. allowableValues = {CertificatesError, Error}

array of validationFailure
validationFailures
Optional

The collection of validation failures

Used By