API documentation Web hosting accessible to everyone Visit LWS

Schema

ApiEnvelope

Standard response envelope used by every endpoint of this API. Compose it with allOf and add a data property to describe the payload specific to one response.

  • code integer

    Application-level status/error code (not always equal to the HTTP status code)

    Example: 200

  • info string

    Human-readable message describing the result of the request

Example
{
  "code": 200,
  "info": "string"
}