RestResult
api
Minimal REST response structure. Derive this structure to add response data and error codes.
Tags
| since | 2.0.1 |
|---|
API synthesis
List of the public API methods. When manipulating RestResult, You can call those methods:
-
__construct() — Default constructor - ok!
Public methods
__construct
api public
Default constructor - ok!
public __construct()
Parameters
none
Constants
INTERNAL_ERROR
Result: the operation could not be performed, see the message for troubleshooting
Tags
| api |
|---|
INVALID_JSON
Result: the input structure is not a valid JSON string
Tags
| api |
|---|
INVALID_PAGE
Result: the request page number is not valid. It must be an integer greater than 0
Tags
| api |
|---|
MISSING_AUTH_PWD
Result: the parameter 'auth_pwd' is missing, authentication aborted
Tags
| api |
|---|
MISSING_AUTH_USER
Result: the parameter 'auth_user' is missing, authentication aborted
Tags
| api |
|---|
MISSING_JSON
Result: the parameter 'json_data' is missing
Tags
| api |
|---|
MISSING_VERSION
Result: the parameter 'version' is missing
Tags
| api |
|---|
OK
Result: no issue has been encountered
Tags
| api |
|---|
UNAUTHORIZED
Result: missing/wrong credentials or the user does not have enough rights to perform the requested operation
Tags
| api |
|---|
UNKNOWN_OPERATION
Result: the requested operation is not valid for the specified version
Tags
| api |
|---|
UNSAFE
Result: the requested operation cannot be performed because it can cause data (integrity) loss
Tags
| api |
|---|
UNSUPPORTED_VERSION
Result: no operation is available for the specified version
Tags
| api |
|---|
latest/customization/api/extensions/restresult.txt ·
Last modified: 2024/09/10 10:25 by 127.0.0.1