Commercetools\Api\Models\Error\ErrorResponse Interface Reference

Inheritance diagram for Commercetools\Api\Models\Error\ErrorResponse:

Public Member Functions
	getStatusCode ()
	getMessage ()
	getErrors ()
	setStatusCode (?int $statusCode)
	setMessage (?string $message)
	setErrors (?ErrorObjectCollection $errors)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (callable $callable=null)

Public Attributes
const	FIELD_STATUS_CODE = 'statusCode'
const	FIELD_MESSAGE = 'message'
const	FIELD_ERRORS = 'errors'

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\JsonObject
static	of ($data=null)
static	fromArray (array $data=[])
static	fromStdClass (stdClass $data=null)

Detailed Description

Definition at line 15 of file ErrorResponse.php.

Member Function Documentation

getErrors()

Commercetools\Api\Models\Error\ErrorResponse::getErrors

(

)

Errors returned for a request.

A single error response can contain multiple errors if the errors are related to the same HTTP status code such as 400.

Returns

null|ErrorObjectCollection

Implemented in Commercetools\Api\Models\ProductSearch\ProductSearchErrorResponseModel, Commercetools\Api\Models\ProductSearch\ProductSearchErrorResponse, Commercetools\Api\Models\Error\ErrorResponseModel, Commercetools\Api\Models\Error\AuthErrorResponseModel, and Commercetools\Api\Models\Error\AuthErrorResponse.

getMessage()

Commercetools\Api\Models\Error\ErrorResponse::getMessage

(

)

First error message in the errors array.

Returns

null|string

Implemented in Commercetools\Api\Models\ProductSearch\ProductSearchErrorResponseModel, Commercetools\Api\Models\ProductSearch\ProductSearchErrorResponse, Commercetools\Api\Models\Error\ErrorResponseModel, and Commercetools\Api\Models\Error\AuthErrorResponseModel.

getStatusCode()

Commercetools\Api\Models\Error\ErrorResponse::getStatusCode

(

)

HTTP status code corresponding to the error.

Returns

null|int

Implemented in Commercetools\Api\Models\ProductSearch\ProductSearchErrorResponseModel, Commercetools\Api\Models\ProductSearch\ProductSearchErrorResponse, Commercetools\Api\Models\Error\ErrorResponseModel, and Commercetools\Api\Models\Error\AuthErrorResponseModel.

setErrors()

Commercetools\Api\Models\Error\ErrorResponse::setErrors

(

?ErrorObjectCollection

$errors

)

Parameters

?ErrorObjectCollection

$errors

Implemented in Commercetools\Api\Models\ProductSearch\ProductSearchErrorResponseModel, Commercetools\Api\Models\ProductSearch\ProductSearchErrorResponse, Commercetools\Api\Models\Error\ErrorResponseModel, Commercetools\Api\Models\Error\AuthErrorResponseModel, and Commercetools\Api\Models\Error\AuthErrorResponse.

setMessage()

Commercetools\Api\Models\Error\ErrorResponse::setMessage

(

?string

$message

)

Parameters

?string

$message

Implemented in Commercetools\Api\Models\ProductSearch\ProductSearchErrorResponseModel, Commercetools\Api\Models\ProductSearch\ProductSearchErrorResponse, Commercetools\Api\Models\Error\ErrorResponseModel, and Commercetools\Api\Models\Error\AuthErrorResponseModel.

setStatusCode()

Commercetools\Api\Models\Error\ErrorResponse::setStatusCode

(

?int

$statusCode

)

Parameters

?int	$statusCode

Implemented in Commercetools\Api\Models\ProductSearch\ProductSearchErrorResponseModel, Commercetools\Api\Models\ProductSearch\ProductSearchErrorResponse, Commercetools\Api\Models\Error\ErrorResponseModel, and Commercetools\Api\Models\Error\AuthErrorResponseModel.

Member Data Documentation

FIELD_ERRORS

const Commercetools\Api\Models\Error\ErrorResponse::FIELD_ERRORS = 'errors'

Definition at line 19 of file ErrorResponse.php.

FIELD_MESSAGE

const Commercetools\Api\Models\Error\ErrorResponse::FIELD_MESSAGE = 'message'

Definition at line 18 of file ErrorResponse.php.

FIELD_STATUS_CODE

const Commercetools\Api\Models\Error\ErrorResponse::FIELD_STATUS_CODE = 'statusCode'

Definition at line 17 of file ErrorResponse.php.

---

The documentation for this interface was generated from the following file:

• lib/commercetools-api/src/Models/Error/ErrorResponse.php