Common Response Envelope
Every route returns:
{
"status": "success"
}
Field format and behavior:
| Field | JSON type | Format | Presence rules |
|---|---|---|---|
status | string | success or error | Always present |
data | object/null | Route-specific data | Present only for some successful responses |
code | integer/null | Error code | Typically 1 on status=error; usually omitted on success |
message | string/null | Diagnostic message | Usually present on status=error; usually omitted on success |
Parsing recommendation:
- Always parse by
statusfirst. - Treat
dataas route-specific and optional. - Do not rely on
messagetext for business logic; usecodeand route context.