StatusAddress

class Firstred\PostNL\Entity\StatusAddress

Parent:: Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

public __construct($AddressType, $FirstName, $LastName, $CompanyName, $DepartmentName, $Street, $HouseNumber, $HouseNumberSuffix, $Zipcode, $City, $CountryCode, $Region, $District, $Building, $Floor, $Remark, $RegistrationDate)
public getBuilding()
public setBuilding($Building)
public getCity()
public setCity($City)
public getCompanyName()
public setCompanyName($CompanyName)
public getCountryCode()
public setCountryCode($CountryCode)
public getDepartmentName()
public setDepartmentName($DepartmentName)
public getDistrict()
public setDistrict($District)
public getFirstName()
public setFirstName($FirstName)
public getFloor()
public setFloor($Floor)
public getHouseNumber()
public setHouseNumber($HouseNumber)
public getHouseNumberSuffix()
public setHouseNumberSuffix($HouseNumberSuffix)
public getLastName()
public setLastName($LastName)
public getRegion()
public setRegion($Region)
public getRemark()
public setRemark($Remark)
public getStreet()
public setStreet($Street)
public getAddressType()
public getRegistrationDate()
public getZipcode()
public setZipcode($Zipcode)
public setAddressType($AddressType)
public setRegistrationDate($RegistrationDate)

Properties

protected static property Firstred\PostNL\Entity\StatusAddress::$AddressType

PostNL internal applications validate the receiver address. In case the spelling of
addresses should be different according to our PostNL information, the address details will
be corrected. This can be noticed in Track & Trace.

Please note that the webservice will not add address details. Street and City fields will
only be printed when they are in the call towards the labeling webservice.

The element Address type is a code in the request. Possible values are:

Code Description
01   Receiver
02   Sender
03   Alternative sender address
04   Collection address (In the orders need to be collected first)
08   Return address*
09   Drop off location (for use with Pick up at PostNL location)

> * When using the ‘label in the box return label’, it is mandatory to use an
>   `Antwoordnummer` in AddressType 08.
>   This cannot be a regular address

The following rules apply:
If there is no Address specified with AddressType = 02, the data from Customer/Address
will be added to the list as AddressType 02.
If there is no Customer/Address, the message will be rejected.

At least one other AddressType must be specified, other than AddressType 02
In most cases this will be AddressType 01, the receiver address.

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$Building

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$City

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$CompanyName

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$CountryCode

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$DepartmentName

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$District

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$FirstName

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$Floor

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$HouseNumber

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$HouseNumberSuffix

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$LastName

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$Region

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$RegistrationDate

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$Remark

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$Street

Type:: string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$Zipcode

Type:: string | null

Methods

public Firstred\PostNL\Entity\StatusAddress::__construct($AddressType=null, $FirstName=null, $LastName=null, $CompanyName=null, $DepartmentName=null, $Street=null, $HouseNumber=null, $HouseNumberSuffix=null, $Zipcode=null, $City=null, $CountryCode=null, $Region=null, $District=null, $Building=null, $Floor=null, $Remark=null, \\DateTimeInterface|string|null $RegistrationDate=null)

Throws:: \Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\StatusAddress::getBuilding()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setBuilding($Building)

Parameters:

$Building (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getCity()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setCity($City)

Parameters:

$City (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getCompanyName()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setCompanyName($CompanyName)

Parameters:

$CompanyName (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getCountryCode()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setCountryCode($CountryCode)

Parameters:

$CountryCode (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getDepartmentName()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setDepartmentName($DepartmentName)

Parameters:

$DepartmentName (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getDistrict()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setDistrict($District)

Parameters:

$District (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getFirstName()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setFirstName($FirstName)

Parameters:

$FirstName (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getFloor()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setFloor($Floor)

Parameters:

$Floor (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getHouseNumber()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setHouseNumber($HouseNumber)

Parameters:

$HouseNumber (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getHouseNumberSuffix()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setHouseNumberSuffix($HouseNumberSuffix)

Parameters:

$HouseNumberSuffix (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getLastName()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setLastName($LastName)

Parameters:

$LastName (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getRegion()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setRegion($Region)

Parameters:

$Region (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getRemark()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setRemark($Remark)

Parameters:

$Remark (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getStreet()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setStreet($Street)

Parameters:

$Street (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::getAddressType()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::getRegistrationDate()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::getZipcode()

Returns:: string | null

public Firstred\PostNL\Entity\StatusAddress::setZipcode($Zipcode=null)

Parameters:

$Zipcode (string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::setAddressType(int|string|null $AddressType=null)

Parameters:

$AddressType (int | string | null)

Returns:

static

public Firstred\PostNL\Entity\StatusAddress::setRegistrationDate(\\DateTimeInterface|string|null $RegistrationDate=null)

Throws:: \Firstred\PostNL\Exception\InvalidArgumentException
Since:: 1.2.0