RESTAPI:Error Codes
Aus Cryptshare Documentation
General Notes
The Cryptshare Server as well as the APIs return specific error codes when a problem occurs. As a developer, you can use these error codes to help determine the cause of the error and to show a user friendly feedback message. The error code is contained in the exception object and can be retrieved using the getCode() method. The exception's getMessage() method returns the generic error message.
The following table lists the error codes and generic message texts that are returned by the Cryptshare Server.
| Error Code | Generic Error Message | Description |
|---|---|---|
| 10 | The requesting product is not licensed: xyz | The Cryptshare Server license does not grant the use of this product. |
| 30 | Wrong use of the Cryptshare service. The request cannot be handled. | Wrong use of the Cryptshare service. The request cannot be handled. |
| 40 | The request is invalid. The following parameter is missing: xyz | The submitted request is missing a required parameter. |
| 41 | The given data is not valid: xyz | Due to specific server or policy settings the request with the given data is not allowed to be performed. |
| 60 | This client/sender is not verified yet. The requested operation is only allowed for verified clients. | This client or sender is not verified, and the requested operation is only allowed for verified clients and senders. |
| 220 | The requesting WSDL Client is not authorized to use this service. Permission denied! | The client is not authorized to use the requested service. |
| 230 | The Cryptshare Server reported an error. Please refer to the Cryptshare Server logs for more details. | The Crypshare Server encountered an unspecified error. Check the server logs. |
| 240 | The Cryptshare Server was unable to send/load the requested e-mail. An error occurred. Please refer to the Cryptshare Server log files for more details. | The Cryptshare Server encountered an error while trying to send or load the requested e-mail. |
| 250 | The specified session could not be found. The request is invalid: xyz | The specified session could not be found. The request is invalid. |
| 260 | A file processing error occurred: xyz | A file processing error occurred. |
| 5000 | An unspecified failure occurred | The cause for this error could not be determined. The Cryptshare Server logs should be checked. |
Java API Error Codes
The following error codes and generic error messages are returned by the Java API.
| Error Code | Generic Error Message | Description |
|---|---|---|
| 105 | Error parsing the WSDL XML file. This can happen when trying to access the WSDL file via HTTP, when the server requires secure HTTPS access. Please check your server's connection settings. | A WSDL file was expected but the server response was not a valid WSDL file. This is the case when the client tries to access the server using HTTP, but the server is configured to require HTTPS access. In this case the server will not send back the WSDL file, but a redirect request. |
| 110 | Error initializing client | The client could not be initialized. Maybe the client store was corrupted, or a connection to the server could not be established. |
| 115 | Error generating client ID | A client ID could not be created. |
| 120 | Error initializing web service operation | The web service operation could not be initialized. |
| 130 | Error performing web service operation | An error occurred while trying to perform the web service operation. |
| 140 | Error while trying to generate a password | A password could not be generated by the server and an error also occurred while trying to generate a password locally. |
| 170 | Invalid verification store | The client's verification store does not contain valid data. |
| 190 | Illegal argument, or in specific cases:
Invalid message text Invalid subject text Invalid confidential message text Invalid confidential subject text The recipients list cannot be null or empty. |
A given argument is not valid for the requested operation. For example, the message or subject text contains illegal characters, or the recipients list is not specified. |