Timber Beams

Copy page

Error Handling

The API validates all inputs before processing. When validation fails, you'll receive detailed error messages explaining exactly what's wrong.

Error Response Format

All validation errors return HTTP 400 with this structure:

Code
 
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Input validation failed",
    "details": [
      { "field": "L_X", "message": "Expected number, received string" },
      { "field": "supports", "message": "At least 2 supports are required" }
    ]
  }
}

The details array contains one entry per issue, with field (the attribute path) and message (what's wrong).

Common Validation Errors

Type Errors

The most common mistake — passing strings where numbers are expected:

Code
 
// Wrong
{ "L_X": "14" }

// Correct
{ "L_X": 14 }

Yes/No fields use strings, not booleans:

Code
 
// Wrong
{ "incSW": true }

// Correct
{ "incSW": "Yes" }

Enum Errors

All enum values are case-sensitive:

Code
 
// Wrong
{ "wet": "wet" }

// Correct
{ "wet": "Wet" }

This applies to all enums — support types ("Pinned" not "pinned"), member type ("Database" not "database"), and temperature ranges. Check the API Reference for valid values.

Cross-Field Errors

Some fields are conditionally required. The most common:

Code
 
// Wrong - missing member when type is Database
{
  "type": "Database",
  "L_X": 14,
  "supports": [["Pinned", 0, 1.5], ["Pinned", 14, 1.5]]
}

// Correct
{
  "type": "Database",
  "member": "2x10 D.Fir-L No. 1",
  "L_X": 14,
  "supports": [["Pinned", 0, 1.5], ["Pinned", 14, 1.5]]
}

Error: Field 'member' is required when type='Database'

Error Codes

Code	HTTP Status	Description
VALIDATION_ERROR	400	Input validation failed
SHEET_NOT_FOUND	404	Sheet ID doesn't exist
NOT_FOUND	404	Resource not found
CALCULATION_ERROR	422	Calculation failed (check inputs)
UPSTREAM_ERROR	500	Internal server error

Debugging Tips

1. Check the details array - Each entry tells you which field failed and why
2. Nested paths - supports.0.2 means "first support, third element (bearing width)"
3. Case sensitivity - All enum values are case-sensitive ("Wet" not "wet")
4. Types matter - Numbers must be numbers, not strings (14 not "14")
5. Use the API reference - Interactive docs show exact expected types

Next Steps

• API Reference - Interactive endpoint testing with all valid values