APIException Data Type

Class to build error responses thrown by the API.

Example

{
  "response" : {
    "statusInfo" : {
      "statusCode" : 12345,
      "family" : "INFORMATIONAL",
      "reasonPhrase" : "..."
    },
    "lastModified" : 12345,
    "links" : [ {
      "uri" : "...",
      "params" : {
        "property1" : "...",
        "property2" : "..."
      },
      "title" : "...",
      "rels" : [ "...", "..." ],
      "rel" : "...",
      "type" : "...",
      "uriBuilder" : { }
    }, {
      "uri" : "...",
      "params" : {
        "property1" : "...",
        "property2" : "..."
      },
      "title" : "...",
      "rels" : [ "...", "..." ],
      "rel" : "...",
      "type" : "...",
      "uriBuilder" : { }
    } ],
    "stringHeaders" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    },
    "location" : "...",
    "cookies" : {
      "property1" : {
        "expiry" : 12345,
        "secure" : true,
        "maxAge" : 12345,
        "comment" : "...",
        "httpOnly" : true,
        "name" : "...",
        "path" : "...",
        "value" : "...",
        "version" : 12345,
        "domain" : "..."
      },
      "property2" : {
        "expiry" : 12345,
        "secure" : true,
        "maxAge" : 12345,
        "comment" : "...",
        "httpOnly" : true,
        "name" : "...",
        "path" : "...",
        "value" : "...",
        "version" : 12345,
        "domain" : "..."
      }
    },
    "allowedMethods" : [ "...", "..." ],
    "mediaType" : {
      "wildcardType" : true,
      "type" : "...",
      "subtype" : "...",
      "wildcardSubtype" : true,
      "parameters" : {
        "property1" : "...",
        "property2" : "..."
      }
    },
    "length" : 12345,
    "entityTag" : {
      "weak" : true,
      "value" : "..."
    },
    "status" : 12345,
    "language" : "...",
    "entity" : { },
    "headers" : {
      "property1" : [ { }, { } ],
      "property2" : [ { }, { } ]
    },
    "metadata" : {
      "property1" : [ { }, { } ],
      "property2" : [ { }, { } ]
    },
    "date" : 12345
  },
  "stackTrace" : [ {
    "classLoaderName" : "...",
    "methodName" : "...",
    "fileName" : "...",
    "className" : "...",
    "lineNumber" : 12345,
    "moduleVersion" : "...",
    "nativeMethod" : true,
    "moduleName" : "..."
  }, {
    "classLoaderName" : "...",
    "methodName" : "...",
    "fileName" : "...",
    "className" : "...",
    "lineNumber" : 12345,
    "moduleVersion" : "...",
    "nativeMethod" : true,
    "moduleName" : "..."
  } ],
  "localizedMessage" : "...",
  "cause" : {
    "stackTrace" : [ {
      "classLoaderName" : "...",
      "methodName" : "...",
      "fileName" : "...",
      "className" : "...",
      "lineNumber" : 12345,
      "moduleVersion" : "...",
      "nativeMethod" : true,
      "moduleName" : "..."
    }, {
      "classLoaderName" : "...",
      "methodName" : "...",
      "fileName" : "...",
      "className" : "...",
      "lineNumber" : 12345,
      "moduleVersion" : "...",
      "nativeMethod" : true,
      "moduleName" : "..."
    } ],
    "localizedMessage" : "...",
    "cause" : { },
    "suppressed" : [ { }, { } ],
    "message" : "..."
  },
  "suppressed" : [ {
    "stackTrace" : [ {
      "classLoaderName" : "...",
      "methodName" : "...",
      "fileName" : "...",
      "className" : "...",
      "lineNumber" : 12345,
      "moduleVersion" : "...",
      "nativeMethod" : true,
      "moduleName" : "..."
    }, {
      "classLoaderName" : "...",
      "methodName" : "...",
      "fileName" : "...",
      "className" : "...",
      "lineNumber" : 12345,
      "moduleVersion" : "...",
      "nativeMethod" : true,
      "moduleName" : "..."
    } ],
    "localizedMessage" : "...",
    "cause" : { },
    "suppressed" : [ { }, { } ],
    "message" : "..."
  }, {
    "stackTrace" : [ {
      "classLoaderName" : "...",
      "methodName" : "...",
      "fileName" : "...",
      "className" : "...",
      "lineNumber" : 12345,
      "moduleVersion" : "...",
      "nativeMethod" : true,
      "moduleName" : "..."
    }, {
      "classLoaderName" : "...",
      "methodName" : "...",
      "fileName" : "...",
      "className" : "...",
      "lineNumber" : 12345,
      "moduleVersion" : "...",
      "nativeMethod" : true,
      "moduleName" : "..."
    } ],
    "localizedMessage" : "...",
    "cause" : { },
    "suppressed" : [ { }, { } ],
    "message" : "..."
  } ],
  "message" : "..."
}