```
public class ApiEnvelope
extends java.lang.Object
```
Envelope/wrapper for API responses. This class standardizes the JSON shape returned by the API by always including the apiVersion and optionally including either a successful payload (message/data) or an error description (error). It is typically created via one of the static wrap(...) factory methods. Use asJsonNode() to obtain a JsonNode representation of the envelope, or asJsValue() to obtain a Play JsValue. Note: An instance is intended to represent either a success response or an error response. If an ApiEnvelope.ErrorCode is present, the envelope is treated as an error regardless of any provided data.

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`com.fasterxml.jackson.databind.JsonNode`	`asJsonNode()`
`play.api.libs.json.JsValue`	`asJsValue()`
`static ApiEnvelope`	`wrap(com.fasterxml.jackson.databind.JsonNode data)`
`static ApiEnvelope`	`wrap(java.lang.Object obj)`
`static ApiEnvelope`	`wrap(java.lang.String message)`
`static ApiEnvelope`	`wrap(java.lang.String message, com.fasterxml.jackson.databind.JsonNode data)`
`static ApiEnvelope`	`wrap(java.lang.String message, ApiEnvelope.ErrorCode errorCode)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

public static ApiEnvelope wrap(java.lang.Object obj)

public static ApiEnvelope wrap(com.fasterxml.jackson.databind.JsonNode data)

public static ApiEnvelope wrap(java.lang.String message)

public static ApiEnvelope wrap(java.lang.String message,
                               com.fasterxml.jackson.databind.JsonNode data)

public static ApiEnvelope wrap(java.lang.String message,
                               ApiEnvelope.ErrorCode errorCode)

public com.fasterxml.jackson.databind.JsonNode asJsonNode()

public play.api.libs.json.JsValue asJsValue()

Class ApiEnvelope