Last updated

Appendix

Error Codes

This Appendix describes the schema and fields of the standard project44 API Error Responses for Tendering/Booking Services.

Below, find the API Error Response Schema:

400 Bad Request

{
  "httpStatusCode": 400,
  "httpMessage": "Bad Request",
  "errorMessage": "string",
  "errors": [
    {
      "severity": "ERROR",
      "message": "string",
      "diagnostic": "string",
      "source": "string"
    }
  ],
  "supportReferenceId": "string"
}

401 Unauthorized

{
  "httpStatusCode": 401,
  "httpMessage": "Unauthorized",
  "errorMessage": "string",
  "errors": [
    {
      "severity": "ERROR",
      "message": "string",
      "diagnostic": "string",
      "source": "string"
    }
  ],
  "supportReferenceId": "string"
}

404 Not Found

{
  "httpStatusCode": 404,
  "httpMessage": "Not Found",
  "errorMessage": "string",
  "errors": [
    {
      "severity": "ERROR",
      "message": "string",
      "diagnostic": "string",
      "source": "string"
    }
  ],
  "supportReferenceId": "string"
}

409 Conflict

{
  "httpStatusCode": 409,
  "httpMessage": "Conflict",
  "errorMessage": "string",
  "errors": [
    {
      "severity": "ERROR",
      "message": "string",
      "diagnostic": "string",
      "source": "string"
    }
  ],
  "supportReferenceId": "string"
}
Error Response FieldDescription
httpStatusCodeThe value of the HTTP status code. Possible values are: 400, 401, 403, or 404
httpMessageA brief description of the HTTP status code. Possible values are: Invalid request (httpStatusCode = 400), Invalid or missing credentials (httpStatusCode = 401), User not authorized to perform this operation (httpStatusCode = 403), or Not Found (httpStatusCode = 404)
errorMessageA detailed description of the error. For example: "errorMessage": "Text '2022-03-23T18:38:00Z' could not be parsed, unparsed text found at index 19"
errorsThis array contains more details about the error
errors.severityThe severity of this message. Possible values are: ERROR, WARNING, or INFO
error.messageMore information about the error.  For example: Appointment in the Past
error.diagnosticDiagnostic information from project44 (The System) or from the Capacity Provider/Carrier. NOTE: In a Capacity Provider/Carrier integration, it would come only from project44.
error.sourceThe originator of the error message.  NOTE: In a Capacity Provider/Carrier integration, the originator will always be SYSTEM. Possible values are: SYSTEM (error from project44) or CAPACITY PROVIDER (error from the Capacity Provider or Carrier)
supportReferenceId A reference identifier used by project44 support to assist with certain error messages.