Commercetools\Import\Models\Errors\ErrorResponse Interface Reference

Inheritance diagram for Commercetools\Import\Models\Errors\ErrorResponse:

Public Member Functions
	getStatusCode ()
	getMessage ()
	getError ()
	getError_description ()
	getErrors ()
	setStatusCode (?int $statusCode)
	setMessage (?string $message)
	setError (?string $error)
	setError_description (?string $error_description)
	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_ERROR = 'error'
const	FIELD_ERROR_DESCRIPTION = 'error_description'
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 14 of file ErrorResponse.php.

Member Function Documentation

getError()

Commercetools\Import\Models\Errors\ErrorResponse::getError

(

)

This property is only used for OAuth2 errors. Contains the error code.

Returns

null|string

Implemented in Commercetools\Import\Models\Errors\ErrorResponseModel.

getError_description()

Commercetools\Import\Models\Errors\ErrorResponse::getError_description

(

)

This property is only used for OAuth2 errors. Additional information to assist the client developer in understanding the error.

Returns

null|string

Implemented in Commercetools\Import\Models\Errors\ErrorResponseModel.

getErrors()

Commercetools\Import\Models\Errors\ErrorResponse::getErrors

(

)

The errors that caused this error response.

Returns

null|ErrorObjectCollection

Implemented in Commercetools\Import\Models\Errors\ErrorResponseModel.

getMessage()

Commercetools\Import\Models\Errors\ErrorResponse::getMessage

(

)

Describes the error.

Returns

null|string

Implemented in Commercetools\Import\Models\Errors\ErrorResponseModel.

getStatusCode()

Commercetools\Import\Models\Errors\ErrorResponse::getStatusCode

(

)

The HTTP status code of the response.

Returns

null|int

Implemented in Commercetools\Import\Models\Errors\ErrorResponseModel.

setError()

Commercetools\Import\Models\Errors\ErrorResponse::setError

(

?string

$error

)

Parameters

?string

$error

Implemented in Commercetools\Import\Models\Errors\ErrorResponseModel.

setError_description()

Commercetools\Import\Models\Errors\ErrorResponse::setError_description

(

?string

$error_description

)

Parameters

?string

$error_description

Implemented in Commercetools\Import\Models\Errors\ErrorResponseModel.

setErrors()

Commercetools\Import\Models\Errors\ErrorResponse::setErrors

(

?ErrorObjectCollection

$errors

)

Parameters

?ErrorObjectCollection

$errors

Implemented in Commercetools\Import\Models\Errors\ErrorResponseModel.

setMessage()

Commercetools\Import\Models\Errors\ErrorResponse::setMessage

(

?string

$message

)

Parameters

?string

$message

Implemented in Commercetools\Import\Models\Errors\ErrorResponseModel.

setStatusCode()

Commercetools\Import\Models\Errors\ErrorResponse::setStatusCode

(

?int

$statusCode

)

Parameters

?int	$statusCode

Implemented in Commercetools\Import\Models\Errors\ErrorResponseModel.

Member Data Documentation

FIELD_ERROR

const Commercetools\Import\Models\Errors\ErrorResponse::FIELD_ERROR = 'error'

Definition at line 18 of file ErrorResponse.php.

FIELD_ERROR_DESCRIPTION

const Commercetools\Import\Models\Errors\ErrorResponse::FIELD_ERROR_DESCRIPTION = 'error_description'

Definition at line 19 of file ErrorResponse.php.

FIELD_ERRORS

const Commercetools\Import\Models\Errors\ErrorResponse::FIELD_ERRORS = 'errors'

Definition at line 20 of file ErrorResponse.php.

FIELD_MESSAGE

const Commercetools\Import\Models\Errors\ErrorResponse::FIELD_MESSAGE = 'message'

Definition at line 17 of file ErrorResponse.php.

FIELD_STATUS_CODE

const Commercetools\Import\Models\Errors\ErrorResponse::FIELD_STATUS_CODE = 'statusCode'

Definition at line 16 of file ErrorResponse.php.

---

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

• lib/commercetools-import/src/Models/Errors/ErrorResponse.php