Error Codes

Complete reference for all ceric exit codes and their meanings.

Overview

ceric uses structured exit codes to categorize different types of errors. Each category has a specific range of codes to help identify the source of the problem.

Error Categories

Range	Category	Description
0	Success	Operation completed successfully
1-19	Command Line	Command line and argument errors
20-29	File I/O	File input/output errors
30-39	Validation	Data validation errors
100-109	ERiC/Certificate	ERiC initialization and certificate errors
110-119	ERiC Header	ERiC header creation errors
120-129	XML Validation	XML validation errors
130-139	File Output	File output errors
140-149	ERiC Processing	ERiC processing errors
150-159	Buffer/Content	Buffer and content errors
160-169	ELSTER Server	ELSTER server communication errors
170-179	Download	Download operation errors
190-199	Internal	Internal application errors

Success Codes

Code	Meaning
0	OK - Operation completed successfully

Command Line Errors (1-19)

Code	Error	Description	Solution
1	Unknown or incomplete argument	Invalid command line argument provided	Check command syntax and parameters
2	Help displayed	--help or -h was used	Normal operation, not an error
3	Version displayed	--version or -v was used	Normal operation, not an error
10	Missing required argument	--pathXml <file> not provided	Provide input XML file path
11	Missing required argument	--dataType <dataType> not provided	Specify data type parameter
12	Unsupported data type	Data type not supported or configuration failed	Use supported data type
13	Invalid usecase	--usecase must be 'draft', 'send', 'transmit', or 'download'	Use valid usecase value
14	Data type print not supported	Data type doesn't support print operations	Use data type that supports PDF generation
15	Storage directory creation failed	Could not create storage directory	Check parent directory permissions
16	Storage path not a directory	Storage path exists but is not a directory	Provide valid directory path
17	Storage directory not writable	Storage directory is not writable	Check directory permissions
18	Storage directory error	Other storage directory related error	Check directory configuration
19	Missing required argument for download	--objectUuid <uuid> not provided for download usecase	Provide object UUID for download operations

File I/O Errors (20-29)

Code	Error	Description	Solution
20	Could not open input XML file	File access error	Check file path and permissions
30	Invalid UUID format	Object UUID is not in valid UUID v4 format	Use valid UUID v4 format

ERiC/Certificate Errors (100-109)

Code	Error	Description	Solution
100	Could not initialize ERiC instance	ERiC initialization failed	Check ERiC libraries and configuration
101	Could not load certificate	Certificate access error for send/transmit	Verify certificate path and PIN

ERiC Header Errors (110-119)

Code	Error	Description	Solution
110	Error while creating header	ERiC header creation failed	Check ERiC logs for details

XML Validation Errors (120-129)

Code	Error	Description	Solution
120	Content of XML after adding header incorrect	Header validation failed	Validate XML structure and content

File Output Errors (130-139)

Code	Error	Description	Solution
130	Could not create output file for XML with header	File write error	Check storage directory permissions

ERiC Processing Errors (140-149)

Code	Error	Description	Solution
140	Error while processing XML	ERiC processing failed	Inspect ceric processResult for ERiC errors and hints Additionally you might check ERiC logs and XML content.

Buffer/Content Errors (150-159)

Code	Error	Description	Solution
150	Process buffer content is empty	Unexpected empty result	Check ERiC processing logs
151	Server response content is empty	Unexpected empty result	Check server communication

ELSTER Server Errors (160-169)

Code	Error	Description	Solution
160	Server response contains errors	Server response contains error information	Review server response for error details

Download Errors (170-179)

Code	Error	Description	Solution
170	Could not initialize download use case	Download initialization failed	Check OTTO logs for details
171	Download completed but returned empty data	Otto download succeeded but no data received	Check download parameters
172	Error during Otto data download	Download operation failed	Check network connectivity and OTTO logs
173	Failed to write downloaded data to file	File write error for download output	Check storage directory permissions

Internal Errors (190-199)

