Appendix
General status codes
Each return is hold with one of the following status codes.
200 | OK |
---|---|
400 | Erroneous parameter or specific errors within a API-call. |
401 | Login-error, invalid token, account in quarantine |
403 | The feature can not be used because it is not available in the account or the feature limit is exceeded. |
424 | The current Terms and Conditions of Service were not (yet) accepted by the user. |
500 | General server error. In this case contact the FOXDOX-support. |
Specific error codes
Additionally to the status code, in case of an error an error code is returned. This code gives detailed information on the error.
201100 | General error |
---|---|
201101 | Parameter is empty but a value is expected. |
201102 | Parameter is in wrong format (GUID, e-mail, etc.) |
201103 | Invitation code was not found |
201104 | Error while registering: User name is already in use. |
201105 | Error while registering: E-mail address is already in use. |
201106 | Error while registering: Invalid character in user name |
201107 | Error while registering: User name is blocked |
201108 | Error while registering: Mail domain locked |
201109 | Error while registering: User name is too short, at least 4 characters |
201110 | The password does not comply with the guidelines. It must consist of at least 8 characters and must not be easy to guess. |
201111 | Error while registering: The activation code could not be sent, e-mail address unknown |
201142 | Error while registering: Invalid country code |
201112 | Error while registering: Activation code is invalid. |
201113 | Error during contact search: Keyword is too short, at least 3 characters |
201114 | Contact (user name) not found |
201115 | Contact group not found |
201116 | Contact group already exists |
201117 | Document type is already in use. |
201118 | Document type not found |
201119 | Attribute is already assigned |
201120 | Attribute not found. |
201121 | Document not found |
201122 | Document can not be moved: Document or folder not found |
201123 | Document type can not be changed: Document or document type not found |
201124 | Document could not be moved to the recycle bin |
201125 | Document could not be restored from recycle bin |
201126 | Document could not be sent. |
201150 | Document is still being processed. |
201127 | Folder not found |
201128 | Folder already exists |
201129 | Folder is not empty |
201130 | Folder can not be moved: Source folder or target folder not found or target folder is subordinate folder |
201131 | Upload-error: File is empty (0 bytes) |
201132 | Upload-error: File type not permitted |
201133 | Upload-error: File could not be encrypted |
201147 | Upload-error: File is encrypted |
201149 | Upload-error: File size exceeds the upload limit |
201134 | Key already exists in the key ring |
201135 | Password for key could not be changed |
201136 | Key is already in use. |
201137 | Key not found |
201138 | Message not found |
201139 | The message could not be sent: Sender not found |
201140 | The message could not be sent: Recipient not found |
201141 | Invitation could not be sent, e-mail address is already registered. |
201143 | Token for the reset of a password was not found |
201144 201145 | Provider could not be found Provider service could not be found |
201146 | Provider has no services |
201148 | Document is flagged as audit-proof and can not be deleted. |
201154 | The service key was not found |
201155 | The service key is invalid or expired |
201156 | The ID for the change of the e-mail could not be found |
201157 | The provider of this service is the system provider. The service status must not be changed. |
201158 | Wrong password for key ring |
201159 | Key ring is blocked (too many wrong password attempts) |
201160 | A subscriber with this user ID already exists. |
201161 | No changes can be done on a provider folder. |
201162 | The delete request could not be found |
201168 | Error during publishing: the password is to short, at least 3 characters |
201173 | Insufficient rights for this operation. |
202101 | Login failed: User name was not found |
202102 | Login failed: E-mail address was not found. |
202103 | Login failed: Invalid user name name or password |
202104 | Login failed: Account is not active |
202105 | Token is invalid. |
202106 | Login failed: Test account is expired |
202107 | Login failed: Password was entered too often wrong. |
203101 | Feature not booked, limit exceeded, or time range expired. |
203102 | Not enough free space for document available. |
204101 | Terms and Conditions of Service were not accepted. |
204102 | Privacy Policy was not accepted |
205100 | Internal server error |
206100 | Client error |
206101 | X-Brand-Header is invalid |
207101 | Data for third party authentication (NPA, 2-factor) already exist |
299999 | The function is not available due to maintenance |
Country codes
foxdox is restricted to user from the EU states and Switzerland. In the following list all country codes are contained which are used in foxdox . The country code applies to the numeric code based on ISO 3166.
056 | Belgien | Belgium |
---|---|---|
100 | Bulgarien | Bulgaria |
208 | Dänemark | Denmark |
276 | Deutschland | Germany |
233 | Estland | Estonia |
246 | Finnland | Finland |
250 | Frankreich | France |
300 | Griechenland | Greece |
372 | Irland | Ireland |
380 | Italien | Italy |
428 | Lettland | Latvia |
440 | Litauen | Lithunia |
442 | Luxemburg | Luxembourg |
470 | Malta | Malta |
528 | Niederlande | Netherlands |
040 | Österreich | Austria |
616 | Polen | Poland |
620 | Portugal | Portugal |
642 | Rumänien | Romania |
752 | Schweden | Sweden |
756 | Schweiz | Switzerland |
703 | Slowakei | Slovakia |
705 | Slowenien | Slovenia |
724 | Spanien | Spain |
203 | Tschechien | Czech Republic |
348 | Ungarn | Hungary |
826 | Vereinigtes Königreich | United Kingdom |
196 | Zypern | Cyprus |
foxdox features
Depending on the booked package the user has access to different functions (features). In the following list all features are contained which are not contained by default. If an API function is called for which the respective feature of the respective user is not booked, the API reacts with the status 403.
7B21B97C-304B-42A0-B3D4-3F90AFDF716F | Memory |
---|---|
A3B54AE4-6E04-48B2-98E3-D13F9F438605 | Group functions |
CDABD57D-449C-4FF2-A375-9000DC9E3735 | Advanced encrypted data storage |
A1D492DC-52BB-4832-B9AD-0A9E965C4383 | Send documents |
F044324D-304C-4F26-87B7-9AE3CD7EA5C8 | Document type management |
0CD38741-439B-4E8D-883F-98C1E64EED7D | Advanced classification with attribute extraction |
48146127-533e-4925-98b9-8b5654b12952 | Offline function |
5a36ea0d-6c57-4435-a608-bcb5caf97c09 | Audit-proof compliance |
7e5a2161-d3a5-437e-9c8e-0756782e9b07 | Versioning |
7E85951D-DF88-47D2-98A4-A7E5B7A2030F | Webscan |
b32db7b7-8652-4560-a0e8-fdbd3c40a480 | Maximum upload file size |
foxdox notification events
With the foxdox notification system a user can be informed by e-mail, foxdox system message or push message on certain events.
1 | 65537 | User received a document |
---|---|---|
2 | 65538 | The document was shared |
3 | 65539 | The document was unshared |
4 | 65540 | A new version was uploaded for shared document |
5 | 131073 | Service request declined by provider |
6 | 131074 | Service request accepted by provider |
7 | 131075 | Service stopped by provider |
8 | 131076 | Service subscription canceled by provider |
9 | 131077 | Document was delivered by the service |
10 | 131078 | A user has successfully send a document to a provider |
11 | 196609 | Contact request received |
12 | 196610 | Contact request was declined |
13 | 196611 | Contact request was accepted |
14 | 196612 | Invitation to use foxdox was sent |
15 | 196613 | foxdox-invitation was accepted |
16 | 262145 | A user has requested the activation mail |
17 | 262146 | A user has requested the password reset mail |
18 | 262147 | A user has set a new password after confirming the request |
19 | 262148 | A user has changed his password |
20 | 262149 | A user has requested to change his email address |
21 | 262150 | A user has changed his email address after confirming the request |
22 | 262151 | A user has changed his username |
23 | 262152 | A user has requested an e-mail with the current terms and conditions |
24 | 262153 | A user has requested an e-mail with the current privacy policy |
25 | 262154 | A user has requested to delete his account |
26 | 262155 | A user has confirmed to delete his account |
27 | 262156 | The user account was deleted |
28 | 262157 | A shared folder was renamed |
29 | 262158 | A shared document was changed |
30 | 262159 | User account was created |
31 | 327681 | User account was locked |
32 | 458753 | Folder access granted |
33 | 458754 | Folder access rejected |
34 | 268566529 | A service subscription has been requested by user |
35 | 268566530 | A service subscription has been declined by provider |
36 | 268566531 | A service subscription has been accepted by provider |
37 | 268566532 | A service subscription has been resigned by user |
38 | 268566533 | A service subscription has been dismissed by provider |
39 | 268566534 | A service has been deleted by provider |
40 | 268500993 | A document has been successfully delivered by provider |
41 | 268500994 | A document has not been successfully delivered by provider |
42 | 268500995 | A document has been received from user |
43 | 268632065 | Initial-account-creation worker successfully finished a job |
44 | 268632066 | Initial-account-creation worker unsuccessfully finished a job |
45 | 268632068 | Quicksubscription-creation worker successfully finished a job |
46 | 268632067 | Quicksubscription-creation worker unsuccessfully finished a job |
47 | 268632069 | Initial-account-deletion worker successfully finished a job |
48 | 268632070 | Initial-account-deletion worker unsuccessfully finished a job |
49 | 1342242817 | A provider started a document delivery job |
50 | 268632071 | Quicksubscription-deletion worker unsuccessfully finished a job |
51 | 268632072 | Quicksubscription-deletion worker successfully finished a job |
Konfigurierbare Ereignisse
EventId - Decimal | EventId - Hex | Description |
---|---|---|
196611 | 0x00030003 | ContactRequestAccepted |
196609 | 0x00030001 | ContactRequestReceived |
196610 | 0x00030002 | ContactRequestRefused |
65538 | 0x00010002 | ProviderDocumentDeliveredFailure |
65539 | 0x00010003 | ProviderDocumentReceived |
65537 | 0x00010001 | InternalDocumentDeliveryJobStarted |
65540 | 0x00010004 | DocumentNewVersion |
131075 | 0x00020003 | ServiceDismissed |
131074 | 0x00020002 | ProviderServiceSubscriptionDeclined |
131073 | 0x00020001 | ServiceRequestRefused |
131076 | 0x00020004 | ServiceSubscriptionDismissed |
131077 | 0x00020005 | ServiceDocumentDelivered |
262158 | 0x0004000E | SharedDocumentChanged |
262157 | 0x0004000D | SharedFolderRenamed |
458753 | 0x00070001 | FolderAccessGranted |
458754 | 0x00070002 | FolderAccessRejected |