.. rst-class:: phpdoctorst .. role:: php(code) :language: php LabellingService ================ .. php:namespace:: Firstred\PostNL\Service .. php:class:: LabellingService .. rst-class:: phpdoc-description | Class LabellingService\. :Parent: :php:class:`Firstred\\PostNL\\Service\\AbstractService` :Implements: :php:interface:`Firstred\\PostNL\\Service\\LabellingServiceInterface` Summary ------- Methods ~~~~~~~ * :php:meth:`public generateLabelREST\($generateLabel, $confirm\)` * :php:meth:`public generateLabelsREST\($generateLabels\)` * :php:meth:`public generateLabelSOAP\($generateLabel, $confirm\)` * :php:meth:`public generateLabelsSOAP\($generateLabels\)` * :php:meth:`public buildGenerateLabelRequestREST\($generateLabel, $confirm\)` * :php:meth:`public processGenerateLabelResponseREST\($response\)` * :php:meth:`public buildGenerateLabelRequestSOAP\($generateLabel, $confirm\)` * :php:meth:`public processGenerateLabelResponseSOAP\($response\)` Constants --------- .. php:const:: VERSION = \'2\.2\' .. php:const:: LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2\_2/label\' .. php:const:: SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2\_2/label\' .. php:const:: SOAP_ACTION = \'http://postnl\.nl/cif/services/LabellingWebService/ILabellingWebService/GenerateLabel\' .. php:const:: SOAP_ACTION_NO_CONFIRM = \'http://postnl\.nl/cif/services/LabellingWebService/ILabellingWebService/GenerateLabelWithoutConfirm\' .. php:const:: SERVICES_NAMESPACE = \'http://postnl\.nl/cif/services/LabellingWebService/\' .. php:const:: DOMAIN_NAMESPACE = \'http://postnl\.nl/cif/domain/LabellingWebService/\' Properties ---------- .. php:attr:: public namespaces .. rst-class:: phpdoc-description | Namespaces uses for the SOAP version of this service\. :Type: array .. php:attr:: private insuranceProductCodes Methods ------- .. rst-class:: public deprecated .. php:method:: public generateLabelREST( $generateLabel, $confirm=true) .. rst-class:: phpdoc-description | Generate a single barcode via REST\. :Parameters: * **$generateLabel** (:any:`Firstred\\PostNL\\Entity\\Request\\GenerateLabel `) * **$confirm** (bool) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GenerateLabelResponse ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Since: 1.0.0 :Deprecated: 1.4.0 Use \`generateLabel\` instead .. rst-class:: public deprecated .. php:method:: public generateLabelsREST( $generateLabels) .. rst-class:: phpdoc-description | Generate multiple labels at once\. :Parameters: * **$generateLabels** (array) ['uuid' => [GenerateBarcode, confirm], ...] :Returns: array :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Since: 1.0.0 :Deprecated: 1.4.0 Use \`generateLabels\` instead .. rst-class:: public deprecated .. php:method:: public generateLabelSOAP( $generateLabel, $confirm=true) .. rst-class:: phpdoc-description | Generate a single label via SOAP\. :Parameters: * **$generateLabel** (:any:`Firstred\\PostNL\\Entity\\Request\\GenerateLabel `) * **$confirm** (bool) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GenerateLabelResponse ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Since: 1.0.0 :Deprecated: 1.4.0 Use \`generateLabels\` instead .. rst-class:: public deprecated .. php:method:: public generateLabelsSOAP( $generateLabels) .. rst-class:: phpdoc-description | Generate multiple labels at once via SOAP\. :Parameters: * **$generateLabels** (array) ['uuid' => [GenerateBarcode, confirm], ...] :Returns: array :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Since: 1.0.0 :Deprecated: 1.4.0 Use \`generateLabels\` instead .. rst-class:: public deprecated .. php:method:: public buildGenerateLabelRequestREST( $generateLabel, $confirm=true) .. rst-class:: phpdoc-description | Build the GenerateLabel request for the REST API\. :Parameters: * **$generateLabel** (:any:`Firstred\\PostNL\\Entity\\Request\\GenerateLabel `) * **$confirm** (bool) :Returns: :any:`\\Psr\\Http\\Message\\RequestInterface ` :Since: 1.0.0 :Deprecated: 1.4.0 .. rst-class:: public .. php:method:: public processGenerateLabelResponseREST( $response) .. rst-class:: phpdoc-description | Process the GenerateLabel REST Response\. :Parameters: * **$response** (:any:`Psr\\Http\\Message\\ResponseInterface `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GenerateLabelResponse ` | null :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\NotSupportedException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Since: 1.0.0 .. rst-class:: public deprecated .. php:method:: public buildGenerateLabelRequestSOAP( $generateLabel, $confirm=true) .. rst-class:: phpdoc-description | Build the GenerateLabel request for the SOAP API\. :Parameters: * **$generateLabel** (:any:`Firstred\\PostNL\\Entity\\Request\\GenerateLabel `) * **$confirm** (bool) :Returns: :any:`\\Psr\\Http\\Message\\RequestInterface ` :Since: 1.0.0 :Deprecated: 1.4.0 .. rst-class:: public deprecated .. php:method:: public processGenerateLabelResponseSOAP( $response) :Parameters: * **$response** (:any:`Psr\\Http\\Message\\ResponseInterface `) :Returns: :any:`\\Firstred\\PostNL\\Entity\\Response\\GenerateLabelResponse ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifDownException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\CifException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\ResponseException ` :Throws: :any:`\\Firstred\\PostNL\\Exception\\HttpClientException ` :Since: 1.0.0 :Deprecated: 1.4.0