Documentation
¶
Index ¶
Constants ¶
View Source
const ( API_CODE_SUCCESS = 0 // API_CODE_SUCCESS indicates the request was processed successfully. API_CODE_FAILED = 1 // API_CODE_FAILED indicates the request failed. )
API response code constants used as the top-level status indicator in JSON responses.
Variables ¶
View Source
var ( // ErrorNotFound is returned when the requested resource does not exist. ErrorNotFound = &dto.ResponseMessage{Code: 404, Message: "record not found", Data: nil} // ErrorNoToken is returned when no token is present in the request. ErrorNoToken = &dto.ResponseMessage{Code: 400, Message: "token does not define", Data: nil} // ErrorBadToken is returned when the provided token is malformed or invalid. ErrorBadToken = &dto.ResponseMessage{Code: 400, Message: "token error", Data: nil} // ErrorExpiredToken is returned when the provided token has expired. ErrorExpiredToken = &dto.ResponseMessage{Code: 401, Message: "token expired", Data: nil} // ErrorPermissionToken is returned when the token lacks the required permission. ErrorPermissionToken = &dto.ResponseMessage{Code: 403, Message: "token has no permission", Data: nil} // ErrorInternalServer is returned for unexpected server-side errors. ErrorInternalServer = &dto.ResponseMessage{Code: 500, Message: "internal server error", Data: nil} // ErrorDatabase is returned when a database operation fails. ErrorDatabase = &dto.ResponseMessage{Code: 500, Message: "database error", Data: nil} )
Pre-defined ResponseMessage error values for common token and server errors.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.