Handling Errors

​

Overview

When you send a request to the WinWinKit API, you receive a response that includes an HTTP status code and, in most cases, a response body. To determine your request’s status and handle errors, use the HTTP status code along with the code from the Error Response. Interpret the error starting with the most general information first.

​

Response HTTP Codes

WinWinKit uses standard HTTP codes to indicate the success or failure of your requests. In general, 2xx HTTP codes correspond to success, 4xx codes are for user-related failures, and 5xx codes are for infrastructure issues.

​

Error Response

The error details that an API returns in the response body whenever the API request isn’t successful. Contains an array of one or more errors.

{
  "errors": [
    {
      "code": "<string>",
      "status": <number>,
      "title": "<string>",
      "source": "<string | null>"
    }
  ]
}

​

Error Code

The code property is a stable, machine-readable value indicating the exact type of error. The code is hierarchical, with dots separating the information about the error from general to specific. The more information the system has about the error, the more levels the error code includes.