ULM Business Error Codes

Content

• Overview
• 400
• 401
• 403
• 404
• 409
• Field Validation Errors

Overview

A ULM business error code (or just "business code") is returned in the body of a failed or denied API request. In most cases, the business code is accompanied by a human-readable message that describes the issue. Known status codes are listed below and grouped according to the HTTP status that the code accompanies.

400

Most 400 responses are the result of bad user input, or improper pagination parameters in the request.

401

Most 401 responses are the result of missing authentication (the system does not know who you are) or verification (a missing or invalid token).

403

Most 403 responses are the response of missing authentication (the system can verify the requesting user, but that user lacks the required permissions or entitlements to the requested resource).

404

Most 404 responses are the result of an incorrect resource identifier or search criteria in the request.

409

Most 409 responses are the result of a data conflict based on user input.

Field Validation Errors

Many ULM business codes are pre-defined for very specific issues that result in a failed or denied API request. However, ULM also dynamically generates error codes to respond to input-based field validation errors. The payload for each type of payload will generally look the same, but a field validation error might also include the specified field that causes a failed request.

{
    "operationError": {
      "code": "security-challenge failed",
      "message": "You lack the authorization level required to perform the desired task on the target resource."
    }
}

{
    "fieldErrors": [
        {
            "field": "username",
            "code": "NotEmpty.newUserDto.username",
            "message": "This field can not be empty"
        },
         {
            "field": "email",
            "code": "InvalidFormat.newUserDto.emaile",
            "message": "This field must have a proper email format"
        }
    ]
}