API Error Codes List
When running an API function, IF any error occurs, the following message format will be received:
{
"ResponseCode":7,
"ResponseMsgEng":"please fill up all the required fields"
}
This page presents all possible Response Codes, from all the modules.
| Response Code | Message in English |
|---|---|
| 0 | "Success" or any other hint text. This is the common code for "function succeed". |
| 2 |
No Results / Data.
note: Function code run successfully, but there is no data to deliver. |
Common Error Messages: |
|
| 3 | API function does not exist. |
| 4 | Database Error on server side. |
| 5 | Technical Error on server side. |
| 6 | Technical Error: Client Session not found. |
| 7 | Please fill up the required fields. |
| 8 | You are NOT Authorized to access this Data / Function. |
| 9 | Please fill in the fields in the Acceptable Languages. (Acceptable Language List) |
| 10 | User is already connected on this session (Logged in). |
| 11 | Security Alert: + [description]. |
| 12 | This entity is already locked by another user. |
| 13 |
The new password must be at least 8 characters long and contain 2 digits and 3 letters.
When using English ONLY, it is mandatory to combine uppercase and lowercase letters. |
| 14 |
Posted fields contain wrong data and/or missing fields.
note: In this case Wrong data (or entity) is the major problem! and maybe there are missing fields as well (like in code 7). |
Documents Module Error Messages: |
|
| 15 | Missing parameter "Target_Folder" (Negative int) for exist folder, OR "Folder_Uid" (Positive int) for Prototype folder ID. |
| 16 | You cannot upload files with an Extension other then: JPG,JPEG,PNG,PDF,TIF/f,DOC/x,XLS/x |
| 17 | You cannot upload files with size larger than 50 Megabytes. |
| 18 | You cannot delete this file ("[ FileName ]") |
Entities Related Error Messages: |
|
| 20 | Account does not Exists in Hyper. |
| 21 | Client does not Exists in Hyper. |
| 22 | Supplier does not Exists in Hyper. |
| 23 | Project does not Exists in Hyper. |
| 24 |
No answer from Index module.
Check that Hyper's "Server Side App" is up and running, The index module contained in it. |
| 25 | E-mail address: [EMail Field Content] is not valid. |
| 26 | Phone number: [Phone Field Content] is not valid. |
| 27 | Registration is allowed for people aged [Minimum Age] and over. |
| 28 |
The new password must be at least 8 characters long and contain 2 digits and 3 letters.
When using English ONLY, it is mandatory to combine uppercase and lowercase letters. |
| 29 | The ID Number did not passed the control digit test. |
| 30 | A form with identical information has already been submitted. |
| 31 | Client already registered before with different details. (like same ID number with different Email or Phone) |
Payments Related Error Messages: |
|
| 40 | Cannot use this (stored) payment method. |
| 41 | Credit Card Clearing was failed. |
| 42 | Credit Card Transaction Approved. This is not an error message... |
HTTP response code
All Success responses and some of the errors will return underHTTP 200 OK
.
The rest will return under HTTP error codes, here are some examples:
HTTP/1.1 200 OK HTTP/1.1 400 Bad Request HTTP/1.1 401 Unauthorized HTTP/1.1 403 Forbidden HTTP/1.1 404 Not Found HTTP/1.1 406 Not Acceptable HTTP/1.1 416 Range Not Satisfiable HTTP/1.1 422 Unprocessable Entity HTTP/1.1 500 Internal Server Error HTTP/1.1 501 Not Implemented HTTP/1.1 503 Service Unavailable