Response Format

All API responses use the ApiResponse wrapper.

Fields

Field	Type	Description
version	String
timestamp	long
success	boolean
code	String
message	String
data	T

Factory Methods

ok(T)

Returns: ApiResponse<T>

Success response with data only.

ok(ResultCode, T)

Returns: ApiResponse<T>

Success response with ResultCode and data.

ok(String, String, T)

Returns: ApiResponse<T>

Success response with custom code, message and data.

fail(String, String)

Returns: ApiResponse<T>

Failure response with code and message.

fail(ResultCode)

Returns: ApiResponse<T>

Failure response from ResultCode.

fail(SlaunchxException)

Returns: ApiResponse<T>

Failure response from SlaunchxException.

fail(String, String, T)

Returns: ApiResponse<T>

Failure response with data (for validation errors).

okPaginated(Page<T>)

Returns: ApiResponse<Page<T>>

Success response for paginated data.

okWithPagination(List<T>, PaginationInfo)

Returns: ApiResponse<Map<String,Object>>

Success response with explicit pagination metadata.

noContent()

Returns: ApiResponse<Void>

No content response (204).

accepted()

Returns: ApiResponse<Void>

Accepted response (202).

accepted(T)

Returns: ApiResponse<T>

Accepted response with tracking information.

created(T)

Returns: ApiResponse<T>

Created response (201).

created(T, String)

Returns: ApiResponse<T>

Created response with location.

partialSuccess(T, List<String>)

Returns: ApiResponse<Map<String,Object>>

Partial success response.

validationFailed(ProcessResult)

Returns: ApiResponse<Map<String,List<String>>>

Validation failed response from ProcessResult.

validationFailed(Map<String,List<String>>)

Returns: ApiResponse<Map<String,List<String>>>

Validation failed response with custom error map.

rateLimitExceeded(long)

Returns: ApiResponse<Map<String,Object>>

Rate limit exceeded response (429).

okEmpty()

Returns: ApiResponse<Void>

Empty success response (no data).

okWithMessage(String)

Returns: ApiResponse<Map<String,String>>

Success response with a simple message.

Example Response

{
  "success": true,
  "code": null,
  "message": "OK",
  "data": { ... },
  "timestamp": 1711584000000
}