LabelResponse Interface Reference

Inheritance diagram for LabelResponse:

Public Member Functions
	getStatusCode ()
	getStatusText ()
	getStatusMessage ()
	getSequenceNumber ()
	getShipmentNumber ()
	getLabel ()
	getReturnLabel ()
	getExportDoc ()
	getCodLabel ()

Detailed Description

Definition at line 21 of file LabelResponse.php.

Member Function Documentation

getCodLabel()

getCodLabel

(

)

Getter for Cod-Label

Returns

null|string - Cod-Label-URL/Base64-Data or null if not requested/set

Implemented in Response, and LabelData.

getExportDoc()

getExportDoc

(

)

Getter for Export-Document

Returns

null|string - Export-Document Label-URL/Base64-Label-Data or null if not requested/set

Implemented in LabelData, and Response.

getLabel()

getLabel

(

)

Getter for Label

Returns

null|string - Label URL/Base64-Data (Can also contain the return label) or null if not set

Implemented in LabelData, and Response.

getReturnLabel()

getReturnLabel

(

)

Getter for ReturnLabel

Returns

null|string - Return Label-URL/Base64-Label-Data or null if not requested/set

Implemented in LabelData, and Response.

getSequenceNumber()

getSequenceNumber

(

)

Getter for Sequence-Number

Returns

string|null - Sequence-Number of the Request or null if not set

Implemented in LabelData, and Response.

getShipmentNumber()

getShipmentNumber

(

)

Getter for Shipment-Number

Returns

null|string - Shipment-Number or null if not set

Implemented in LabelData, and Response.

getStatusCode()

getStatusCode

(

)

Getter for Status-Code

• Response::DHL_ERROR_NOT_SET (-1) -> Status-Code was not set
• Response::DHL_ERROR_NO_ERROR (0) -> No Error occurred
• Response::DHL_ERROR_WEAK_WARNING (1) -> A week warning has occurred
• Response::DHL_ERROR_SERVICE_TMP_NOT_AVAILABLE (500) -> DHL-API Service is not available
• Response::DHL_ERROR_GENERAL (1000)-> General Error
• Response::DHL_ERROR_AUTH_FAILED (1001) -> Authentication has failed
• Response::DHL_ERROR_HARD_VAL_ERROR (1101) -> A hard-validation Error has occurred
• Response::DHL_ERROR_UNKNOWN_SHIPMENT_NUMBER (2000) -> Given Shipment-Number is unknown

Returns

int - Status-Code

Implemented in Response, and LabelData.

getStatusMessage()

getStatusMessage

(

)

Getter for Status-Message

Returns

string|null - Status-Message or null if not set

Implemented in Response, and LabelData.

getStatusText()

getStatusText

(

)

Getter for Status-Text

Returns

string|null - Status-Text or null if not set

Implemented in Response, and LabelData.

---

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

• includes/LabelResponse.php