ResponseError
If an error is encountered during the interchange, the Response contains an error. If the error is present, then the ErrorSeverity and ErrorCode are required.
Properties
Name | Type | Required | Description |
---|---|---|---|
errorSeverity | string | ✅ | Describes the severity of the error. For additional information, refer to Locator Error Codes in the Appendix. |
errorCode | string | ✅ | A numeric value that describes the error. Each tool defines a range of error codes. For additional information, refer to Locator Error Codes in the Appendix. |
errorDescription | string | ❌ | Describes the error code. |
minimumRetrySeconds | string | ❌ | Number of seconds to wait until retry. This field is populated on special conditions of the Transient Error only, as defined by the service. A number between 1 and 86400 (24 hours) |
errorLocation | ErrorErrorLocation[] | ❌ | Identifies the element in error. NOTE: For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
errorDigest | string[] | ❌ | The contents of the element in error. NOTE: For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1. |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs