Output uses ConstantsTrait
Output response constants enumeration.
Provides standardized field names for API responses, JSON outputs, and structured data formats. These constants ensure consistency across different endpoints and response types.
Tags
Table of Contents
Constants
- ALLOWED : string = 'allowed'
- The allowed methods details.
- CODE : string = 'code'
- Status or error code identifier.
- COUNT : string = 'count'
- Number of items in the current result set.
- DETAILS : string = 'details'
- Detailed information or nested data structure.
- ERROR : string = 'error'
- Single error information.
- ERRORS : string = 'errors'
- Collection of error information.
- INFO : string = 'info'
- Informational message or metadata.
- LIMIT : string = 'limit'
- Maximum number of items requested.
- MESSAGE : string = 'message'
- Human-readable message.
- OFFSET : string = 'offset'
- Starting position for pagination.
- OPTIONS : string = 'options'
- Configuration options or parameters.
- OWNER : string = 'owner'
- Owner or creator identifier.
- PARAMS : string = 'params'
- Input parameters or arguments.
- POSITION : string = 'position'
- Current position or index.
- REASON : string = 'reason'
- Reason of the error or the context.
- REDIRECT : string = 'redirect'
- Redirect URL or location.
- RESULT : string = 'result'
- Main result data.
- STATUS : string = 'status'
- Operation status.
- SUCCESS : string = 'success'
- Success indicator.
- TIME : string = 'time'
- Timestamp or duration.
- TOTAL : string = 'total'
- Total number of available items.
- URL : string = 'url'
- URL or web address.
Constants
ALLOWED
The allowed methods details.
public
string
ALLOWED
= 'allowed'
CODE
Status or error code identifier.
public
string
CODE
= 'code'
Typically used for HTTP status codes or custom error codes.
COUNT
Number of items in the current result set.
public
string
COUNT
= 'count'
Represents the count of returned items, not the total available.
DETAILS
Detailed information or nested data structure.
public
string
DETAILS
= 'details'
Used for additional context or breakdown of the main result.
ERROR
Single error information.
public
string
ERROR
= 'error'
Contains error details for a single error condition.
ERRORS
Collection of error information.
public
string
ERRORS
= 'errors'
Array or list containing multiple error details.
INFO
Informational message or metadata.
public
string
INFO
= 'info'
Additional context or informational data about the response.
LIMIT
Maximum number of items requested.
public
string
LIMIT
= 'limit'
Pagination parameter indicating the limit applied to the query.
MESSAGE
Human-readable message.
public
string
MESSAGE
= 'message'
Descriptive text explaining the result, error, or status.
OFFSET
Starting position for pagination.
public
string
OFFSET
= 'offset'
Number of items skipped from the beginning of the result set.
OPTIONS
Configuration options or parameters.
public
string
OPTIONS
= 'options'
Settings or options that were applied during processing.
OWNER
Owner or creator identifier.
public
string
OWNER
= 'owner'
User, system, or entity that owns or created the resource.
PARAMS
Input parameters or arguments.
public
string
PARAMS
= 'params'
Parameters that were passed to generate the response.
POSITION
Current position or index.
public
string
POSITION
= 'position'
Indicates the current position within a sequence or collection.
REASON
Reason of the error or the context.
public
string
REASON
= 'reason'
REDIRECT
Redirect URL or location.
public
string
REDIRECT
= 'redirect'
URL where the client should be redirected after the operation.
RESULT
Main result data.
public
string
RESULT
= 'result'
Primary data payload of the response.
STATUS
Operation status.
public
string
STATUS
= 'status'
Indicates the current state or outcome of the operation.
SUCCESS
Success indicator.
public
string
SUCCESS
= 'success'
Boolean flag indicating whether the operation was successful.
TIME
Timestamp or duration.
public
string
TIME
= 'time'
Time-related information such as execution time or timestamp.
TOTAL
Total number of available items.
public
string
TOTAL
= 'total'
Complete count of items available, regardless of pagination limits.
URL
URL or web address.
public
string
URL
= 'url'
Web location or endpoint URL related to the response.