error

Name
object
Type
string
Description
Type of object is always error.
Allowed values: error
Name
code
Type
string
Description
An optional machine-readable description of the error. Present for errors that could be handled programmatically.
Optional: This property may not always be included.
Example: "invalidICCID"
Name
details
Type
array
Status
PREVIEW
Description
Optional array containing specific information for the current error.
Optional: This property may not always be included.
Name
documentation
Type
array
Description
An optional list of URLs providing further information to resolve the error.
Optional: This property may not always be included.
Name
hint
Type
string
Description
An optional explanation how to resolve the error.
Optional: This property may not always be included.
Example: "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i"
Name
message
Type
string
Description
A human readable description of the error.
Example: "Invalid ICCID format."
Name
type
Type
string
Description
The type of error returned.
Example: "invalid"

Example

{
  "object": "error",
  "code": "invalidICCID",
  "details": [
    {
      "object": "propertyErrorDetail",
      "code": "propertyRequired",
      "message": "Invalid value for property.",
      "property": "property1",
      "suggestion": "alternative_value"
    }
  ],
  "documentation": [
    "https://developers.gigs.com/docs/concepts/error-handling"
  ],
  "hint": "Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i",
  "message": "Invalid ICCID format.",
  "type": "invalid"
}