Default response¶

This is the default response body for the project. Refer to jsend for more detail on the standard.

Key	Type	Value	Description
status	string	"success", "failed", "error"	status to indicated the response status
message	string	""	only used the status is error
data	map[string]any	"data":{"test1":"value"}	detail for the response
xid	string	"061b8631-0caa-4ec0-8b6f-fe9e43703dd0"	xid string for debugging and tracing purpose

Status detail¶

Type	Description	Required Keys	Optional Keys
success	All went well, and (usually) some data was returned.	status, data
fail	There was a problem with the data submitted, or some pre-condition of the API call wasn't satisfied	status, data
error	An error occurred in processing the request, i.e. an exception was thrown	status, message	code, data

Files (0)