EPFO-PCP

Common standard JSON scheme to handle exceptions and logging errors that includes attributes for error codes, messages, and other relevant information. This will be part of every response from a service. The error code has a format ERR_<4 digit number>. The error codes may be mapped with messages in .property files. The technical details on errors/warnings will be logged in log files

"{
""data"": ""response data"" //relevant and read in client-side only when status attribute value is success
""status"": ""string"", // e.g., ""success"", ""error"", ""warning""
""errorCode"": ""string"", // A code representing the specific error. codes like ERR-<4 digit code>. Definition / mapping to message to do in server side property files.
""errorMessage"": ""string"", // A human-readable message describing the error.
""timestamp"": ""string"", // Timestamp of when the error occurred
""details"": ""object"", // Optional object to include additional details
""source"": ""string"", // Source of the error, e.g., ""database"", ""api"", ""validation""
""traceId"": ""string"", // Unique identifier for tracking the request
""userMessage"": ""string"", // A user-friendly message to be shown to the end user
""logLevel"": ""string"" // Log level e.g., ""INFO"", ""WARN"", ""ERROR""
}"
"{
""status"": ""error"",
""errorCode"": ""ERR_0001"",
""errorMessage"": ""Failed to retrieve data from the database."",
""timestamp"": ""2024-06-02T15:04:05Z"",
""details"": {
""query"": ""SELECT * FROM users WHERE id = 123"",
""parameters"": {
""id"": 123
}
},
""source"": ""database"",
""traceId"": ""abc123xyz"",
""userMessage"": ""An error occurred while fetching your data. Please try again later."",
""logLevel"": ""ERROR""
}"
"status: Indicates the result of the operation, such as ""success"", ""error"", or ""warning"".
errorCode: A specific code identifying the type of error, which can be used for both debugging and displaying a user-friendly error message.
errorMessage: A detailed message explaining what went wrong, intended primarily for developers or logs.
timestamp: The time when the error occurred, which helps in tracking and logging.
details: An optional object that can include any additional information relevant to the error, such as SQL queries, parameters, stack traces, etc.
source: Indicates where the error originated, such as ""database"", ""api"", or ""validation"", which helps in pinpointing the issue.
traceId: A unique identifier for the request or operation, useful for tracing the error through logs and across different services.
userMessage: A simplified and user-friendly message that can be displayed to the end user.
logLevel: The severity level of the error, which can help in filtering and prioritizing log entries."

the field C_OFFICE_ID to be checked with logged in da user's office ID