Errors Handling

General Information on Handling REST API Errors in the Marketplace Platform

All errors reported by the REST API have an HTTP status code and follow the standard format. When an error occurs, the response body usually contains a JSON object with the following fields:

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "One or more validation errors occurred.",
  "traceId": "00-9e02a91b64ac56904703a3a69ea9101d-56be90a29d0b0b25-00",
  "errors": {
    "mistake": [
      "Unknown expression group."
    ]
  }
}
  • type: [string] A URI reference that identifies the error type, providing a consistent way to categorize errors across different API implementations.

  • title: [string] A human-readable title or summary of the error.

  • status: [number] The HTTP status code associated with the error.

  • detail: (Optional) [string] A detailed human-readable description of the error, providing additional information to help clients understand the issue.

  • instance: (Optional) [string] A URI reference that identifies the specific occurrence of the error, useful for debugging or tracing purposes.

  • traceId: (Optional) [string] A unique identifier to trace requests in logs.

  • errors: (Optional) [key-value] A collection of errors detected by validation logic.

Common Errors

Some of the common errors are listed in the table below.

Last updated

SoftwareOne is a trademark of SoftwareOne, Inc. "The Software Licensing Experts" is a service mark of SoftwareOne, Inc. VAR assist is a trademark of SoftwareOne, Inc. "It pays to partner" is a service mark of SoftwareOne, Incorporated.