Code	Error	Description	Solution
190	Internal error: no exit code determined	Unexpected internal state	Report as bug with full context

Error Handling in PHP SDK

The PHP SDK provides structured error handling through the result objects:

<?php
use Rechtlogisch\MiniEric\Ceric;
use Rechtlogisch\MiniEric\Dto\CericInput;

$ceric = new Ceric();
$result = $ceric->draft(new CericInput(
    dataType: 'Kontoinformation',
    pathXml: 'info.xml',
    pathStorage: '/storage/'
));

// Check binary exit code
if ($result->cericOutput->exitCode !== '0') {
    $exitCode = (int) $result->cericOutput->exitCode;
    
    switch (true) {
        case $exitCode >= 1 && $exitCode <= 19:
            echo "Command line error: " . $result->cericOutput->message;
            break;
        case $exitCode >= 20 && $exitCode <= 29:
            echo "File I/O error: " . $result->cericOutput->message;
            break;
        case $exitCode >= 100 && $exitCode <= 109:
            echo "ERiC/Certificate error: " . $result->cericOutput->message;
            break;
        case $exitCode >= 110 && $exitCode <= 119:
            echo "ERiC header error: " . $result->cericOutput->message;
            break;
        case $exitCode >= 120 && $exitCode <= 129:
            echo "XML validation error: " . $result->cericOutput->message;
            break;
        case $exitCode >= 130 && $exitCode <= 139:
            echo "File output error: " . $result->cericOutput->message;
            break;
        case $exitCode >= 140 && $exitCode <= 149:
            echo "ERiC processing error: " . $result->cericOutput->message;
            break;
        case $exitCode >= 150 && $exitCode <= 159:
            echo "Buffer/content error: " . $result->cericOutput->message;
            break;
        case $exitCode >= 160 && $exitCode <= 169:
            echo "ELSTER server error: " . $result->cericOutput->message;
            break;
        case $exitCode >= 170 && $exitCode <= 179:
            echo "Download error: " . $result->cericOutput->message;
            break;
        case $exitCode >= 190 && $exitCode <= 199:
            echo "Internal error: " . $result->cericOutput->message;
            break;
        default:
            echo "Unknown error: " . $result->cericOutput->message;
    }
    
    // Check for ERiC specific error details
    if ($result->cericOutput->ericCode !== null) {
        echo "ERiC Code: " . $result->cericOutput->ericCode;
    }
    if ($result->cericOutput->ericMessage !== null) {
        echo "ERiC Message: " . $result->cericOutput->ericMessage;
    }
    
    return;
}

// Success case
echo "Operation completed successfully!";

Common Error Scenarios

Missing Dependencies

Error Code: 100

Could not initialize ERiC instance

Common Causes:

• ERiC libraries not found

• Incorrect library path

• Missing required libraries

Solutions:

1. Verify ERiC libraries are in the correct directory

2. Check PATH_VENDOR environment variable

3. Ensure all required library files are present

Note: For detailed environment variable configuration, see Environment Variables.

Certificate Issues

Error Code: 101

Could not load certificate

Common Causes:

• Certificate file not found

• Invalid certificate PIN

• Corrupted certificate file

Solutions:

1. Check certificate file path

2. Verify certificate PIN

3. Test with default test certificate

XML Validation Failures

Error Code: 120

Content of XML after adding header incorrect

Common Causes:

• Invalid XML structure

• Missing required elements

• Incorrect data type specification

Solutions:

1. Validate XML with xmllint

2. Check XML against ELSTER schema

3. Verify data type matches XML content

Permission Errors

Error Code: 15-18, 130, 173

Storage directory creation failed
Storage directory not writable
Could not create output file

Common Causes:

• Insufficient directory permissions

• Read-only file system

• Disk space issues

Solutions:

1. Check directory permissions

2. Ensure sufficient disk space

3. Verify write access to storage directory

Related Topics

• Troubleshooting Guide - Common issues and solutions

• CLI Reference - Complete command-line reference