Error Codes and Messages - saayam-for-all/docs GitHub Wiki
In Saayam For All applications - web app and mobile app - all messages - informational, warning and error messages, should have this format: SAAYAM-:. E.g. SAAYAM-1: New help request creation is successful. Request with ID has been created.
Color codes: Information messages have to be in GREEN, warning messages have to be in YELLOW/ORANGE and error messages have to be in RED color
Error message: 1. Error code 2. Error message 3. How the end user can resolve this error if this is an end user error 4. If this is a server side error, who to contact to get this error fixed. E.g. SAAYAM-200: New help request creation failed. Request subject contains foul language. Please fix the language and resubmit the request.
All end user facing messages need to support I18N (Internationalization) and L10N (Localization)
We divide the error/message codes into following ranges:
-
Front end client codes e.g 0-999
- web app codes 0-499
- Informational messages 0-199
- Error messages 200-399
- Warning messages: 400-499
- mobile app codes - 500 - 999
- web app codes 0-499
-
Backend messages codes e.g 1000-5000
-
Lambda function codes 1000-1199
-
Volunteer micro service codes 1200-1399
-
Request micro service codes 1400-1599
-
ML micro service codes 1600-1799