LocationService
- class Firstred\PostNL\Service\LocationService
- Class LocationService.
Summary
Methods
Constants
- VERSION = \'2\.1\'
- LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2\_1/locations\'
- SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2\_1/locations\'
- SOAP_ACTION = \'http://postnl\.nl/cif/services/LocationWebService/ILocationWebService/GetNearestLocations\'
- SOAP_ACTION_LOCATIONS_IN_AREA = \'http://postnl\.nl/cif/services/LocationWebService/ILocationWebService/GetLocationsInArea\'
- SERVICES_NAMESPACE = \'http://postnl\.nl/cif/services/LocationWebService/\'
- DOMAIN_NAMESPACE = \'http://postnl\.nl/cif/domain/LocationWebService/\'
Properties
- public property Firstred\PostNL\Service\LocationService::$namespaces
- Namespaces uses for the SOAP version of this service.
- Type:
array
Methods
- public Firstred\PostNL\Service\LocationService::getNearestLocationsREST($getNearestLocations)
- Get the nearest locations via REST.
- Parameters:
$getNearestLocations (
Firstred\PostNL\Entity\Request\GetNearestLocations)
- Returns:
\Firstred\PostNL\Entity\Response\GetNearestLocationsResponse- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0 Use `getNearestLocations` instead
- public Firstred\PostNL\Service\LocationService::getNearestLocationsSOAP($getNearestLocations)
- Get the nearest locations via SOAP.
- Parameters:
$getNearestLocations (
Firstred\PostNL\Entity\Request\GetNearestLocations)
- Returns:
\Firstred\PostNL\Entity\Response\GetNearestLocationsResponse- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0 Use `getNearestLocations` instead
- public Firstred\PostNL\Service\LocationService::getLocationsInAreaREST($getLocations)
- Get the nearest locations via REST.
- Parameters:
$getLocations (
Firstred\PostNL\Entity\Request\GetLocationsInArea)
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0 Use `getLocationsInArea` instead
- public Firstred\PostNL\Service\LocationService::getLocationsInAreaSOAP($getNearestLocations)
- Get the nearest locations via SOAP.
- Parameters:
$getNearestLocations (
Firstred\PostNL\Entity\Request\GetLocationsInArea)
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0 Use `getLocationsInArea` instead
- public Firstred\PostNL\Service\LocationService::getLocationREST($getLocation)
- Get the location via REST.
- Parameters:
$getLocation (
Firstred\PostNL\Entity\Request\GetLocation)
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0 Use `getLocation`
- public Firstred\PostNL\Service\LocationService::getLocationSOAP($getLocation)
- Get the nearest locations via SOAP.
- Parameters:
$getLocation (
Firstred\PostNL\Entity\Request\GetLocation)
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0 Use `getLocation`
- public Firstred\PostNL\Service\LocationService::buildGetNearestLocationsRequestREST($getNearestLocations)
- Build the GenerateLabel request for the REST API.
- Parameters:
$getNearestLocations (
Firstred\PostNL\Entity\Request\GetNearestLocations)
- Returns:
\Psr\Http\Message\RequestInterface- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\LocationService::processGetNearestLocationsResponseREST($response)
- Process GetNearestLocations Response REST.
- Parameters:
$response (mixed)
- Returns:
\Firstred\PostNL\Entity\Response\GetNearestLocationsResponse| null- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\LocationService::buildGetNearestLocationsRequestSOAP($getLocations)
- Build the GenerateLabel request for the SOAP API.
- Parameters:
$getLocations (
Firstred\PostNL\Entity\Request\GetNearestLocations)
- Returns:
\Psr\Http\Message\RequestInterface- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\LocationService::processGetNearestLocationsResponseSOAP($response)
- Process GetNearestLocations Response SOAP.
- Parameters:
$response (
Psr\Http\Message\ResponseInterface)
- Returns:
\Firstred\PostNL\Entity\Response\GetNearestLocationsResponse- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\LocationService::buildGetLocationsInAreaRequestREST($getLocations)
- Build the GetLocationsInArea request for the REST API.
- Parameters:
$getLocations (
Firstred\PostNL\Entity\Request\GetLocationsInArea)
- Returns:
\Psr\Http\Message\RequestInterface- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\LocationService::processGetLocationsInAreaResponseREST($response)
- Process GetLocationsInArea Response REST.
- Parameters:
$response (mixed)
- Returns:
\Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse| null- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\LocationService::buildGetLocationsInAreaRequestSOAP($getLocations)
- Build the GetLocationsInArea request for the SOAP API.
- Parameters:
$getLocations (
Firstred\PostNL\Entity\Request\GetLocationsInArea)
- Returns:
\Psr\Http\Message\RequestInterface- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\LocationService::processGetLocationsInAreaResponseSOAP($response)
- Parameters:
$response (
Psr\Http\Message\ResponseInterface)
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\LocationService::buildGetLocationRequestREST($getLocation)
- Build the GetLocation request for the REST API.
- Parameters:
$getLocation (
Firstred\PostNL\Entity\Request\GetLocation)
- Returns:
\Psr\Http\Message\RequestInterface- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\LocationService::processGetLocationResponseREST($response)
- Process GetLocation Response REST.
- Parameters:
$response (mixed)
- Returns:
\Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse| null- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\LocationService::buildGetLocationRequestSOAP($getLocations)
- Build the GetLocation request for the SOAP API.
- Parameters:
$getLocations (
Firstred\PostNL\Entity\Request\GetLocation)
- Returns:
\Psr\Http\Message\RequestInterface- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\LocationService::processGetLocationResponseSOAP($response)
- Process GetLocation Response SOAP.
- Parameters:
$response (
Psr\Http\Message\ResponseInterface)
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0