JSON Physical Model

Schema for:

Model name: bpostAddressValidationWebservice - External
Author: Pascal
Version: 1.4
File name: bpost Address Validation Webservice - External v1.4.json
File path: C:\Users\Pascal\Bitbucket\hackolade\schemas\JSON\bpost Address Validation Webservice - External v1.4.json
Printed On: Mon Feb 27 2017 11:00:18 GMT+0100 (Romance Standard Time)
Created with: Hackolade - Visual data modeling for NoSQL and multimodel databases
1. Model
2. Documents
3. Relationships
1. Model
1.1 Model bpostAddressValidationWebservice - External
1.1.1 bpostAddressValidationWebservice - External Entity Relationship Diagram
Request
ValidateAddressesRequest
<obj>
AddressToValidateList
<obj>
AddressToValidate
<arr>
[0]
<obj>
@id
<str>
oneOf
<ch>
[0]
<sub>
MaileeAndAddressee
<obj>
AddresseeIndividualIdentification
<obj>
oneOf
<ch>
[0]
<sub>
StructuredAddresseeIndividualIdentification
<obj>
AddresseeFormOfAddress
<str>
AddresseeGivenName
<str>
AddresseeSurname
<str>
AddresseeSupplementaryDispatchInfo
<str>
[1]
<sub>
UnstructuredAddresseeIndividualIdentification
<str>
MaileeIndividualIdentification
<obj>
oneOf
<ch>
[0]
<sub>
StructuredMaileeIndividualIdentification
<obj>
MaileeRole
<str>
MaileeFormOfAddress
<str>
MaileeGivenName
<str>
MaileeSurname
<str>
[1]
<sub>
UnstructuredMaileeIndividualIdentification
<str>
MaileeOrganizationIdentification
<obj>
oneOf
<ch>
[0]
<sub>
StructuredMaileeOrganizationIdentification
<obj>
MaileeOrganizationFunction
<str>
MaileeOrganizationOrganizationalUnit
<str>
MaileeOrganizationOrganizationalName
<str>
MaileeOrganizationLegalStatus
<str>
[1]
<sub>
UnstructuredMaileeOrganizationIdentification
<str>
MailRecipientDispatchingInformation
<obj>
oneOf
<ch>
[0]
<sub>
StructuredMailRecipientDispatchingInformation
<obj>
Wing
<obj>
WingType
<str>
WingIndicator
<str>
Stairwell
<obj>
StairwellType
<str>
StairwellIndicator
<str>
Floor
<obj>
FloorType
<str>
FloorIndicator
<str>
Door
<obj>
DoorType
<str>
DoorIndicator
<str>
BuildingConstruction
<str>
[1]
<sub>
UnstructuredMailRecipientDispatchingInformation
<str>
PostalAddress
<obj>
OtherDeliveryInformation
<obj>
oneOf
<ch>
[0]
<sub>
StructuredOtherDeliveryInformation
<obj>
DeliveryServiceType
<str>
DeliveryServiceIndicator
<str>
[1]
<sub>
UnstructuredOtherDeliveryInformation
<str>
DeliveryPointLocation
<obj>
oneOf
<ch>
[0]
<sub>
StructuredDeliveryPointLocation
<obj>
StreetName
<str>
StreetNumber
<str>
BoxNumber
<str>
[1]
<sub>
UnstructuredDeliveryPointLocation
<str>
PostalCodeMunicipality
<obj>
oneOf
<ch>
[0]
<sub>
StructuredPostalCodeMunicipality
<obj>
PostalCode
<str>
MunicipalityName
<str>
DeliveryServiceQualifier
<str>
[1]
<sub>
UnstructuredPostalCodeMunicipality
<str>
CountryName
<str>
[1]
<sub>
AddressBlockLines
<obj>
UnstructuredAddressLine
<arr>
[0]
<obj>
*body
<str>
DispatchingCountryISOCode
<str>
DeliveringCountryISOCode
<str>
ValidateAddressOptions
<obj>
IncludeFormatting
<bool>
IncludeSuggestions
<bool>
IncludeSubmittedAddress
<bool>
IncludeDefaultGeoLocation
<bool>
IncludeListOfBoxes
<bool>
IncludeNumberOfBoxes
<bool>
CallerIdentification
<obj>
CallerName
<str>
Response
ValidateAddressesResponse
<obj>
ValidatedAddressResultList
<obj>
ValidatedAddressResult
<arr>
[0]
<obj>
@id
fk
<str>
MaileeAndAddressee
<obj>
AddresseeIndividualIdentification
<obj>
oneOf
<ch>
[0]
<sub>
StructuredAddresseeIndividualIdentification
<obj>
AddresseeFormOfAddress
<str>
AddresseeGivenName
<str>
AddresseeSurname
<str>
AddresseeSupplementaryDispatchInfo
<str>
[1]
<sub>
UnstructuredAddresseeIndividualIdentification
<str>
MaileeIndividualIdentification
<obj>
oneOf
<ch>
[0]
<sub>
StructuredMaileeIndividualIdentification
<obj>
MaileeRole
<str>
MaileeFormOfAddress
<str>
MaileeGivenName
<str>
MaileeSurname
<str>
[1]
<sub>
UnstructuredMaileeIndividualIdentification
<str>
MaileeOrganizationIdentification
<obj>
oneOf
<ch>
[0]
<sub>
StructuredMaileeOrganizationIdentification
<obj>
MaileeOrganizationFunction
<str>
MaileeOrganizationOrganizationalUnit
<str>
MaileeOrganizationOrganizationalName
<str>
MaileeOrganizationLegalStatus
<str>
[1]
<sub>
UnstructuredMaileeOrganizationIdentification
<str>
MailRecipientDispatchingInformation
<obj>
oneOf
<ch>
[0]
<sub>
StructuredMailRecipientDispatchingInformation
<obj>
Wing
<obj>
WingType
<str>
WingIndicator
<str>
Stairwell
<obj>
StairwellType
<str>
StairwellIndicator
<str>
Floor
<obj>
FloorType
<str>
FloorIndicator
<str>
Door
<obj>
DoorType
<str>
DoorIndicator
<str>
BuildingConstruction
<str>
[1]
<sub>
UnstructuredMailRecipientDispatchingInformation
<str>
ValidatedAddressList
<obj>
ValidatedAddress
<arr>
[0]
<obj>
PostalAddress
<obj>
StructuredDeliveryPointLocation
<obj>
StreetName
<str>
StreetNumber
<str>
BoxNumber
<str>
StructuredPostalCodeMunicipality
<obj>
PostalCode
<str>
MunicipalityName
<str>
CountryName
<str>
AddressLanguage
<str>
score
<int>
NumberOfBoxes
<int>
ServicePointBoxList
<obj>
ServicePointBoxResult
<arr>
[0]
<obj>
StreetNumber
<str>
BoxNumber
<str>
DeliveryServiceIndicator
<str>
PostalCode
<str>
ServicePointDetail
<obj>
GeographicalLocationInfo
<obj>
GeographicalLocation
<obj>
Latitude
<obj>
Value
<str>
CoordinateType
<str>
Longitude
<obj>
Value
<str>
CoordinateType
<str>
Elevation
<obj>
Quantity
<str>
UnitOfDimension
<str>
Label
<obj>
Line
<arr>
[0]
<str>
Error
<arr>
[0]
<obj>
ComponentRef
<str>
ErrorCode
<str>
ErrorSeverity
<str>
DetectedInputAddressLanguage
<str>
FormattedSubmittedAddress
<obj>
Line
<arr>
[0]
<str>
TransactionID
<str>
GeneralError
<obj>
ErrorCode
<str>
ErrorSeverity
<str>
1.1.2 bpostAddressValidationWebservice - External Properties
PropertyValue
Name bpostAddressValidationWebservice - External
Description
Author Pascal
Version 1
DB Vendor Plain JSON--no DB
Comments
1.1.4 bpostAddressValidationWebservice - External DB Definitions (TBD)
2. Document
2.1 Document Request
2.1.1 Request Tree Diagram
XXXXXXXX
{ABC}
CallerName
type
{...}
CallerIdentification
type
{0/1}
IncludeNumberOfBoxes
type
{0/1}
IncludeListOfBoxes
type
{0/1}
IncludeDefaultGeoLocation
type
{0/1}
IncludeSubmittedAddress
type
{0/1}
IncludeSuggestions
type
{0/1}
IncludeFormatting
type
{...}
ValidateAddressOptions
type
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
*body
type
{...}
[0]*
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
CountryName
type
{ABC}
UnstructuredPostalCodeMunicipality
type
{Sub}
[1]
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{Sub}
[0]
type
{...}
PostalCodeMunicipality
type
{ABC}
UnstructuredDeliveryPointLocation
type
{Sub}
[1]
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{Sub}
[0]
type
{...}
DeliveryPointLocation
type
{ABC}
UnstructuredOtherDeliveryInformation
type
{Sub}
[1]
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{Sub}
[0]
type
{...}
OtherDeliveryInformation
type
{...}
PostalAddress
type
{ABC}
UnstructuredMailRecipientDispatchingInformation
type
{Sub}
[1]
type
{ABC}
BuildingConstruction
type
{ABC}
DoorIndicator
type
{ABC}
DoorType
type
{...}
Door
type
{ABC}
FloorIndicator
type
{ABC}
FloorType
type
{...}
Floor
type
{ABC}
StairwellIndicator
type
{ABC}
StairwellType
type
{...}
Stairwell
type
{ABC}
WingIndicator
type
{ABC}
WingType
type
{...}
Wing
type
{...}
StructuredMailRecipientDispatchingInformation
type
{Sub}
[0]
type
{...}
MailRecipientDispatchingInformation
type
{ABC}
UnstructuredMaileeOrganizationIdentification
type
{Sub}
[1]
type
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{Sub}
[0]
type
{...}
MaileeOrganizationIdentification
type
{ABC}
UnstructuredMaileeIndividualIdentification
type
{Sub}
[1]
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{Sub}
[0]
type
{...}
MaileeIndividualIdentification
type
{ABC}
UnstructuredAddresseeIndividualIdentification
type
{Sub}
[1]
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{Sub}
[0]
type
{...}
AddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
@id
type
{...}
[0]*
type
[...]
AddressToValidate
type
{...}
AddressToValidateList
type
{...}
ValidateAddressesRequest
type
Request
type
{ABC}
CallerName
type
{...}
CallerIdentification
type
{0/1}
IncludeNumberOfBoxes
type
{0/1}
IncludeListOfBoxes
type
{0/1}
IncludeDefaultGeoLocation
type
{0/1}
IncludeSubmittedAddress
type
{0/1}
IncludeSuggestions
type
{0/1}
IncludeFormatting
type
{...}
ValidateAddressOptions
type
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
*body
type
{...}
[0]*
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
CountryName
type
{ABC}
UnstructuredPostalCodeMunicipality
type
{Sub}
[1]
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{Sub}
[0]
type
{...}
PostalCodeMunicipality
type
{ABC}
UnstructuredDeliveryPointLocation
type
{Sub}
[1]
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{Sub}
[0]
type
{...}
DeliveryPointLocation
type
{ABC}
UnstructuredOtherDeliveryInformation
type
{Sub}
[1]
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{Sub}
[0]
type
{...}
OtherDeliveryInformation
type
{...}
PostalAddress
type
{ABC}
UnstructuredMailRecipientDispatchingInformation
type
{Sub}
[1]
type
{ABC}
BuildingConstruction
type
{ABC}
DoorIndicator
type
{ABC}
DoorType
type
{...}
Door
type
{ABC}
FloorIndicator
type
{ABC}
FloorType
type
{...}
Floor
type
{ABC}
StairwellIndicator
type
{ABC}
StairwellType
type
{...}
Stairwell
type
{ABC}
WingIndicator
type
{ABC}
WingType
type
{...}
Wing
type
{...}
StructuredMailRecipientDispatchingInformation
type
{Sub}
[0]
type
{...}
MailRecipientDispatchingInformation
type
{ABC}
UnstructuredMaileeOrganizationIdentification
type
{Sub}
[1]
type
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{Sub}
[0]
type
{...}
MaileeOrganizationIdentification
type
{ABC}
UnstructuredMaileeIndividualIdentification
type
{Sub}
[1]
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{Sub}
[0]
type
{...}
MaileeIndividualIdentification
type
{ABC}
UnstructuredAddresseeIndividualIdentification
type
{Sub}
[1]
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{Sub}
[0]
type
{...}
AddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
@id
type
{...}
[0]*
type
[...]
AddressToValidate
type
{...}
AddressToValidateList
type
{...}
ValidateAddressesRequest
type
Request
type
2.1.2 Request Properties
PropertyValue
Document name Request
Id
Description Request schema specification for bpost Address Validation webservice
RESTful API true
Transaction
Method
EndPoint http://webservices-pub.bpost.be
Resources /ws/ExternalMailingAddressProofingCSREST_v1/address/validateAddresses
Media type application/JSON
Additional properties true
Comments
2.1.3 Request Fields
FieldTypeReqKeyDescription
ValidateAddressesRequestdocumenttrue
AddressToValidateListdocumenttrue
AddressToValidatearraytrue
[0]documentfalse
@idstringtrue
oneOfchoicefalse
[0]subschemafalse
MaileeAndAddresseedocumentfalse
AddresseeIndividualIdentificationdocumentfalse
oneOfchoicefalse
[0]subschemafalse
StructuredAddresseeIndividualIdentificationdocumentfalse
AddresseeFormOfAddressstringfalse
AddresseeGivenNamestringfalse
AddresseeSurnamestringfalse
AddresseeSupplementaryDispatchInfostringfalse
[1]subschemafalse
UnstructuredAddresseeIndividualIdentificationstringfalse
MaileeIndividualIdentificationdocumentfalse
oneOfchoicefalse
[0]subschemafalse
StructuredMaileeIndividualIdentificationdocumentfalse
MaileeRolestringfalse
MaileeFormOfAddressstringfalse
MaileeGivenNamestringfalse
MaileeSurnamestringfalse
[1]subschemafalse
UnstructuredMaileeIndividualIdentificationstringfalse
MaileeOrganizationIdentificationdocumentfalse
oneOfchoicefalse
[0]subschemafalse
StructuredMaileeOrganizationIdentificationdocumentfalse
MaileeOrganizationFunctionstringfalse
MaileeOrganizationOrganizationalUnitstringfalse
MaileeOrganizationOrganizationalNamestringfalse
MaileeOrganizationLegalStatusstringfalse
[1]subschemafalse
UnstructuredMaileeOrganizationIdentificationstringfalse
MailRecipientDispatchingInformationdocumentfalse
oneOfchoicefalse
[0]subschemafalse
StructuredMailRecipientDispatchingInformationdocumentfalse
Wingdocumentfalse
WingTypestringfalse
WingIndicatorstringfalse
Stairwelldocumentfalse
StairwellTypestringfalse
StairwellIndicatorstringfalse
Floordocumentfalse
FloorTypestringfalse
FloorIndicatorstringfalse
Doordocumentfalse
DoorTypestringfalse
DoorIndicatorstringfalse
BuildingConstructionstringfalse
[1]subschemafalse
UnstructuredMailRecipientDispatchingInformationstringfalse
PostalAddressdocumenttrue
OtherDeliveryInformationdocumentfalse
oneOfchoicefalse
[0]subschemafalse
StructuredOtherDeliveryInformationdocumentfalse
DeliveryServiceTypestringfalse
DeliveryServiceIndicatorstringfalse
[1]subschemafalse
UnstructuredOtherDeliveryInformationstringfalse
DeliveryPointLocationdocumentfalse
oneOfchoicefalse
[0]subschemafalse
StructuredDeliveryPointLocationdocumentfalse
StreetNamestringfalse
StreetNumberstringfalse
BoxNumberstringfalse
[1]subschemafalse
UnstructuredDeliveryPointLocationstringfalse
PostalCodeMunicipalitydocumenttrue
oneOfchoicefalse
[0]subschemafalse
StructuredPostalCodeMunicipalitydocumentfalse
PostalCodestringtrue
MunicipalityNamestringtrue
DeliveryServiceQualifierstringfalse
[1]subschemafalse
UnstructuredPostalCodeMunicipalitystringfalse
CountryNamestringfalse
[1]subschemafalse
AddressBlockLinesdocumentfalse
UnstructuredAddressLinearraytrue
[0]documentfalse
*bodystringtrue
DispatchingCountryISOCodestringfalse
DeliveringCountryISOCodestringfalse
ValidateAddressOptionsdocumentfalse
IncludeFormattingbooleanfalse
IncludeSuggestionsbooleanfalse
IncludeSubmittedAddressbooleanfalse
IncludeDefaultGeoLocationbooleanfalse
IncludeListOfBoxesbooleanfalse
IncludeNumberOfBoxesbooleanfalse
CallerIdentificationdocumentfalse
CallerNamestringtrue
2.1.3.1 Field ValidateAddressesRequest
2.1.3.1.1 ValidateAddressesRequest Tree Diagram
{...}
CallerIdentification
type
{...}
ValidateAddressOptions
type
{...}
AddressToValidateList
type
ValidateAddressesRequest
type
{...}
CallerIdentification
type
{...}
ValidateAddressOptions
type
{...}
AddressToValidateList
type
ValidateAddressesRequest
type
2.1.3.1.2 ValidateAddressesRequest Hierarchy
Parent field: Request
Child field(s):
FieldTypeReqKeyDescription
AddressToValidateListdocumenttrue
ValidateAddressOptionsdocumentfalse
CallerIdentificationdocumentfalseInformation about the caller of the service, in case no authentication mechanism exists.
ValidateAddressesRequest properties
PropertyValue
Name ValidateAddressesRequest
Id
Type document
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.1.3.2 Field AddressToValidateList
2.1.3.2.1 AddressToValidateList Tree Diagram
[...]
AddressToValidate
type
AddressToValidateList
type
[...]
AddressToValidate
type
AddressToValidateList
type
2.1.3.2.2 AddressToValidateList Hierarchy
Parent field: ValidateAddressesRequest
Child field(s):
FieldTypeReqKeyDescription
AddressToValidatearraytrue
AddressToValidateList properties
PropertyValue
Name AddressToValidateList
Id
Type document
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.1.3.3 Field AddressToValidate
2.1.3.3.1 AddressToValidate Tree Diagram
{...}
[0]*
type
[...]
AddressToValidate
type
{...}
[0]*
type
[...]
AddressToValidate
type
2.1.3.3.2 AddressToValidate Hierarchy
Parent field: AddressToValidateList
Child field(s):
FieldTypeReqKeyDescription
[0]documentfalse
AddressToValidate properties
PropertyValue
Name AddressToValidate
Id
Type array
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min items 1
Max items 200
Unique items
Additional items true
Comments
2.1.3.4 Field [0]
2.1.3.4.1 [0] Tree Diagram
X
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
@id
type
[0]
type
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
@id
type
[0]
type
2.1.3.4.2 [0] Hierarchy
Parent field: AddressToValidate
Child field(s):
FieldTypeReqKeyDescription
@idstringtrue
oneOfchoicefalse
DispatchingCountryISOCodestringfalseS42 name: Dispatching Country ISO Code, code: 50.53.0.0.0
DeliveringCountryISOCodestringfalseS42 name: Delivering Country ISO Code, code: 50.54.0.0.0. This field determines which S42 template will be chosen.
[0] properties
PropertyValue
Name
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.5 Field @id
2.1.3.5.1 @id Tree Diagram
{ABC}
@id
type
{ABC}
@id
type
@id properties
PropertyValue
Name @id
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample 1
Comments
2.1.3.6 Field oneOf
2.1.3.6.1 oneOf Tree Diagram
X
{Sub}
[1]
type
{Sub}
[0]
type
{Sub}
[1]
type
{Sub}
[0]
type
2.1.3.6.2 oneOf Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
[0]subschemafalseAddresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components. This branch of the choice describes the address components. Each address is divided in logical groups, for example the 'delivery point location' group (typically used to store the street name and house number). Each logical group can itself be submitted in a structured manner (prefered method) identifying each individual field: one for the street name, one for the house number, and possibly one for the mailbox number. Or it can be submitted in one one unstructured field. While in any individual group, you cannot submit a mix of structured and unstructured fields, you are allowed to make the choice of structured or unstructured for any group, and mix the mode between groups. In other words, you could submit the group 'delivery point location' in an unstructured mode, and submit the 'postal code municipality' group in a structured mode. Address recognition will be better if fully structured addresses are submitted.
[1]subschemafalseAddresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components. This branch of the choice describes the address block lines. This is not the prefered method for address recognition, but it is permitted. bpost's algorithms will attempt to parse the submitted lines and identify the different elements so they can be mapped to the standard structure of an address.
oneOf properties
PropertyValue
Choice oneOf
2.1.3.7 Field [0]
2.1.3.7.1 [0] Tree Diagram
{...}
PostalAddress
type
{...}
MaileeAndAddressee
type
{Sub}
[subschema]
type
{...}
PostalAddress
type
{...}
MaileeAndAddressee
type
{Sub}
[subschema]
type
2.1.3.7.2 [0] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
MaileeAndAddresseedocumentfalseThis section is optional, but recommended. At least the Addressee Individual Identification group.
PostalAddressdocumenttrueThis section is mandatory, and needs to include at least the Postal Code Municipality group, plus typically the Delivery Point Location group (with a stree tname and house number), or alternatively the Other Delivery Information group (for a PO Box).
[0] properties
PropertyValue
Id
Description Addresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components. This branch of the choice describes the address components. Each address is divided in logical groups, for example the 'delivery point location' group (typically used to store the street name and house number). Each logical group can itself be submitted in a structured manner (prefered method) identifying each individual field: one for the street name, one for the house number, and possibly one for the mailbox number. Or it can be submitted in one one unstructured field. While in any individual group, you cannot submit a mix of structured and unstructured fields, you are allowed to make the choice of structured or unstructured for any group, and mix the mode between groups. In other words, you could submit the group 'delivery point location' in an unstructured mode, and submit the 'postal code municipality' group in a structured mode. Address recognition will be better if fully structured addresses are submitted.
Required
Min Properties
Max Properties
Additional properties
Comments
2.1.3.8 Field MaileeAndAddressee
2.1.3.8.1 MaileeAndAddressee Tree Diagram
{...}
MailRecipientDispatchingInformation
type
{...}
MaileeOrganizationIdentification
type
{...}
MaileeIndividualIdentification
type
{...}
AddresseeIndividualIdentification
type
MaileeAndAddressee
type
{...}
MailRecipientDispatchingInformation
type
{...}
MaileeOrganizationIdentification
type
{...}
MaileeIndividualIdentification
type
{...}
AddresseeIndividualIdentification
type
MaileeAndAddressee
type
2.1.3.8.2 MaileeAndAddressee Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
AddresseeIndividualIdentificationdocumentfalse
MaileeIndividualIdentificationdocumentfalse
MaileeOrganizationIdentificationdocumentfalse
MailRecipientDispatchingInformationdocumentfalse
MaileeAndAddressee properties
PropertyValue
Name MaileeAndAddressee
Id
Type document
Description This section is optional, but recommended. At least the Addressee Individual Identification group.
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.1.3.9 Field AddresseeIndividualIdentification
2.1.3.9.1 AddresseeIndividualIdentification Tree Diagram
X
AddresseeIndividualIdentification
type
AddresseeIndividualIdentification
type
2.1.3.9.2 AddresseeIndividualIdentification Hierarchy
Parent field: MaileeAndAddressee
Child field(s):
FieldTypeReqKeyDescription
oneOfchoicefalse
AddresseeIndividualIdentification properties
PropertyValue
Name AddresseeIndividualIdentification
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments Mandatory if addressed mail
2.1.3.10 Field oneOf
2.1.3.10.1 oneOf Tree Diagram
X
{Sub}
[1]
type
{Sub}
[0]
type
{Sub}
[1]
type
{Sub}
[0]
type
2.1.3.10.2 oneOf Hierarchy
Parent field: AddresseeIndividualIdentification
Child field(s):
FieldTypeReqKeyDescription
[0]subschemafalse
[1]subschemafalse
oneOf properties
PropertyValue
Choice oneOf
2.1.3.11 Field [0]
2.1.3.11.1 [0] Tree Diagram
{...}
StructuredAddresseeIndividualIdentification
type
{Sub}
[subschema]
type
{...}
StructuredAddresseeIndividualIdentification
type
{Sub}
[subschema]
type
2.1.3.11.2 [0] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredAddresseeIndividualIdentificationdocumentfalse
[0] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.1.3.12 Field StructuredAddresseeIndividualIdentification
2.1.3.12.1 StructuredAddresseeIndividualIdentification Tree Diagram
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
StructuredAddresseeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
StructuredAddresseeIndividualIdentification
type
2.1.3.12.2 StructuredAddresseeIndividualIdentification Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
AddresseeFormOfAddressstringfalse
AddresseeGivenNamestringfalse
AddresseeSurnamestringfalse
AddresseeSupplementaryDispatchInfostringfalse
StructuredAddresseeIndividualIdentification properties
PropertyValue
Name StructuredAddresseeIndividualIdentification
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.1.3.13 Field AddresseeFormOfAddress
2.1.3.13.1 AddresseeFormOfAddress Tree Diagram
{ABC}
AddresseeFormOfAddress
type
{ABC}
AddresseeFormOfAddress
type
AddresseeFormOfAddress properties
PropertyValue
Name AddresseeFormOfAddress
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample Mr
Comments
2.1.3.14 Field AddresseeGivenName
2.1.3.14.1 AddresseeGivenName Tree Diagram
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeGivenName
type
AddresseeGivenName properties
PropertyValue
Name AddresseeGivenName
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample Jacques
Comments
2.1.3.15 Field AddresseeSurname
2.1.3.15.1 AddresseeSurname Tree Diagram
{ABC}
AddresseeSurname
type
{ABC}
AddresseeSurname
type
AddresseeSurname properties
PropertyValue
Name AddresseeSurname
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample Martin
Comments
2.1.3.16 Field AddresseeSupplementaryDispatchInfo
2.1.3.16.1 AddresseeSupplementaryDispatchInfo Tree Diagram
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
AddresseeSupplementaryDispatchInfo properties
PropertyValue
Name AddresseeSupplementaryDispatchInfo
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.17 Field [1]
2.1.3.17.1 [1] Tree Diagram
{ABC}
UnstructuredAddresseeIndividualIdentification
type
{Sub}
[subschema]
type
{ABC}
UnstructuredAddresseeIndividualIdentification
type
{Sub}
[subschema]
type
2.1.3.17.2 [1] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
UnstructuredAddresseeIndividualIdentificationstringfalse
[1] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.18 Field UnstructuredAddresseeIndividualIdentification
2.1.3.18.1 UnstructuredAddresseeIndividualIdentification Tree Diagram
{ABC}
UnstructuredAddresseeIndividualIdentification
type
{ABC}
UnstructuredAddresseeIndividualIdentification
type
UnstructuredAddresseeIndividualIdentification properties
PropertyValue
Name UnstructuredAddresseeIndividualIdentification
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample Mr François Hollande
Comments
2.1.3.19 Field MaileeIndividualIdentification
2.1.3.19.1 MaileeIndividualIdentification Tree Diagram
X
MaileeIndividualIdentification
type
MaileeIndividualIdentification
type
2.1.3.19.2 MaileeIndividualIdentification Hierarchy
Parent field: MaileeAndAddressee
Child field(s):
FieldTypeReqKeyDescription
oneOfchoicefalse
MaileeIndividualIdentification properties
PropertyValue
Name MaileeIndividualIdentification
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.20 Field oneOf
2.1.3.20.1 oneOf Tree Diagram
X
{Sub}
[1]
type
{Sub}
[0]
type
{Sub}
[1]
type
{Sub}
[0]
type
2.1.3.20.2 oneOf Hierarchy
Parent field: MaileeIndividualIdentification
Child field(s):
FieldTypeReqKeyDescription
[0]subschemafalse
[1]subschemafalse
oneOf properties
PropertyValue
Choice oneOf
2.1.3.21 Field [0]
2.1.3.21.1 [0] Tree Diagram
{...}
StructuredMaileeIndividualIdentification
type
{Sub}
[subschema]
type
{...}
StructuredMaileeIndividualIdentification
type
{Sub}
[subschema]
type
2.1.3.21.2 [0] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredMaileeIndividualIdentificationdocumentfalse
[0] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.1.3.22 Field StructuredMaileeIndividualIdentification
2.1.3.22.1 StructuredMaileeIndividualIdentification Tree Diagram
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
StructuredMaileeIndividualIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
StructuredMaileeIndividualIdentification
type
2.1.3.22.2 StructuredMaileeIndividualIdentification Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
MaileeRolestringfalse
MaileeFormOfAddressstringfalse
MaileeGivenNamestringfalse
MaileeSurnamestringfalse
StructuredMaileeIndividualIdentification properties
PropertyValue
Name StructuredMaileeIndividualIdentification
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.23 Field MaileeRole
2.1.3.23.1 MaileeRole Tree Diagram
{ABC}
MaileeRole
type
{ABC}
MaileeRole
type
MaileeRole properties
PropertyValue
Name MaileeRole
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.24 Field MaileeFormOfAddress
2.1.3.24.1 MaileeFormOfAddress Tree Diagram
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeFormOfAddress
type
MaileeFormOfAddress properties
PropertyValue
Name MaileeFormOfAddress
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.25 Field MaileeGivenName
2.1.3.25.1 MaileeGivenName Tree Diagram
{ABC}
MaileeGivenName
type
{ABC}
MaileeGivenName
type
MaileeGivenName properties
PropertyValue
Name MaileeGivenName
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.26 Field MaileeSurname
2.1.3.26.1 MaileeSurname Tree Diagram
{ABC}
MaileeSurname
type
{ABC}
MaileeSurname
type
MaileeSurname properties
PropertyValue
Name MaileeSurname
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.27 Field [1]
2.1.3.27.1 [1] Tree Diagram
{ABC}
UnstructuredMaileeIndividualIdentification
type
{Sub}
[subschema]
type
{ABC}
UnstructuredMaileeIndividualIdentification
type
{Sub}
[subschema]
type
2.1.3.27.2 [1] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
UnstructuredMaileeIndividualIdentificationstringfalse
[1] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.28 Field UnstructuredMaileeIndividualIdentification
2.1.3.28.1 UnstructuredMaileeIndividualIdentification Tree Diagram
{ABC}
UnstructuredMaileeIndividualIdentification
type
{ABC}
UnstructuredMaileeIndividualIdentification
type
UnstructuredMaileeIndividualIdentification properties
PropertyValue
Name UnstructuredMaileeIndividualIdentification
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample A la soeur de
Comments
2.1.3.29 Field MaileeOrganizationIdentification
2.1.3.29.1 MaileeOrganizationIdentification Tree Diagram
X
MaileeOrganizationIdentification
type
MaileeOrganizationIdentification
type
2.1.3.29.2 MaileeOrganizationIdentification Hierarchy
Parent field: MaileeAndAddressee
Child field(s):
FieldTypeReqKeyDescription
oneOfchoicefalse
MaileeOrganizationIdentification properties
PropertyValue
Name MaileeOrganizationIdentification
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.30 Field oneOf
2.1.3.30.1 oneOf Tree Diagram
X
{Sub}
[1]
type
{Sub}
[0]
type
{Sub}
[1]
type
{Sub}
[0]
type
2.1.3.30.2 oneOf Hierarchy
Parent field: MaileeOrganizationIdentification
Child field(s):
FieldTypeReqKeyDescription
[0]subschemafalse
[1]subschemafalse
oneOf properties
PropertyValue
Choice oneOf
2.1.3.31 Field [0]
2.1.3.31.1 [0] Tree Diagram
{...}
StructuredMaileeOrganizationIdentification
type
{Sub}
[subschema]
type
{...}
StructuredMaileeOrganizationIdentification
type
{Sub}
[subschema]
type
2.1.3.31.2 [0] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredMaileeOrganizationIdentificationdocumentfalse
[0] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.1.3.32 Field StructuredMaileeOrganizationIdentification
2.1.3.32.1 StructuredMaileeOrganizationIdentification Tree Diagram
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
StructuredMaileeOrganizationIdentification
type
2.1.3.32.2 StructuredMaileeOrganizationIdentification Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
MaileeOrganizationFunctionstringfalse
MaileeOrganizationOrganizationalUnitstringfalse
MaileeOrganizationOrganizationalNamestringfalse
MaileeOrganizationLegalStatusstringfalse
StructuredMaileeOrganizationIdentification properties
PropertyValue
Name StructuredMaileeOrganizationIdentification
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.33 Field MaileeOrganizationFunction
2.1.3.33.1 MaileeOrganizationFunction Tree Diagram
{ABC}
MaileeOrganizationFunction
type
{ABC}
MaileeOrganizationFunction
type
MaileeOrganizationFunction properties
PropertyValue
Name MaileeOrganizationFunction
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.34 Field MaileeOrganizationOrganizationalUnit
2.1.3.34.1 MaileeOrganizationOrganizationalUnit Tree Diagram
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
MaileeOrganizationOrganizationalUnit properties
PropertyValue
Name MaileeOrganizationOrganizationalUnit
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.35 Field MaileeOrganizationOrganizationalName
2.1.3.35.1 MaileeOrganizationOrganizationalName Tree Diagram
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalName
type
MaileeOrganizationOrganizationalName properties
PropertyValue
Name MaileeOrganizationOrganizationalName
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.36 Field MaileeOrganizationLegalStatus
2.1.3.36.1 MaileeOrganizationLegalStatus Tree Diagram
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationLegalStatus
type
MaileeOrganizationLegalStatus properties
PropertyValue
Name MaileeOrganizationLegalStatus
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.37 Field [1]
2.1.3.37.1 [1] Tree Diagram
{ABC}
UnstructuredMaileeOrganizationIdentification
type
{Sub}
[subschema]
type
{ABC}
UnstructuredMaileeOrganizationIdentification
type
{Sub}
[subschema]
type
2.1.3.37.2 [1] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
UnstructuredMaileeOrganizationIdentificationstringfalse
[1] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.38 Field UnstructuredMaileeOrganizationIdentification
2.1.3.38.1 UnstructuredMaileeOrganizationIdentification Tree Diagram
{ABC}
UnstructuredMaileeOrganizationIdentification
type
{ABC}
UnstructuredMaileeOrganizationIdentification
type
UnstructuredMaileeOrganizationIdentification properties
PropertyValue
Name UnstructuredMaileeOrganizationIdentification
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample GHE Consulting SCS
Comments
2.1.3.39 Field MailRecipientDispatchingInformation
2.1.3.39.1 MailRecipientDispatchingInformation Tree Diagram
X
MailRecipientDispatchingInformation
type
MailRecipientDispatchingInformation
type
2.1.3.39.2 MailRecipientDispatchingInformation Hierarchy
Parent field: MaileeAndAddressee
Child field(s):
FieldTypeReqKeyDescription
oneOfchoicefalse
MailRecipientDispatchingInformation properties
PropertyValue
Name MailRecipientDispatchingInformation
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments Optional, but preferable for Registered mail and Parcels
2.1.3.40 Field oneOf
2.1.3.40.1 oneOf Tree Diagram
X
{Sub}
[1]
type
{Sub}
[0]
type
{Sub}
[1]
type
{Sub}
[0]
type
2.1.3.40.2 oneOf Hierarchy
Parent field: MailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
[0]subschemafalse
[1]subschemafalse
oneOf properties
PropertyValue
Choice oneOf
2.1.3.41 Field [0]
2.1.3.41.1 [0] Tree Diagram
{...}
StructuredMailRecipientDispatchingInformation
type
{Sub}
[subschema]
type
{...}
StructuredMailRecipientDispatchingInformation
type
{Sub}
[subschema]
type
2.1.3.41.2 [0] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredMailRecipientDispatchingInformationdocumentfalse
[0] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.1.3.42 Field StructuredMailRecipientDispatchingInformation
2.1.3.42.1 StructuredMailRecipientDispatchingInformation Tree Diagram
{ABC}
BuildingConstruction
type
{...}
Door
type
{...}
Floor
type
{...}
Stairwell
type
{...}
Wing
type
StructuredMailRecipientDispatchingInformation
type
{ABC}
BuildingConstruction
type
{...}
Door
type
{...}
Floor
type
{...}
Stairwell
type
{...}
Wing
type
StructuredMailRecipientDispatchingInformation
type
2.1.3.42.2 StructuredMailRecipientDispatchingInformation Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
WingdocumentfalseElement identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed.
StairwelldocumentfalseElement indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west.
FloordocumentfalseElement indicating the floor or level on which a delivery point is located in a multi-story construction.
DoordocumentfalseAddress Element indicating the apartment, room or office in, at or adjacent to which a delivery point which is situated within a building is located.
BuildingConstructionstringfalseS42 name: Building/Construction Level 1, code: 30.26.1.0.0, Element identifying the "number" or "name and type" of the building, unit or construction in or adjacent to which a delivery point is located. E.g. Batiment A, Block 7, Houseboat, London Tower, ...
StructuredMailRecipientDispatchingInformation properties
PropertyValue
Name StructuredMailRecipientDispatchingInformation
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.43 Field Wing
2.1.3.43.1 Wing Tree Diagram
{ABC}
WingIndicator
type
{ABC}
WingType
type
Wing
type
{ABC}
WingIndicator
type
{ABC}
WingType
type
Wing
type
2.1.3.43.2 Wing Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
WingTypestringfalseS42 name: Wing Type, code: 30.29.0.0.1
WingIndicatorstringfalseS42 name: Wing Indicator, code: 30.29.0.0.2
Wing properties
PropertyValue
Name Wing
Id
Type document
Description Element identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed.
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.44 Field WingType
2.1.3.44.1 WingType Tree Diagram
{ABC}
WingType
type
{ABC}
WingType
type
WingType properties
PropertyValue
Name WingType
Id
Type string
Description S42 name: Wing Type, code: 30.29.0.0.1
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.45 Field WingIndicator
2.1.3.45.1 WingIndicator Tree Diagram
{ABC}
WingIndicator
type
{ABC}
WingIndicator
type
WingIndicator properties
PropertyValue
Name WingIndicator
Id
Type string
Description S42 name: Wing Indicator, code: 30.29.0.0.2
Dependencies 5f2d0e20-df1e-11e6-a3dd-6de9a4b3cd36
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.46 Field Stairwell
2.1.3.46.1 Stairwell Tree Diagram
{ABC}
StairwellIndicator
type
{ABC}
StairwellType
type
Stairwell
type
{ABC}
StairwellIndicator
type
{ABC}
StairwellType
type
Stairwell
type
2.1.3.46.2 Stairwell Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
StairwellTypestringfalseS42 name: Stairwell Type, code: 30.30.0.0.1
StairwellIndicatorstringfalseS42 name: Stairwell Indicator, code: 30.30.0.0.2
Stairwell properties
PropertyValue
Name Stairwell
Id
Type document
Description Element indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west.
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.47 Field StairwellType
2.1.3.47.1 StairwellType Tree Diagram
{ABC}
StairwellType
type
{ABC}
StairwellType
type
StairwellType properties
PropertyValue
Name StairwellType
Id
Type string
Description S42 name: Stairwell Type, code: 30.30.0.0.1
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.48 Field StairwellIndicator
2.1.3.48.1 StairwellIndicator Tree Diagram
{ABC}
StairwellIndicator
type
{ABC}
StairwellIndicator
type
StairwellIndicator properties
PropertyValue
Name StairwellIndicator
Id
Type string
Description S42 name: Stairwell Indicator, code: 30.30.0.0.2
Dependencies b508bb00-df1e-11e6-a3dd-6de9a4b3cd36
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.49 Field Floor
2.1.3.49.1 Floor Tree Diagram
{ABC}
FloorIndicator
type
{ABC}
FloorType
type
Floor
type
{ABC}
FloorIndicator
type
{ABC}
FloorType
type
Floor
type
2.1.3.49.2 Floor Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
FloorTypestringfalseS42 name: Floor Type, code: 30.31.0.0.1
FloorIndicatorstringfalseS42 name: Floor Indicator, code: 30.31.0.0.2
Floor properties
PropertyValue
Name Floor
Id
Type document
Description Element indicating the floor or level on which a delivery point is located in a multi-story construction.
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.50 Field FloorType
2.1.3.50.1 FloorType Tree Diagram
{ABC}
FloorType
type
{ABC}
FloorType
type
FloorType properties
PropertyValue
Name FloorType
Id
Type string
Description S42 name: Floor Type, code: 30.31.0.0.1
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.51 Field FloorIndicator
2.1.3.51.1 FloorIndicator Tree Diagram
{ABC}
FloorIndicator
type
{ABC}
FloorIndicator
type
FloorIndicator properties
PropertyValue
Name FloorIndicator
Id
Type string
Description S42 name: Floor Indicator, code: 30.31.0.0.2
Dependencies 01a99510-df1f-11e6-a3dd-6de9a4b3cd36
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.52 Field Door
2.1.3.52.1 Door Tree Diagram
{ABC}
DoorIndicator
type
{ABC}
DoorType
type
Door
type
{ABC}
DoorIndicator
type
{ABC}
DoorType
type
Door
type
2.1.3.52.2 Door Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
DoorTypestringfalseS42 name: Door Type, code: 30.32.0.0.1
DoorIndicatorstringfalseS42 name: Door Indicator, code: 30.32.0.0.2
Door properties
PropertyValue
Name Door
Id
Type document
Description Address Element indicating the apartment, room or office in, at or adjacent to which a delivery point which is situated within a building is located.
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.53 Field DoorType
2.1.3.53.1 DoorType Tree Diagram
{ABC}
DoorType
type
{ABC}
DoorType
type
DoorType properties
PropertyValue
Name DoorType
Id
Type string
Description S42 name: Door Type, code: 30.32.0.0.1
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.54 Field DoorIndicator
2.1.3.54.1 DoorIndicator Tree Diagram
{ABC}
DoorIndicator
type
{ABC}
DoorIndicator
type
DoorIndicator properties
PropertyValue
Name DoorIndicator
Id
Type string
Description S42 name: Door Indicator, code: 30.32.0.0.2
Dependencies 3c71a5c0-df1f-11e6-a3dd-6de9a4b3cd36
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.55 Field BuildingConstruction
2.1.3.55.1 BuildingConstruction Tree Diagram
{ABC}
BuildingConstruction
type
{ABC}
BuildingConstruction
type
BuildingConstruction properties
PropertyValue
Name BuildingConstruction
Id
Type string
Description S42 name: Building/Construction Level 1, code: 30.26.1.0.0, Element identifying the "number" or "name and type" of the building, unit or construction in or adjacent to which a delivery point is located. E.g. Batiment A, Block 7, Houseboat, London Tower, ...
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.56 Field [1]
2.1.3.56.1 [1] Tree Diagram
{ABC}
UnstructuredMailRecipientDispatchingInformation
type
{Sub}
[subschema]
type
{ABC}
UnstructuredMailRecipientDispatchingInformation
type
{Sub}
[subschema]
type
2.1.3.56.2 [1] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
UnstructuredMailRecipientDispatchingInformationstringfalse
[1] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.57 Field UnstructuredMailRecipientDispatchingInformation
2.1.3.57.1 UnstructuredMailRecipientDispatchingInformation Tree Diagram
{ABC}
UnstructuredMailRecipientDispatchingInformation
type
{ABC}
UnstructuredMailRecipientDispatchingInformation
type
UnstructuredMailRecipientDispatchingInformation properties
PropertyValue
Name UnstructuredMailRecipientDispatchingInformation
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.58 Field PostalAddress
2.1.3.58.1 PostalAddress Tree Diagram
{ABC}
CountryName
type
{...}
PostalCodeMunicipality
type
{...}
DeliveryPointLocation
type
{...}
OtherDeliveryInformation
type
PostalAddress
type
{ABC}
CountryName
type
{...}
PostalCodeMunicipality
type
{...}
DeliveryPointLocation
type
{...}
OtherDeliveryInformation
type
PostalAddress
type
2.1.3.58.2 PostalAddress Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
OtherDeliveryInformationdocumentfalsePO Box Number or bpack 24/7 name
DeliveryPointLocationdocumentfalse
PostalCodeMunicipalitydocumenttrue
CountryNamestringfalseS42 name: Country, code: 40.14.0.0.0 - Only for cross-border mail
PostalAddress properties
PropertyValue
Name PostalAddress
Id
Type document
Description This section is mandatory, and needs to include at least the Postal Code Municipality group, plus typically the Delivery Point Location group (with a stree tname and house number), or alternatively the Other Delivery Information group (for a PO Box).
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.1.3.59 Field OtherDeliveryInformation
2.1.3.59.1 OtherDeliveryInformation Tree Diagram
X
OtherDeliveryInformation
type
OtherDeliveryInformation
type
2.1.3.59.2 OtherDeliveryInformation Hierarchy
Parent field: PostalAddress
Child field(s):
FieldTypeReqKeyDescription
oneOfchoicefalse
OtherDeliveryInformation properties
PropertyValue
Name OtherDeliveryInformation
Id
Type document
Description PO Box Number or bpack 24/7 name
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.60 Field oneOf
2.1.3.60.1 oneOf Tree Diagram
X
{Sub}
[1]
type
{Sub}
[0]
type
{Sub}
[1]
type
{Sub}
[0]
type
2.1.3.60.2 oneOf Hierarchy
Parent field: OtherDeliveryInformation
Child field(s):
FieldTypeReqKeyDescription
[0]subschemafalse
[1]subschemafalse
oneOf properties
PropertyValue
Choice oneOf
2.1.3.61 Field [0]
2.1.3.61.1 [0] Tree Diagram
{...}
StructuredOtherDeliveryInformation
type
{Sub}
[subschema]
type
{...}
StructuredOtherDeliveryInformation
type
{Sub}
[subschema]
type
2.1.3.61.2 [0] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredOtherDeliveryInformationdocumentfalse
[0] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.1.3.62 Field StructuredOtherDeliveryInformation
2.1.3.62.1 StructuredOtherDeliveryInformation Tree Diagram
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
StructuredOtherDeliveryInformation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
StructuredOtherDeliveryInformation
type
2.1.3.62.2 StructuredOtherDeliveryInformation Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
DeliveryServiceTypestringfalse
DeliveryServiceIndicatorstringfalse
StructuredOtherDeliveryInformation properties
PropertyValue
Name StructuredOtherDeliveryInformation
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.63 Field DeliveryServiceType
2.1.3.63.1 DeliveryServiceType Tree Diagram
{ABC}
DeliveryServiceType
type
{ABC}
DeliveryServiceType
type
DeliveryServiceType properties
PropertyValue
Name DeliveryServiceType
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.64 Field DeliveryServiceIndicator
2.1.3.64.1 DeliveryServiceIndicator Tree Diagram
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceIndicator
type
DeliveryServiceIndicator properties
PropertyValue
Name DeliveryServiceIndicator
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.65 Field [1]
2.1.3.65.1 [1] Tree Diagram
{ABC}
UnstructuredOtherDeliveryInformation
type
{Sub}
[subschema]
type
{ABC}
UnstructuredOtherDeliveryInformation
type
{Sub}
[subschema]
type
2.1.3.65.2 [1] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
UnstructuredOtherDeliveryInformationstringfalse
[1] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.66 Field UnstructuredOtherDeliveryInformation
2.1.3.66.1 UnstructuredOtherDeliveryInformation Tree Diagram
{ABC}
UnstructuredOtherDeliveryInformation
type
{ABC}
UnstructuredOtherDeliveryInformation
type
UnstructuredOtherDeliveryInformation properties
PropertyValue
Name UnstructuredOtherDeliveryInformation
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.67 Field DeliveryPointLocation
2.1.3.67.1 DeliveryPointLocation Tree Diagram
X
DeliveryPointLocation
type
DeliveryPointLocation
type
2.1.3.67.2 DeliveryPointLocation Hierarchy
Parent field: PostalAddress
Child field(s):
FieldTypeReqKeyDescription
oneOfchoicefalse
DeliveryPointLocation properties
PropertyValue
Name DeliveryPointLocation
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.68 Field oneOf
2.1.3.68.1 oneOf Tree Diagram
X
{Sub}
[1]
type
{Sub}
[0]
type
{Sub}
[1]
type
{Sub}
[0]
type
2.1.3.68.2 oneOf Hierarchy
Parent field: DeliveryPointLocation
Child field(s):
FieldTypeReqKeyDescription
[0]subschemafalse
[1]subschemafalse
oneOf properties
PropertyValue
Choice oneOf
2.1.3.69 Field [0]
2.1.3.69.1 [0] Tree Diagram
{...}
StructuredDeliveryPointLocation
type
{Sub}
[subschema]
type
{...}
StructuredDeliveryPointLocation
type
{Sub}
[subschema]
type
2.1.3.69.2 [0] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredDeliveryPointLocationdocumentfalse
[0] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.1.3.70 Field StructuredDeliveryPointLocation
2.1.3.70.1 StructuredDeliveryPointLocation Tree Diagram
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
StreetName
type
StructuredDeliveryPointLocation
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
StreetName
type
StructuredDeliveryPointLocation
type
2.1.3.70.2 StructuredDeliveryPointLocation Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StreetNamestringfalse
StreetNumberstringfalse
BoxNumberstringfalse
StructuredDeliveryPointLocation properties
PropertyValue
Name StructuredDeliveryPointLocation
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.1.3.71 Field StreetName
2.1.3.71.1 StreetName Tree Diagram
{ABC}
StreetName
type
{ABC}
StreetName
type
StreetName properties
PropertyValue
Name StreetName
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample Rue Edouard dekoster
Comments
2.1.3.72 Field StreetNumber
2.1.3.72.1 StreetNumber Tree Diagram
{ABC}
StreetNumber
type
{ABC}
StreetNumber
type
StreetNumber properties
PropertyValue
Name StreetNumber
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample 64
Comments
2.1.3.73 Field BoxNumber
2.1.3.73.1 BoxNumber Tree Diagram
{ABC}
BoxNumber
type
{ABC}
BoxNumber
type
BoxNumber properties
PropertyValue
Name BoxNumber
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample 84
Comments
2.1.3.74 Field [1]
2.1.3.74.1 [1] Tree Diagram
{ABC}
UnstructuredDeliveryPointLocation
type
{Sub}
[subschema]
type
{ABC}
UnstructuredDeliveryPointLocation
type
{Sub}
[subschema]
type
2.1.3.74.2 [1] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
UnstructuredDeliveryPointLocationstringfalse
[1] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.75 Field UnstructuredDeliveryPointLocation
2.1.3.75.1 UnstructuredDeliveryPointLocation Tree Diagram
{ABC}
UnstructuredDeliveryPointLocation
type
{ABC}
UnstructuredDeliveryPointLocation
type
UnstructuredDeliveryPointLocation properties
PropertyValue
Name UnstructuredDeliveryPointLocation
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.76 Field PostalCodeMunicipality
2.1.3.76.1 PostalCodeMunicipality Tree Diagram
X
PostalCodeMunicipality
type
PostalCodeMunicipality
type
2.1.3.76.2 PostalCodeMunicipality Hierarchy
Parent field: PostalAddress
Child field(s):
FieldTypeReqKeyDescription
oneOfchoicefalse
PostalCodeMunicipality properties
PropertyValue
Name PostalCodeMunicipality
Id
Type document
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.77 Field oneOf
2.1.3.77.1 oneOf Tree Diagram
X
{Sub}
[1]
type
{Sub}
[0]
type
{Sub}
[1]
type
{Sub}
[0]
type
2.1.3.77.2 oneOf Hierarchy
Parent field: PostalCodeMunicipality
Child field(s):
FieldTypeReqKeyDescription
[0]subschemafalse
[1]subschemafalse
oneOf properties
PropertyValue
Choice oneOf
2.1.3.78 Field [0]
2.1.3.78.1 [0] Tree Diagram
{...}
StructuredPostalCodeMunicipality
type
{Sub}
[subschema]
type
{...}
StructuredPostalCodeMunicipality
type
{Sub}
[subschema]
type
2.1.3.78.2 [0] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredPostalCodeMunicipalitydocumentfalse
[0] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.1.3.79 Field StructuredPostalCodeMunicipality
2.1.3.79.1 StructuredPostalCodeMunicipality Tree Diagram
{ABC}
DeliveryServiceQualifier
type
{ABC}
MunicipalityName
type
{ABC}
PostalCode
type
StructuredPostalCodeMunicipality
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
MunicipalityName
type
{ABC}
PostalCode
type
StructuredPostalCodeMunicipality
type
2.1.3.79.2 StructuredPostalCodeMunicipality Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
PostalCodestringtrueMunicipality postal code
MunicipalityNamestringtrue
DeliveryServiceQualifierstringfalseIn case of a PO Box, this field is used to designate the bpost retail office where the box is located. It is used to differentiate the retail office in case of multiple offices per municipality.
StructuredPostalCodeMunicipality properties
PropertyValue
Name StructuredPostalCodeMunicipality
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.1.3.80 Field PostalCode
2.1.3.80.1 PostalCode Tree Diagram
{ABC}
PostalCode
type
{ABC}
PostalCode
type
PostalCode properties
PropertyValue
Name PostalCode
Id
Type string
Description Municipality postal code
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length 4
Max length 4
Pattern
Format
Enum
Sample 1140
Comments
2.1.3.81 Field MunicipalityName
2.1.3.81.1 MunicipalityName Tree Diagram
{ABC}
MunicipalityName
type
{ABC}
MunicipalityName
type
MunicipalityName properties
PropertyValue
Name MunicipalityName
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample Bruxelles
Comments
2.1.3.82 Field DeliveryServiceQualifier
2.1.3.82.1 DeliveryServiceQualifier Tree Diagram
{ABC}
DeliveryServiceQualifier
type
{ABC}
DeliveryServiceQualifier
type
DeliveryServiceQualifier properties
PropertyValue
Name DeliveryServiceQualifier
Id
Type string
Description In case of a PO Box, this field is used to designate the bpost retail office where the box is located. It is used to differentiate the retail office in case of multiple offices per municipality.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.83 Field [1]
2.1.3.83.1 [1] Tree Diagram
{ABC}
UnstructuredPostalCodeMunicipality
type
{Sub}
[subschema]
type
{ABC}
UnstructuredPostalCodeMunicipality
type
{Sub}
[subschema]
type
2.1.3.83.2 [1] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
UnstructuredPostalCodeMunicipalitystringfalse
[1] properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.84 Field UnstructuredPostalCodeMunicipality
2.1.3.84.1 UnstructuredPostalCodeMunicipality Tree Diagram
{ABC}
UnstructuredPostalCodeMunicipality
type
{ABC}
UnstructuredPostalCodeMunicipality
type
UnstructuredPostalCodeMunicipality properties
PropertyValue
Name UnstructuredPostalCodeMunicipality
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample 70035 Paris
Comments
2.1.3.85 Field CountryName
2.1.3.85.1 CountryName Tree Diagram
{ABC}
CountryName
type
{ABC}
CountryName
type
CountryName properties
PropertyValue
Name CountryName
Id
Type string
Description S42 name: Country, code: 40.14.0.0.0 - Only for cross-border mail
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample Belgique
Comments
2.1.3.86 Field [1]
2.1.3.86.1 [1] Tree Diagram
{...}
AddressBlockLines
type
{Sub}
[subschema]
type
{...}
AddressBlockLines
type
{Sub}
[subschema]
type
2.1.3.86.2 [1] Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
AddressBlockLinesdocumentfalse
[1] properties
PropertyValue
Id
Description Addresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components. This branch of the choice describes the address block lines. This is not the prefered method for address recognition, but it is permitted. bpost's algorithms will attempt to parse the submitted lines and identify the different elements so they can be mapped to the standard structure of an address.
Required
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.87 Field AddressBlockLines
2.1.3.87.1 AddressBlockLines Tree Diagram
[...]
UnstructuredAddressLine
type
AddressBlockLines
type
[...]
UnstructuredAddressLine
type
AddressBlockLines
type
2.1.3.87.2 AddressBlockLines Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
UnstructuredAddressLinearraytrue
AddressBlockLines properties
PropertyValue
Name AddressBlockLines
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.1.3.88 Field UnstructuredAddressLine
2.1.3.88.1 UnstructuredAddressLine Tree Diagram
{...}
[0]*
type
[...]
UnstructuredAddressLine
type
{...}
[0]*
type
[...]
UnstructuredAddressLine
type
2.1.3.88.2 UnstructuredAddressLine Hierarchy
Parent field: AddressBlockLines
Child field(s):
FieldTypeReqKeyDescription
[0]documentfalse
UnstructuredAddressLine properties
PropertyValue
Name UnstructuredAddressLine
Id
Type array
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min items 1
Max items 7
Unique items
Additional items true
Comments
2.1.3.89 Field [0]
2.1.3.89.1 [0] Tree Diagram
{ABC}
*body
type
[0]
type
{ABC}
*body
type
[0]
type
2.1.3.89.2 [0] Hierarchy
Parent field: UnstructuredAddressLine
Child field(s):
FieldTypeReqKeyDescription
*bodystringtrue
[0] properties
PropertyValue
Name
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.1.3.90 Field *body
2.1.3.90.1 *body Tree Diagram
{ABC}
*body
type
{ABC}
*body
type
*body properties
PropertyValue
Name *body
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample 1150 Bruxelles
Comments
2.1.3.91 Field DispatchingCountryISOCode
2.1.3.91.1 DispatchingCountryISOCode Tree Diagram
{ABC}
DispatchingCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
DispatchingCountryISOCode properties
PropertyValue
Name DispatchingCountryISOCode
Id
Type string
Description S42 name: Dispatching Country ISO Code, code: 50.53.0.0.0
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample BE
Comments
2.1.3.92 Field DeliveringCountryISOCode
2.1.3.92.1 DeliveringCountryISOCode Tree Diagram
{ABC}
DeliveringCountryISOCode
type
{ABC}
DeliveringCountryISOCode
type
DeliveringCountryISOCode properties
PropertyValue
Name DeliveringCountryISOCode
Id
Type string
Description S42 name: Delivering Country ISO Code, code: 50.54.0.0.0. This field determines which S42 template will be chosen.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample BE
Comments
2.1.3.93 Field ValidateAddressOptions
2.1.3.93.1 ValidateAddressOptions Tree Diagram
{0/1}
IncludeNumberOfBoxes
type
{0/1}
IncludeListOfBoxes
type
{0/1}
IncludeDefaultGeoLocation
type
{0/1}
IncludeSubmittedAddress
type
{0/1}
IncludeSuggestions
type
{0/1}
IncludeFormatting
type
ValidateAddressOptions
type
{0/1}
IncludeNumberOfBoxes
type
{0/1}
IncludeListOfBoxes
type
{0/1}
IncludeDefaultGeoLocation
type
{0/1}
IncludeSubmittedAddress
type
{0/1}
IncludeSuggestions
type
{0/1}
IncludeFormatting
type
ValidateAddressOptions
type
2.1.3.93.2 ValidateAddressOptions Hierarchy
Parent field: ValidateAddressesRequest
Child field(s):
FieldTypeReqKeyDescription
IncludeFormattingbooleanfalseThis option returns the formatted label for each validated address (or address alternative or address suggestion). Default = true.
IncludeSuggestionsbooleanfalseThis option returns suggestions (if there are any) for a validation request. Default = true.
IncludeSubmittedAddressbooleanfalse
IncludeDefaultGeoLocationbooleanfalseS42 name: Include Default GeoLocation: Default. GeoLocation is the set of coordinates that better matches the standard bpost consumer need, in terms of geodesic system (WGS84), high reliability, perspective type (highest priority given to OSM projections), type of coordinates (DEGDEC). This set of coordinates can be used to load a GPS, call a Google service to visualize the point on a card, … . Default = false.
IncludeListOfBoxesbooleanfalseThis option, returns the list of normal mailboxes for the requested address.
IncludeNumberOfBoxesbooleanfalseThis option, returns the number of normal mailboxes for the requested address.
ValidateAddressOptions properties
PropertyValue
Name ValidateAddressOptions
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.1.3.94 Field IncludeFormatting
2.1.3.94.1 IncludeFormatting Tree Diagram
{0/1}
IncludeFormatting
type
{0/1}
IncludeFormatting
type
IncludeFormatting properties
PropertyValue
Name IncludeFormatting
Id
Type boolean
Description This option returns the formatted label for each validated address (or address alternative or address suggestion). Default = true.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Sample true
Comments
2.1.3.95 Field IncludeSuggestions
2.1.3.95.1 IncludeSuggestions Tree Diagram
{0/1}
IncludeSuggestions
type
{0/1}
IncludeSuggestions
type
IncludeSuggestions properties
PropertyValue
Name IncludeSuggestions
Id
Type boolean
Description This option returns suggestions (if there are any) for a validation request. Default = true.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Sample true
Comments
2.1.3.96 Field IncludeSubmittedAddress
2.1.3.96.1 IncludeSubmittedAddress Tree Diagram
{0/1}
IncludeSubmittedAddress
type
{0/1}
IncludeSubmittedAddress
type
IncludeSubmittedAddress properties
PropertyValue
Name IncludeSubmittedAddress
Id
Type boolean
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Sample true
Comments
2.1.3.97 Field IncludeDefaultGeoLocation
2.1.3.97.1 IncludeDefaultGeoLocation Tree Diagram
{0/1}
IncludeDefaultGeoLocation
type
{0/1}
IncludeDefaultGeoLocation
type
IncludeDefaultGeoLocation properties
PropertyValue
Name IncludeDefaultGeoLocation
Id
Type boolean
Description S42 name: Include Default GeoLocation: Default. GeoLocation is the set of coordinates that better matches the standard bpost consumer need, in terms of geodesic system (WGS84), high reliability, perspective type (highest priority given to OSM projections), type of coordinates (DEGDEC). This set of coordinates can be used to load a GPS, call a Google service to visualize the point on a card, … . Default = false.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Sample
Comments
2.1.3.98 Field IncludeListOfBoxes
2.1.3.98.1 IncludeListOfBoxes Tree Diagram
{0/1}
IncludeListOfBoxes
type
{0/1}
IncludeListOfBoxes
type
IncludeListOfBoxes properties
PropertyValue
Name IncludeListOfBoxes
Id
Type boolean
Description This option, returns the list of normal mailboxes for the requested address.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Sample
Comments
2.1.3.99 Field IncludeNumberOfBoxes
2.1.3.99.1 IncludeNumberOfBoxes Tree Diagram
{0/1}
IncludeNumberOfBoxes
type
{0/1}
IncludeNumberOfBoxes
type
IncludeNumberOfBoxes properties
PropertyValue
Name IncludeNumberOfBoxes
Id
Type boolean
Description This option, returns the number of normal mailboxes for the requested address.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Sample
Comments
2.1.3.100 Field CallerIdentification
2.1.3.100.1 CallerIdentification Tree Diagram
{ABC}
CallerName
type
CallerIdentification
type
{ABC}
CallerName
type
CallerIdentification
type
2.1.3.100.2 CallerIdentification Hierarchy
Parent field: ValidateAddressesRequest
Child field(s):
FieldTypeReqKeyDescription
CallerNamestringtrue
CallerIdentification properties
PropertyValue
Name CallerIdentification
Id
Type document
Description Information about the caller of the service, in case no authentication mechanism exists.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.1.3.101 Field CallerName
2.1.3.101.1 CallerName Tree Diagram
{ABC}
CallerName
type
{ABC}
CallerName
type
CallerName properties
PropertyValue
Name CallerName
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample ZALANDO
Comments
2.1.7 Request Definitions (TBD)
2.1.8 Request JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Request",
    "description": "Request schema specification for bpost Address Validation webservice",
    "additionalProperties": true,
    "endPoint": "http://webservices-pub.bpost.be",
    "isRestfulApi": true,
    "mediaType": "application/JSON",
    "properties": {
        "ValidateAddressesRequest": {
            "properties": {
                "AddressToValidateList": {
                    "properties": {
                        "AddressToValidate": {
                            "primaryKey": false,
                            "additionalItems": true,
                            "maxItems": 200,
                            "minItems": 1,
                            "type": "array",
                            "GUID": "187d9863-de46-11e6-a3dd-6de9a4b3cd36",
                            "items": {
                                "additionalProperties": true,
                                "properties": {
                                    "@id": {
                                        "primaryKey": false,
                                        "type": "string",
                                        "GUID": "187d9865-de46-11e6-a3dd-6de9a4b3cd36",
                                        "sample": "1"
                                    },
                                    "DispatchingCountryISOCode": {
                                        "description": "S42 name: Dispatching Country ISO Code, code: 50.53.0.0.0",
                                        "primaryKey": false,
                                        "type": "string",
                                        "GUID": "187d9867-de46-11e6-a3dd-6de9a4b3cd36",
                                        "sample": "BE"
                                    },
                                    "DeliveringCountryISOCode": {
                                        "description": "S42 name: Delivering Country ISO Code, code: 50.54.0.0.0. This field determines which S42 template will be chosen.",
                                        "primaryKey": false,
                                        "type": "string",
                                        "GUID": "187d9866-de46-11e6-a3dd-6de9a4b3cd36",
                                        "sample": "BE"
                                    }
                                },
                                "primaryKey": false,
                                "type": "object",
                                "GUID": "187d9864-de46-11e6-a3dd-6de9a4b3cd36",
                                "arrayItem": true,
                                "oneOf": [
                                    {
                                        "description": "Addresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components.\n\nThis branch of the choice describes the address components.  Each address is divided in logical groups, for example the 'delivery point location' group (typically used to store the street name and house number).  Each logical group can itself be submitted in a structured manner (prefered method) identifying each individual field: one for the street name, one for the house number, and possibly one for the mailbox number.  Or it can be submitted in one one unstructured field.\n\nWhile in any individual group, you cannot submit a mix of structured and unstructured fields, you are allowed to make the choice of structured or unstructured for any group, and mix the mode between groups.  In other words, you could submit the group 'delivery point location' in an unstructured mode, and submit the 'postal code municipality' group in a structured mode.\n\nAddress recognition will be better if fully structured addresses are submitted.",
                                        "properties": {
                                            "MaileeAndAddressee": {
                                                "description": "This section is optional, but recommended.  At least the Addressee Individual Identification group.",
                                                "properties": {
                                                    "AddresseeIndividualIdentification": {
                                                        "additionalProperties": true,
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b1e19491-ded5-11e6-a3dd-6de9a4b3cd36",
                                                        "oneOf": [
                                                            {
                                                                "properties": {
                                                                    "StructuredAddresseeIndividualIdentification": {
                                                                        "properties": {
                                                                            "AddresseeFormOfAddress": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "99e29c51-dede-11e6-a3dd-6de9a4b3cd36",
                                                                                "sample": "Mr"
                                                                            },
                                                                            "AddresseeGivenName": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "99e29c52-dede-11e6-a3dd-6de9a4b3cd36",
                                                                                "sample": "Jacques"
                                                                            },
                                                                            "AddresseeSurname": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "99e29c53-dede-11e6-a3dd-6de9a4b3cd36",
                                                                                "sample": "Martin"
                                                                            },
                                                                            "AddresseeSupplementaryDispatchInfo": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "25ae89e0-df1d-11e6-a3dd-6de9a4b3cd36"
                                                                            }
                                                                        },
                                                                        "primaryKey": false,
                                                                        "type": "object",
                                                                        "GUID": "99e29c50-dede-11e6-a3dd-6de9a4b3cd36"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "6b670b40-dede-11e6-a3dd-6de9a4b3cd36"
                                                            },
                                                            {
                                                                "additionalProperties": true,
                                                                "properties": {
                                                                    "UnstructuredAddresseeIndividualIdentification": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "821c7d70-dede-11e6-a3dd-6de9a4b3cd36",
                                                                        "sample": "Mr François Hollande"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "762ebfa0-dede-11e6-a3dd-6de9a4b3cd36"
                                                            }
                                                        ],
                                                        "comments": "Mandatory if addressed mail"
                                                    },
                                                    "MaileeIndividualIdentification": {
                                                        "additionalProperties": true,
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b1e19496-ded5-11e6-a3dd-6de9a4b3cd36",
                                                        "oneOf": [
                                                            {
                                                                "properties": {
                                                                    "StructuredMaileeIndividualIdentification": {
                                                                        "additionalProperties": true,
                                                                        "properties": {
                                                                            "MaileeRole": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "453ba040-df1d-11e6-a3dd-6de9a4b3cd36"
                                                                            },
                                                                            "MaileeFormOfAddress": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "492d73e0-df1d-11e6-a3dd-6de9a4b3cd36"
                                                                            },
                                                                            "MaileeGivenName": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "5a02aff0-df1d-11e6-a3dd-6de9a4b3cd36"
                                                                            },
                                                                            "MaileeSurname": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "61894310-df1d-11e6-a3dd-6de9a4b3cd36"
                                                                            }
                                                                        },
                                                                        "primaryKey": false,
                                                                        "type": "object",
                                                                        "GUID": "933d6120-dee1-11e6-a3dd-6de9a4b3cd36"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "5b9937a0-dedf-11e6-a3dd-6de9a4b3cd36"
                                                            },
                                                            {
                                                                "additionalProperties": true,
                                                                "properties": {
                                                                    "UnstructuredMaileeIndividualIdentification": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "658447a0-dedf-11e6-a3dd-6de9a4b3cd36",
                                                                        "sample": "A la soeur de"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "5f2b8620-dedf-11e6-a3dd-6de9a4b3cd36"
                                                            }
                                                        ]
                                                    },
                                                    "MaileeOrganizationIdentification": {
                                                        "additionalProperties": true,
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b1e19498-ded5-11e6-a3dd-6de9a4b3cd36",
                                                        "oneOf": [
                                                            {
                                                                "properties": {
                                                                    "StructuredMaileeOrganizationIdentification": {
                                                                        "additionalProperties": true,
                                                                        "properties": {
                                                                            "MaileeOrganizationFunction": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "b139f530-df1d-11e6-a3dd-6de9a4b3cd36"
                                                                            },
                                                                            "MaileeOrganizationOrganizationalUnit": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "b85cbd70-df1d-11e6-a3dd-6de9a4b3cd36"
                                                                            },
                                                                            "MaileeOrganizationOrganizationalName": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "bf91d530-df1d-11e6-a3dd-6de9a4b3cd36"
                                                                            },
                                                                            "MaileeOrganizationLegalStatus": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "c9126390-df1d-11e6-a3dd-6de9a4b3cd36"
                                                                            }
                                                                        },
                                                                        "primaryKey": false,
                                                                        "type": "object",
                                                                        "GUID": "8f134830-df1d-11e6-a3dd-6de9a4b3cd36"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "9b5fd000-deea-11e6-a3dd-6de9a4b3cd36"
                                                            },
                                                            {
                                                                "additionalProperties": true,
                                                                "properties": {
                                                                    "UnstructuredMaileeOrganizationIdentification": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "75bd6ac0-dedf-11e6-a3dd-6de9a4b3cd36",
                                                                        "sample": "GHE Consulting SCS"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "701dc010-dedf-11e6-a3dd-6de9a4b3cd36"
                                                            }
                                                        ]
                                                    },
                                                    "MailRecipientDispatchingInformation": {
                                                        "additionalProperties": true,
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "e6071bd0-df1d-11e6-a3dd-6de9a4b3cd36",
                                                        "oneOf": [
                                                            {
                                                                "properties": {
                                                                    "StructuredMailRecipientDispatchingInformation": {
                                                                        "additionalProperties": true,
                                                                        "properties": {
                                                                            "Wing": {
                                                                                "description": "Element identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed.",
                                                                                "additionalProperties": true,
                                                                                "properties": {
                                                                                    "WingType": {
                                                                                        "description": "S42 name: Wing Type, code: 30.29.0.0.1",
                                                                                        "primaryKey": false,
                                                                                        "type": "string",
                                                                                        "GUID": "5f2d0e20-df1e-11e6-a3dd-6de9a4b3cd36"
                                                                                    },
                                                                                    "WingIndicator": {
                                                                                        "description": "S42 name: Wing Indicator, code: 30.29.0.0.2",
                                                                                        "primaryKey": false,
                                                                                        "type": "string",
                                                                                        "GUID": "8e917890-df1e-11e6-a3dd-6de9a4b3cd36"
                                                                                    }
                                                                                },
                                                                                "primaryKey": false,
                                                                                "type": "object",
                                                                                "GUID": "2db09920-df1e-11e6-a3dd-6de9a4b3cd36",
                                                                                "dependencies": {
                                                                                    "WingIndicator": [
                                                                                        "WingType"
                                                                                    ]
                                                                                }
                                                                            },
                                                                            "Stairwell": {
                                                                                "description": "Element indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west.",
                                                                                "additionalProperties": true,
                                                                                "properties": {
                                                                                    "StairwellType": {
                                                                                        "description": "S42 name: Stairwell Type, code: 30.30.0.0.1",
                                                                                        "primaryKey": false,
                                                                                        "type": "string",
                                                                                        "GUID": "b508bb00-df1e-11e6-a3dd-6de9a4b3cd36"
                                                                                    },
                                                                                    "StairwellIndicator": {
                                                                                        "description": "S42 name: Stairwell Indicator, code: 30.30.0.0.2",
                                                                                        "primaryKey": false,
                                                                                        "type": "string",
                                                                                        "GUID": "ce18e610-df1e-11e6-a3dd-6de9a4b3cd36"
                                                                                    }
                                                                                },
                                                                                "primaryKey": false,
                                                                                "type": "object",
                                                                                "GUID": "a9319270-df1e-11e6-a3dd-6de9a4b3cd36",
                                                                                "dependencies": {
                                                                                    "StairwellIndicator": [
                                                                                        "StairwellType"
                                                                                    ]
                                                                                }
                                                                            },
                                                                            "Floor": {
                                                                                "description": "Element indicating the floor or level on which a delivery point is located in a multi-story construction.",
                                                                                "additionalProperties": true,
                                                                                "properties": {
                                                                                    "FloorType": {
                                                                                        "description": "S42 name: Floor Type, code: 30.31.0.0.1",
                                                                                        "primaryKey": false,
                                                                                        "type": "string",
                                                                                        "GUID": "01a99510-df1f-11e6-a3dd-6de9a4b3cd36"
                                                                                    },
                                                                                    "FloorIndicator": {
                                                                                        "description": "S42 name: Floor Indicator, code: 30.31.0.0.2",
                                                                                        "primaryKey": false,
                                                                                        "type": "string",
                                                                                        "GUID": "16c83aa0-df1f-11e6-a3dd-6de9a4b3cd36"
                                                                                    }
                                                                                },
                                                                                "primaryKey": false,
                                                                                "type": "object",
                                                                                "GUID": "f36a4620-df1e-11e6-a3dd-6de9a4b3cd36",
                                                                                "dependencies": {
                                                                                    "FloorIndicator": [
                                                                                        "FloorType"
                                                                                    ]
                                                                                }
                                                                            },
                                                                            "Door": {
                                                                                "description": "Address Element indicating the apartment, room or office in, at or adjacent to which a delivery point which is situated within a building is located.",
                                                                                "additionalProperties": true,
                                                                                "properties": {
                                                                                    "DoorType": {
                                                                                        "description": "S42 name: Door Type, code: 30.32.0.0.1",
                                                                                        "primaryKey": false,
                                                                                        "type": "string",
                                                                                        "GUID": "3c71a5c0-df1f-11e6-a3dd-6de9a4b3cd36"
                                                                                    },
                                                                                    "DoorIndicator": {
                                                                                        "description": "S42 name: Door Indicator, code: 30.32.0.0.2",
                                                                                        "primaryKey": false,
                                                                                        "type": "string",
                                                                                        "GUID": "4e715810-df1f-11e6-a3dd-6de9a4b3cd36"
                                                                                    }
                                                                                },
                                                                                "primaryKey": false,
                                                                                "type": "object",
                                                                                "GUID": "30b09d40-df1f-11e6-a3dd-6de9a4b3cd36",
                                                                                "dependencies": {
                                                                                    "DoorIndicator": [
                                                                                        "DoorType"
                                                                                    ]
                                                                                }
                                                                            },
                                                                            "BuildingConstruction": {
                                                                                "description": "S42 name: Building/Construction Level 1, code: 30.26.1.0.0, Element identifying the \"number\" or \"name and type\" of the building, unit or construction in or adjacent to which a delivery point is located. E.g. Batiment A, Block 7, Houseboat, London Tower, ...",
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "587a7760-df1f-11e6-a3dd-6de9a4b3cd36"
                                                                            }
                                                                        },
                                                                        "primaryKey": false,
                                                                        "type": "object",
                                                                        "GUID": "10db28b0-df1e-11e6-a3dd-6de9a4b3cd36"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "01acbed0-df1e-11e6-a3dd-6de9a4b3cd36"
                                                            },
                                                            {
                                                                "additionalProperties": true,
                                                                "properties": {
                                                                    "UnstructuredMailRecipientDispatchingInformation": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "20693ec0-df1e-11e6-a3dd-6de9a4b3cd36"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "0c4ee9d0-df1e-11e6-a3dd-6de9a4b3cd36"
                                                            }
                                                        ],
                                                        "comments": "Optional, but preferable for Registered mail and Parcels"
                                                    }
                                                },
                                                "primaryKey": false,
                                                "type": "object",
                                                "GUID": "b1e19490-ded5-11e6-a3dd-6de9a4b3cd36"
                                            },
                                            "PostalAddress": {
                                                "description": "This section is mandatory, and needs to include at least the Postal Code Municipality group, plus typically the Delivery Point Location group (with a stree tname and house number), or alternatively the Other Delivery Information group (for a PO Box).",
                                                "properties": {
                                                    "OtherDeliveryInformation": {
                                                        "description": "PO Box Number or bpack 24/7 name",
                                                        "additionalProperties": true,
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "a77287e0-df1f-11e6-a3dd-6de9a4b3cd36",
                                                        "oneOf": [
                                                            {
                                                                "properties": {
                                                                    "StructuredOtherDeliveryInformation": {
                                                                        "additionalProperties": true,
                                                                        "properties": {
                                                                            "DeliveryServiceType": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "04d934b0-df20-11e6-a3dd-6de9a4b3cd36"
                                                                            },
                                                                            "DeliveryServiceIndicator": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "10dd87c0-df20-11e6-a3dd-6de9a4b3cd36"
                                                                            }
                                                                        },
                                                                        "primaryKey": false,
                                                                        "type": "object",
                                                                        "GUID": "f3578c00-df1f-11e6-a3dd-6de9a4b3cd36"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "d6e5bf60-df1f-11e6-a3dd-6de9a4b3cd36"
                                                            },
                                                            {
                                                                "additionalProperties": true,
                                                                "properties": {
                                                                    "UnstructuredOtherDeliveryInformation": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "ec7e28d0-df1f-11e6-a3dd-6de9a4b3cd36"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "db543d10-df1f-11e6-a3dd-6de9a4b3cd36"
                                                            }
                                                        ]
                                                    },
                                                    "DeliveryPointLocation": {
                                                        "additionalProperties": true,
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b87b0891-ded5-11e6-a3dd-6de9a4b3cd36",
                                                        "oneOf": [
                                                            {
                                                                "properties": {
                                                                    "StructuredDeliveryPointLocation": {
                                                                        "properties": {
                                                                            "StreetName": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "75dfd4f0-dee1-11e6-a3dd-6de9a4b3cd36",
                                                                                "sample": "Rue Edouard dekoster"
                                                                            },
                                                                            "StreetNumber": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "75dfd4f1-dee1-11e6-a3dd-6de9a4b3cd36",
                                                                                "sample": "64"
                                                                            },
                                                                            "BoxNumber": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "75dfd4f2-dee1-11e6-a3dd-6de9a4b3cd36",
                                                                                "sample": "84"
                                                                            }
                                                                        },
                                                                        "primaryKey": false,
                                                                        "type": "object",
                                                                        "GUID": "75dfade0-dee1-11e6-a3dd-6de9a4b3cd36"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "66e23f10-dee1-11e6-a3dd-6de9a4b3cd36"
                                                            },
                                                            {
                                                                "additionalProperties": true,
                                                                "properties": {
                                                                    "UnstructuredDeliveryPointLocation": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "287088b0-df20-11e6-a3dd-6de9a4b3cd36"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "6c215330-dee1-11e6-a3dd-6de9a4b3cd36"
                                                            }
                                                        ]
                                                    },
                                                    "PostalCodeMunicipality": {
                                                        "additionalProperties": true,
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b87b0896-ded5-11e6-a3dd-6de9a4b3cd36",
                                                        "oneOf": [
                                                            {
                                                                "properties": {
                                                                    "StructuredPostalCodeMunicipality": {
                                                                        "properties": {
                                                                            "PostalCode": {
                                                                                "description": "Municipality postal code",
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "e3595f91-dede-11e6-a3dd-6de9a4b3cd36",
                                                                                "sample": "1140",
                                                                                "maxLength": 4,
                                                                                "minLength": 4
                                                                            },
                                                                            "MunicipalityName": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "e3595f92-dede-11e6-a3dd-6de9a4b3cd36",
                                                                                "sample": "Bruxelles"
                                                                            },
                                                                            "DeliveryServiceQualifier": {
                                                                                "description": "In case of a PO Box, this field is used to designate the bpost retail office where the box is located.  It is used to differentiate the retail office in case of multiple offices per municipality.",
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "5470b980-df20-11e6-a3dd-6de9a4b3cd36"
                                                                            }
                                                                        },
                                                                        "primaryKey": false,
                                                                        "type": "object",
                                                                        "GUID": "e3595f90-dede-11e6-a3dd-6de9a4b3cd36",
                                                                        "required": [
                                                                            "PostalCode",
                                                                            "MunicipalityName"
                                                                        ]
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "d6a2d380-dede-11e6-a3dd-6de9a4b3cd36"
                                                            },
                                                            {
                                                                "additionalProperties": true,
                                                                "properties": {
                                                                    "UnstructuredPostalCodeMunicipality": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "ed7ae8e0-dede-11e6-a3dd-6de9a4b3cd36",
                                                                        "sample": "70035 Paris"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "dad16200-dede-11e6-a3dd-6de9a4b3cd36"
                                                            }
                                                        ]
                                                    },
                                                    "CountryName": {
                                                        "description": "S42 name: Country, code: 40.14.0.0.0 - Only for cross-border mail",
                                                        "primaryKey": false,
                                                        "type": "string",
                                                        "GUID": "b87b089a-ded5-11e6-a3dd-6de9a4b3cd36",
                                                        "sample": "Belgique"
                                                    }
                                                },
                                                "primaryKey": false,
                                                "type": "object",
                                                "GUID": "b87b0890-ded5-11e6-a3dd-6de9a4b3cd36",
                                                "required": [
                                                    "PostalCodeMunicipality"
                                                ]
                                            }
                                        },
                                        "primaryKey": false,
                                        "type": "object",
                                        "GUID": "a85a4f70-ded5-11e6-a3dd-6de9a4b3cd36",
                                        "required": [
                                            "PostalAddress"
                                        ]
                                    },
                                    {
                                        "description": "Addresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components.\n\nThis branch of the choice describes the address block lines.  This is not the prefered method for address recognition, but it is permitted.  bpost's algorithms will attempt to parse the submitted  lines and identify the different elements so they can be mapped to the standard structure of an address.",
                                        "additionalProperties": true,
                                        "properties": {
                                            "AddressBlockLines": {
                                                "properties": {
                                                    "UnstructuredAddressLine": {
                                                        "primaryKey": false,
                                                        "additionalItems": true,
                                                        "maxItems": 7,
                                                        "minItems": 1,
                                                        "type": "array",
                                                        "GUID": "953cf821-ded5-11e6-a3dd-6de9a4b3cd36",
                                                        "items": {
                                                            "properties": {
                                                                "*body": {
                                                                    "primaryKey": false,
                                                                    "type": "string",
                                                                    "GUID": "953cf823-ded5-11e6-a3dd-6de9a4b3cd36",
                                                                    "sample": "1150 Bruxelles"
                                                                }
                                                            },
                                                            "primaryKey": false,
                                                            "type": "object",
                                                            "GUID": "953cf822-ded5-11e6-a3dd-6de9a4b3cd36",
                                                            "arrayItem": true,
                                                            "required": [
                                                                "*body"
                                                            ]
                                                        }
                                                    }
                                                },
                                                "primaryKey": false,
                                                "type": "object",
                                                "GUID": "953cf820-ded5-11e6-a3dd-6de9a4b3cd36",
                                                "required": [
                                                    "UnstructuredAddressLine"
                                                ]
                                            }
                                        },
                                        "primaryKey": false,
                                        "type": "object",
                                        "GUID": "8b244870-ded5-11e6-a3dd-6de9a4b3cd36"
                                    }
                                ],
                                "required": [
                                    "@id"
                                ]
                            }
                        }
                    },
                    "primaryKey": false,
                    "type": "object",
                    "GUID": "187d9862-de46-11e6-a3dd-6de9a4b3cd36",
                    "required": [
                        "AddressToValidate"
                    ]
                },
                "ValidateAddressOptions": {
                    "properties": {
                        "IncludeFormatting": {
                            "description": "This option returns the formatted label for each validated address (or address alternative or address suggestion). Default = true.",
                            "primaryKey": false,
                            "type": "boolean",
                            "GUID": "187d987e-de46-11e6-a3dd-6de9a4b3cd36",
                            "sample": true
                        },
                        "IncludeSuggestions": {
                            "description": "This option returns suggestions (if there are any) for a validation request. Default = true.",
                            "primaryKey": false,
                            "type": "boolean",
                            "GUID": "187d987f-de46-11e6-a3dd-6de9a4b3cd36",
                            "sample": true
                        },
                        "IncludeSubmittedAddress": {
                            "primaryKey": false,
                            "type": "boolean",
                            "GUID": "187d9880-de46-11e6-a3dd-6de9a4b3cd36",
                            "sample": true
                        },
                        "IncludeDefaultGeoLocation": {
                            "description": "S42 name: Include Default GeoLocation: Default.\n\nGeoLocation is the set of coordinates that better matches the standard bpost consumer need, in terms of geodesic system (WGS84), \thigh reliability, perspective type (highest priority given to OSM \t\t\t\tprojections), type of coordinates (DEGDEC). This set of coordinates \tcan be used to load a GPS, call a Google service to visualize the point on a card, … . \n\nDefault = false.",
                            "primaryKey": false,
                            "type": "boolean",
                            "GUID": "54b51fb0-e148-11e6-898f-b7d201a89248"
                        },
                        "IncludeListOfBoxes": {
                            "description": "This option, returns the list of normal mailboxes for the requested address.",
                            "primaryKey": false,
                            "type": "boolean",
                            "GUID": "b5fc3b00-e148-11e6-898f-b7d201a89248"
                        },
                        "IncludeNumberOfBoxes": {
                            "description": "This option, returns the number of normal mailboxes for the requested address.",
                            "primaryKey": false,
                            "type": "boolean",
                            "GUID": "a83a3cf0-e149-11e6-898f-b7d201a89248"
                        }
                    },
                    "primaryKey": false,
                    "type": "object",
                    "GUID": "187d987d-de46-11e6-a3dd-6de9a4b3cd36"
                },
                "CallerIdentification": {
                    "description": "Information about the caller of the service, in case no authentication mechanism exists. ",
                    "properties": {
                        "CallerName": {
                            "primaryKey": false,
                            "type": "string",
                            "GUID": "187d9882-de46-11e6-a3dd-6de9a4b3cd36",
                            "sample": "ZALANDO"
                        }
                    },
                    "primaryKey": false,
                    "type": "object",
                    "GUID": "187d9881-de46-11e6-a3dd-6de9a4b3cd36",
                    "required": [
                        "CallerName"
                    ]
                }
            },
            "primaryKey": false,
            "type": "object",
            "GUID": "187d9861-de46-11e6-a3dd-6de9a4b3cd36",
            "required": [
                "AddressToValidateList"
            ]
        }
    },
    "type": "object",
    "required": [
        "ValidateAddressesRequest"
    ],
    "resources": "/ws/ExternalMailingAddressProofingCSREST_v1/address/validateAddresses"
}
2.1.9 Request JSON data
{
    "ValidateAddressesRequest": {
        "AddressToValidateList": {
            "AddressToValidate": [
                {
                    "@id": "1",
                    "MaileeAndAddressee": {
                        "AddresseeIndividualIdentification": {
                            "StructuredAddresseeIndividualIdentification": {
                                "AddresseeFormOfAddress": "Mr",
                                "AddresseeGivenName": "Jacques",
                                "AddresseeSurname": "Martin",
                                "AddresseeSupplementaryDispatchInfo": "Lorem"
                            }
                        },
                        "MaileeIndividualIdentification": {
                            "StructuredMaileeIndividualIdentification": {
                                "MaileeRole": "Lorem",
                                "MaileeFormOfAddress": "Lorem",
                                "MaileeGivenName": "Lorem",
                                "MaileeSurname": "Lorem"
                            }
                        },
                        "MaileeOrganizationIdentification": {
                            "StructuredMaileeOrganizationIdentification": {
                                "MaileeOrganizationFunction": "Lorem",
                                "MaileeOrganizationOrganizationalUnit": "Lorem",
                                "MaileeOrganizationOrganizationalName": "Lorem",
                                "MaileeOrganizationLegalStatus": "Lorem"
                            }
                        },
                        "MailRecipientDispatchingInformation": {
                            "StructuredMailRecipientDispatchingInformation": {
                                "Wing": {
                                    "WingType": "Lorem",
                                    "WingIndicator": "Lorem"
                                },
                                "Stairwell": {
                                    "StairwellType": "Lorem",
                                    "StairwellIndicator": "Lorem"
                                },
                                "Floor": {
                                    "FloorType": "Lorem",
                                    "FloorIndicator": "Lorem"
                                },
                                "Door": {
                                    "DoorType": "Lorem",
                                    "DoorIndicator": "Lorem"
                                },
                                "BuildingConstruction": "Lorem"
                            }
                        }
                    },
                    "PostalAddress": {
                        "OtherDeliveryInformation": {
                            "StructuredOtherDeliveryInformation": {
                                "DeliveryServiceType": "Lorem",
                                "DeliveryServiceIndicator": "Lorem"
                            }
                        },
                        "DeliveryPointLocation": {
                            "StructuredDeliveryPointLocation": {
                                "StreetName": "Rue Edouard dekoster",
                                "StreetNumber": "64",
                                "BoxNumber": "84"
                            }
                        },
                        "PostalCodeMunicipality": {
                            "StructuredPostalCodeMunicipality": {
                                "PostalCode": "1140",
                                "MunicipalityName": "Bruxelles",
                                "DeliveryServiceQualifier": "Lorem"
                            }
                        },
                        "CountryName": "Belgique"
                    },
                    "DispatchingCountryISOCode": "BE",
                    "DeliveringCountryISOCode": "BE"
                }
            ]
        },
        "ValidateAddressOptions": {
            "IncludeFormatting": true,
            "IncludeSuggestions": true,
            "IncludeSubmittedAddress": true,
            "IncludeDefaultGeoLocation": true,
            "IncludeListOfBoxes": true,
            "IncludeNumberOfBoxes": true
        },
        "CallerIdentification": {
            "CallerName": "ZALANDO"
        }
    }
}
2.2 Document Response
2.2.1 Response Tree Diagram
XXXX
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
GeneralError
type
{ABC}
TransactionID
type
{ABC}
[0]*
type
[...]
Line
type
{...}
FormattedSubmittedAddress
type
{ABC}
DetectedInputAddressLanguage
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{ABC}
ComponentRef
type
{...}
[0]*
type
[...]
Error
type
{ABC}
[0]*
type
[...]
Line
type
{...}
Label
type
{ABC}
UnitOfDimension
type
{ABC}
Quantity
type
{...}
Elevation
type
{ABC}
CoordinateType
type
{ABC}
Value
type
{...}
Longitude
type
{ABC}
CoordinateType
type
{ABC}
Value
type
{...}
Latitude
type
{...}
GeographicalLocation
type
{...}
GeographicalLocationInfo
type
{...}
ServicePointDetail
type
{ABC}
PostalCode
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{...}
[0]*
type
[...]
ServicePointBoxResult
type
{...}
ServicePointBoxList
type
{123}
NumberOfBoxes
type
{123}
score
type
{ABC}
AddressLanguage
type
{ABC}
CountryName
type
{ABC}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{...}
PostalAddress
type
{...}
[0]*
type
[...]
ValidatedAddress
type
{...}
ValidatedAddressList
type
{ABC}
UnstructuredMailRecipientDispatchingInformation
type
{Sub}
[1]
type
{ABC}
BuildingConstruction
type
{ABC}
DoorIndicator
type
{ABC}
DoorType
type
{...}
Door
type
{ABC}
FloorIndicator
type
{ABC}
FloorType
type
{...}
Floor
type
{ABC}
StairwellIndicator
type
{ABC}
StairwellType
type
{...}
Stairwell
type
{ABC}
WingIndicator
type
{ABC}
WingType
type
{...}
Wing
type
{...}
StructuredMailRecipientDispatchingInformation
type
{Sub}
[0]
type
{...}
MailRecipientDispatchingInformation
type
{ABC}
UnstructuredMaileeOrganizationIdentification
type
{Sub}
[1]
type
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{Sub}
[0]
type
{...}
MaileeOrganizationIdentification
type
{ABC}
UnstructuredMaileeIndividualIdentification
type
{Sub}
[1]
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{Sub}
[0]
type
{...}
MaileeIndividualIdentification
type
{ABC}
UnstructuredAddresseeIndividualIdentification
type
{Sub}
[1]
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{Sub}
[0]
type
{...}
AddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{ABC}
@id
type
{...}
[0]*
type
[...]
ValidatedAddressResult
type
{...}
ValidatedAddressResultList
type
{...}
ValidateAddressesResponse
type
Response
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
GeneralError
type
{ABC}
TransactionID
type
{ABC}
[0]*
type
[...]
Line
type
{...}
FormattedSubmittedAddress
type
{ABC}
DetectedInputAddressLanguage
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{ABC}
ComponentRef
type
{...}
[0]*
type
[...]
Error
type
{ABC}
[0]*
type
[...]
Line
type
{...}
Label
type
{ABC}
UnitOfDimension
type
{ABC}
Quantity
type
{...}
Elevation
type
{ABC}
CoordinateType
type
{ABC}
Value
type
{...}
Longitude
type
{ABC}
CoordinateType
type
{ABC}
Value
type
{...}
Latitude
type
{...}
GeographicalLocation
type
{...}
GeographicalLocationInfo
type
{...}
ServicePointDetail
type
{ABC}
PostalCode
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{...}
[0]*
type
[...]
ServicePointBoxResult
type
{...}
ServicePointBoxList
type
{123}
NumberOfBoxes
type
{123}
score
type
{ABC}
AddressLanguage
type
{ABC}
CountryName
type
{ABC}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{...}
PostalAddress
type
{...}
[0]*
type
[...]
ValidatedAddress
type
{...}
ValidatedAddressList
type
{ABC}
UnstructuredMailRecipientDispatchingInformation
type
{Sub}
[1]
type
{ABC}
BuildingConstruction
type
{ABC}
DoorIndicator
type
{ABC}
DoorType
type
{...}
Door
type
{ABC}
FloorIndicator
type
{ABC}
FloorType
type
{...}
Floor
type
{ABC}
StairwellIndicator
type
{ABC}
StairwellType
type
{...}
Stairwell
type
{ABC}
WingIndicator
type
{ABC}
WingType
type
{...}
Wing
type
{...}
StructuredMailRecipientDispatchingInformation
type
{Sub}
[0]
type
{...}
MailRecipientDispatchingInformation
type
{ABC}
UnstructuredMaileeOrganizationIdentification
type
{Sub}
[1]
type
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{Sub}
[0]
type
{...}
MaileeOrganizationIdentification
type
{ABC}
UnstructuredMaileeIndividualIdentification
type
{Sub}
[1]
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{Sub}
[0]
type
{...}
MaileeIndividualIdentification
type
{ABC}
UnstructuredAddresseeIndividualIdentification
type
{Sub}
[1]
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{Sub}
[0]
type
{...}
AddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{ABC}
@id
type
{...}
[0]*
type
[...]
ValidatedAddressResult
type
{...}
ValidatedAddressResultList
type
{...}
ValidateAddressesResponse
type
Response
type
2.2.2 Response Properties
PropertyValue
Document name Response
Id
Description Response schema specification for bpost Address Validation webservice
RESTful API true
Transaction Response
Method
EndPoint
Resources
Media type application/JSON
Additional properties true
Comments
2.2.3 Response Fields
FieldTypeReqKeyDescription
ValidateAddressesResponsedocumenttrue
ValidatedAddressResultListdocumenttrue
ValidatedAddressResultarraytrue
[0]documentfalse
@idstringtrue
MaileeAndAddresseedocumentfalse
AddresseeIndividualIdentificationdocumentfalse
oneOfchoicefalse
subschemasubschemafalse
StructuredAddresseeIndividualIdentificationdocumenttrue
AddresseeFormOfAddressstringfalse
AddresseeGivenNamestringfalse
AddresseeSurnamestringfalse
AddresseeSupplementaryDispatchInfostringfalse
subschemasubschemafalse
UnstructuredAddresseeIndividualIdentificationstringtrue
MaileeIndividualIdentificationdocumentfalse
oneOfchoicefalse
subschemasubschemafalse
StructuredMaileeIndividualIdentificationdocumenttrue
MaileeRolestringfalse
MaileeFormOfAddressstringfalse
MaileeGivenNamestringfalse
MaileeSurnamestringfalse
subschemasubschemafalse
UnstructuredMaileeIndividualIdentificationstringtrue
MaileeOrganizationIdentificationdocumentfalse
oneOfchoicefalse
subschemasubschemafalse
StructuredMaileeOrganizationIdentificationdocumenttrue
MaileeOrganizationFunctionstringfalse
MaileeOrganizationOrganizationalUnitstringfalse
MaileeOrganizationOrganizationalNamestringfalse
MaileeOrganizationLegalStatusstringfalse
subschemasubschemafalse
UnstructuredMaileeOrganizationIdentificationstringtrue
MailRecipientDispatchingInformationdocumentfalse
oneOfchoicefalse
subschemasubschemafalse
StructuredMailRecipientDispatchingInformationdocumenttrue
Wingdocumentfalse
WingTypestringfalse
WingIndicatorstringfalse
Stairwelldocumentfalse
StairwellTypestringfalse
StairwellIndicatorstringfalse
Floordocumentfalse
FloorTypestringfalse
FloorIndicatorstringfalse
Doordocumentfalse
DoorTypestringfalse
DoorIndicatorstringfalse
BuildingConstructionstringfalse
subschemasubschemafalse
UnstructuredMailRecipientDispatchingInformationstringtrue
ValidatedAddressListdocumentfalse
ValidatedAddressarraytrue
[0]documentfalse
PostalAddressdocumentfalse
StructuredDeliveryPointLocationdocumenttrue
StreetNamestringtrue
StreetNumberstringtrue
BoxNumberstringtrue
StructuredPostalCodeMunicipalitydocumenttrue
PostalCodestringtrue
MunicipalityNamestringtrue
CountryNamestringtrue
AddressLanguagestringfalse
scoreintegerfalse
NumberOfBoxesintegerfalse
ServicePointBoxListdocumentfalse
ServicePointBoxResultarrayfalse
[0]documentfalse
StreetNumberstringfalse
BoxNumberstringfalse
DeliveryServiceIndicatorstringfalse
PostalCodestringfalse
ServicePointDetaildocumentfalse
GeographicalLocationInfodocumentfalse
GeographicalLocationdocumentfalse
Latitudedocumentfalse
Valuestringfalse
CoordinateTypestringfalse
Longitudedocumentfalse
Valuestringfalse
CoordinateTypestringfalse
Elevationdocumentfalse
Quantitystringfalse
UnitOfDimensionstringfalse
Labeldocumentfalse
Linearrayfalse
[0]stringfalse
Errorarrayfalse
[0]documentfalse
ComponentRefstringtrue
ErrorCodestringtrue
ErrorSeveritystringtrue
DetectedInputAddressLanguagestringfalse
FormattedSubmittedAddressdocumentfalse
Linearraytrue
[0]stringfalse
TransactionIDstringfalse
GeneralErrordocumentfalse
ErrorCodestringtrue
ErrorSeveritystringtrue
2.2.3.1 Field ValidateAddressesResponse
2.2.3.1.1 ValidateAddressesResponse Tree Diagram
{...}
GeneralError
type
{...}
ValidatedAddressResultList
type
ValidateAddressesResponse
type
{...}
GeneralError
type
{...}
ValidatedAddressResultList
type
ValidateAddressesResponse
type
2.2.3.1.2 ValidateAddressesResponse Hierarchy
Parent field: Response
Child field(s):
FieldTypeReqKeyDescription
ValidatedAddressResultListdocumenttrue
GeneralErrordocumentfalse
ValidateAddressesResponse properties
PropertyValue
Name ValidateAddressesResponse
Id
Type document
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.2 Field ValidatedAddressResultList
2.2.3.2.1 ValidatedAddressResultList Tree Diagram
[...]
ValidatedAddressResult
type
ValidatedAddressResultList
type
[...]
ValidatedAddressResult
type
ValidatedAddressResultList
type
2.2.3.2.2 ValidatedAddressResultList Hierarchy
Parent field: ValidateAddressesResponse
Child field(s):
FieldTypeReqKeyDescription
ValidatedAddressResultarraytrue
ValidatedAddressResultList properties
PropertyValue
Name ValidatedAddressResultList
Id
Type document
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.3 Field ValidatedAddressResult
2.2.3.3.1 ValidatedAddressResult Tree Diagram
{...}
[0]*
type
[...]
ValidatedAddressResult
type
{...}
[0]*
type
[...]
ValidatedAddressResult
type
2.2.3.3.2 ValidatedAddressResult Hierarchy
Parent field: ValidatedAddressResultList
Child field(s):
FieldTypeReqKeyDescription
[0]documentfalse
ValidatedAddressResult properties
PropertyValue
Name ValidatedAddressResult
Id
Type array
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min items 1
Max items 200
Unique items
Additional items true
Comments
2.2.3.4 Field [0]
2.2.3.4.1 [0] Tree Diagram
{ABC}
TransactionID
type
{...}
FormattedSubmittedAddress
type
{ABC}
DetectedInputAddressLanguage
type
[...]
Error
type
{...}
ValidatedAddressList
type
{...}
MaileeAndAddressee
type
{ABC}
@id
type
[0]
type
{ABC}
TransactionID
type
{...}
FormattedSubmittedAddress
type
{ABC}
DetectedInputAddressLanguage
type
[...]
Error
type
{...}
ValidatedAddressList
type
{...}
MaileeAndAddressee
type
{ABC}
@id
type
[0]
type
2.2.3.4.2 [0] Hierarchy
Parent field: ValidatedAddressResult
Child field(s):
FieldTypeReqKeyDescription
@idstringtruefk
MaileeAndAddresseedocumentfalse
ValidatedAddressListdocumentfalse
Errorarrayfalse
DetectedInputAddressLanguagestringfalseAddress language that is detected by the system based on the given address as input. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’.
FormattedSubmittedAddressdocumentfalse
TransactionIDstringfalseID which identifies the address validation. Together with the ValidationRequestID, this id defines an address validation uniquely. Used for feedback and acces logging purposes.
[0] properties
PropertyValue
Name
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.5 Field @id
2.2.3.5.1 @id Tree Diagram
{ABC}
@id
type
{ABC}
@id
type
@id properties
PropertyValue
Name @id
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document Request
Foreign field @id
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample 1
Comments
2.2.3.6 Field MaileeAndAddressee
2.2.3.6.1 MaileeAndAddressee Tree Diagram
{...}
MailRecipientDispatchingInformation
type
{...}
MaileeOrganizationIdentification
type
{...}
MaileeIndividualIdentification
type
{...}
AddresseeIndividualIdentification
type
MaileeAndAddressee
type
{...}
MailRecipientDispatchingInformation
type
{...}
MaileeOrganizationIdentification
type
{...}
MaileeIndividualIdentification
type
{...}
AddresseeIndividualIdentification
type
MaileeAndAddressee
type
2.2.3.6.2 MaileeAndAddressee Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
AddresseeIndividualIdentificationdocumentfalse
MaileeIndividualIdentificationdocumentfalse
MaileeOrganizationIdentificationdocumentfalse
MailRecipientDispatchingInformationdocumentfalse
MaileeAndAddressee properties
PropertyValue
Name MaileeAndAddressee
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.7 Field AddresseeIndividualIdentification
2.2.3.7.1 AddresseeIndividualIdentification Tree Diagram
X
AddresseeIndividualIdentification
type
AddresseeIndividualIdentification
type
2.2.3.7.2 AddresseeIndividualIdentification Hierarchy
Parent field: MaileeAndAddressee
Child field(s):
FieldTypeReqKeyDescription
oneOfchoicefalse
AddresseeIndividualIdentification properties
PropertyValue
Name AddresseeIndividualIdentification
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.8 Field oneOf
2.2.3.8.1 oneOf Tree Diagram
X
{Sub}
[1]
type
{Sub}
[0]
type
{Sub}
[1]
type
{Sub}
[0]
type
2.2.3.8.2 oneOf Hierarchy
Parent field: AddresseeIndividualIdentification
Child field(s):
FieldTypeReqKeyDescription
subschemasubschemafalse
subschemasubschemafalse
oneOf properties
PropertyValue
Choice oneOf
2.2.3.9 Field subschema
2.2.3.9.1 subschema Tree Diagram
{...}
StructuredAddresseeIndividualIdentification
type
{Sub}
[subschema]
type
{...}
StructuredAddresseeIndividualIdentification
type
{Sub}
[subschema]
type
2.2.3.9.2 subschema Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredAddresseeIndividualIdentificationdocumenttrue
subschema properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.2.3.10 Field StructuredAddresseeIndividualIdentification
2.2.3.10.1 StructuredAddresseeIndividualIdentification Tree Diagram
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
StructuredAddresseeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
StructuredAddresseeIndividualIdentification
type
2.2.3.10.2 StructuredAddresseeIndividualIdentification Hierarchy
Parent field: subschema
Child field(s):
FieldTypeReqKeyDescription
AddresseeFormOfAddressstringfalse
AddresseeGivenNamestringfalse
AddresseeSurnamestringfalse
AddresseeSupplementaryDispatchInfostringfalse
StructuredAddresseeIndividualIdentification properties
PropertyValue
Name StructuredAddresseeIndividualIdentification
Id
Type document
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.11 Field AddresseeFormOfAddress
2.2.3.11.1 AddresseeFormOfAddress Tree Diagram
{ABC}
AddresseeFormOfAddress
type
{ABC}
AddresseeFormOfAddress
type
AddresseeFormOfAddress properties
PropertyValue
Name AddresseeFormOfAddress
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample Mr
Comments
2.2.3.12 Field AddresseeGivenName
2.2.3.12.1 AddresseeGivenName Tree Diagram
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeGivenName
type
AddresseeGivenName properties
PropertyValue
Name AddresseeGivenName
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample Jacques
Comments
2.2.3.13 Field AddresseeSurname
2.2.3.13.1 AddresseeSurname Tree Diagram
{ABC}
AddresseeSurname
type
{ABC}
AddresseeSurname
type
AddresseeSurname properties
PropertyValue
Name AddresseeSurname
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample Martin
Comments
2.2.3.14 Field AddresseeSupplementaryDispatchInfo
2.2.3.14.1 AddresseeSupplementaryDispatchInfo Tree Diagram
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
AddresseeSupplementaryDispatchInfo properties
PropertyValue
Name AddresseeSupplementaryDispatchInfo
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.15 Field subschema
2.2.3.15.1 subschema Tree Diagram
{ABC}
UnstructuredAddresseeIndividualIdentification
type
{Sub}
[subschema]
type
{ABC}
UnstructuredAddresseeIndividualIdentification
type
{Sub}
[subschema]
type
2.2.3.15.2 subschema Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
UnstructuredAddresseeIndividualIdentificationstringtrue
subschema properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.2.3.16 Field UnstructuredAddresseeIndividualIdentification
2.2.3.16.1 UnstructuredAddresseeIndividualIdentification Tree Diagram
{ABC}
UnstructuredAddresseeIndividualIdentification
type
{ABC}
UnstructuredAddresseeIndividualIdentification
type
UnstructuredAddresseeIndividualIdentification properties
PropertyValue
Name UnstructuredAddresseeIndividualIdentification
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.17 Field MaileeIndividualIdentification
2.2.3.17.1 MaileeIndividualIdentification Tree Diagram
X
MaileeIndividualIdentification
type
MaileeIndividualIdentification
type
2.2.3.17.2 MaileeIndividualIdentification Hierarchy
Parent field: MaileeAndAddressee
Child field(s):
FieldTypeReqKeyDescription
oneOfchoicefalse
MaileeIndividualIdentification properties
PropertyValue
Name MaileeIndividualIdentification
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.18 Field oneOf
2.2.3.18.1 oneOf Tree Diagram
X
{Sub}
[1]
type
{Sub}
[0]
type
{Sub}
[1]
type
{Sub}
[0]
type
2.2.3.18.2 oneOf Hierarchy
Parent field: MaileeIndividualIdentification
Child field(s):
FieldTypeReqKeyDescription
subschemasubschemafalse
subschemasubschemafalse
oneOf properties
PropertyValue
Choice oneOf
2.2.3.19 Field subschema
2.2.3.19.1 subschema Tree Diagram
{...}
StructuredMaileeIndividualIdentification
type
{Sub}
[subschema]
type
{...}
StructuredMaileeIndividualIdentification
type
{Sub}
[subschema]
type
2.2.3.19.2 subschema Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredMaileeIndividualIdentificationdocumenttrue
subschema properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.2.3.20 Field StructuredMaileeIndividualIdentification
2.2.3.20.1 StructuredMaileeIndividualIdentification Tree Diagram
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
StructuredMaileeIndividualIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
StructuredMaileeIndividualIdentification
type
2.2.3.20.2 StructuredMaileeIndividualIdentification Hierarchy
Parent field: subschema
Child field(s):
FieldTypeReqKeyDescription
MaileeRolestringfalse
MaileeFormOfAddressstringfalse
MaileeGivenNamestringfalse
MaileeSurnamestringfalse
StructuredMaileeIndividualIdentification properties
PropertyValue
Name StructuredMaileeIndividualIdentification
Id
Type document
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.21 Field MaileeRole
2.2.3.21.1 MaileeRole Tree Diagram
{ABC}
MaileeRole
type
{ABC}
MaileeRole
type
MaileeRole properties
PropertyValue
Name MaileeRole
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.22 Field MaileeFormOfAddress
2.2.3.22.1 MaileeFormOfAddress Tree Diagram
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeFormOfAddress
type
MaileeFormOfAddress properties
PropertyValue
Name MaileeFormOfAddress
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.23 Field MaileeGivenName
2.2.3.23.1 MaileeGivenName Tree Diagram
{ABC}
MaileeGivenName
type
{ABC}
MaileeGivenName
type
MaileeGivenName properties
PropertyValue
Name MaileeGivenName
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.24 Field MaileeSurname
2.2.3.24.1 MaileeSurname Tree Diagram
{ABC}
MaileeSurname
type
{ABC}
MaileeSurname
type
MaileeSurname properties
PropertyValue
Name MaileeSurname
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.25 Field subschema
2.2.3.25.1 subschema Tree Diagram
{ABC}
UnstructuredMaileeIndividualIdentification
type
{Sub}
[subschema]
type
{ABC}
UnstructuredMaileeIndividualIdentification
type
{Sub}
[subschema]
type
2.2.3.25.2 subschema Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
UnstructuredMaileeIndividualIdentificationstringtrue
subschema properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.2.3.26 Field UnstructuredMaileeIndividualIdentification
2.2.3.26.1 UnstructuredMaileeIndividualIdentification Tree Diagram
{ABC}
UnstructuredMaileeIndividualIdentification
type
{ABC}
UnstructuredMaileeIndividualIdentification
type
UnstructuredMaileeIndividualIdentification properties
PropertyValue
Name UnstructuredMaileeIndividualIdentification
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.27 Field MaileeOrganizationIdentification
2.2.3.27.1 MaileeOrganizationIdentification Tree Diagram
X
MaileeOrganizationIdentification
type
MaileeOrganizationIdentification
type
2.2.3.27.2 MaileeOrganizationIdentification Hierarchy
Parent field: MaileeAndAddressee
Child field(s):
FieldTypeReqKeyDescription
oneOfchoicefalse
MaileeOrganizationIdentification properties
PropertyValue
Name MaileeOrganizationIdentification
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.28 Field oneOf
2.2.3.28.1 oneOf Tree Diagram
X
{Sub}
[1]
type
{Sub}
[0]
type
{Sub}
[1]
type
{Sub}
[0]
type
2.2.3.28.2 oneOf Hierarchy
Parent field: MaileeOrganizationIdentification
Child field(s):
FieldTypeReqKeyDescription
subschemasubschemafalse
subschemasubschemafalse
oneOf properties
PropertyValue
Choice oneOf
2.2.3.29 Field subschema
2.2.3.29.1 subschema Tree Diagram
{...}
StructuredMaileeOrganizationIdentification
type
{Sub}
[subschema]
type
{...}
StructuredMaileeOrganizationIdentification
type
{Sub}
[subschema]
type
2.2.3.29.2 subschema Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredMaileeOrganizationIdentificationdocumenttrue
subschema properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.2.3.30 Field StructuredMaileeOrganizationIdentification
2.2.3.30.1 StructuredMaileeOrganizationIdentification Tree Diagram
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
StructuredMaileeOrganizationIdentification
type
2.2.3.30.2 StructuredMaileeOrganizationIdentification Hierarchy
Parent field: subschema
Child field(s):
FieldTypeReqKeyDescription
MaileeOrganizationFunctionstringfalse
MaileeOrganizationOrganizationalUnitstringfalse
MaileeOrganizationOrganizationalNamestringfalse
MaileeOrganizationLegalStatusstringfalse
StructuredMaileeOrganizationIdentification properties
PropertyValue
Name StructuredMaileeOrganizationIdentification
Id
Type document
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.31 Field MaileeOrganizationFunction
2.2.3.31.1 MaileeOrganizationFunction Tree Diagram
{ABC}
MaileeOrganizationFunction
type
{ABC}
MaileeOrganizationFunction
type
MaileeOrganizationFunction properties
PropertyValue
Name MaileeOrganizationFunction
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.32 Field MaileeOrganizationOrganizationalUnit
2.2.3.32.1 MaileeOrganizationOrganizationalUnit Tree Diagram
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
MaileeOrganizationOrganizationalUnit properties
PropertyValue
Name MaileeOrganizationOrganizationalUnit
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.33 Field MaileeOrganizationOrganizationalName
2.2.3.33.1 MaileeOrganizationOrganizationalName Tree Diagram
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalName
type
MaileeOrganizationOrganizationalName properties
PropertyValue
Name MaileeOrganizationOrganizationalName
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.34 Field MaileeOrganizationLegalStatus
2.2.3.34.1 MaileeOrganizationLegalStatus Tree Diagram
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationLegalStatus
type
MaileeOrganizationLegalStatus properties
PropertyValue
Name MaileeOrganizationLegalStatus
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.35 Field subschema
2.2.3.35.1 subschema Tree Diagram
{ABC}
UnstructuredMaileeOrganizationIdentification
type
{Sub}
[subschema]
type
{ABC}
UnstructuredMaileeOrganizationIdentification
type
{Sub}
[subschema]
type
2.2.3.35.2 subschema Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
UnstructuredMaileeOrganizationIdentificationstringtrue
subschema properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.2.3.36 Field UnstructuredMaileeOrganizationIdentification
2.2.3.36.1 UnstructuredMaileeOrganizationIdentification Tree Diagram
{ABC}
UnstructuredMaileeOrganizationIdentification
type
{ABC}
UnstructuredMaileeOrganizationIdentification
type
UnstructuredMaileeOrganizationIdentification properties
PropertyValue
Name UnstructuredMaileeOrganizationIdentification
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.37 Field MailRecipientDispatchingInformation
2.2.3.37.1 MailRecipientDispatchingInformation Tree Diagram
X
MailRecipientDispatchingInformation
type
MailRecipientDispatchingInformation
type
2.2.3.37.2 MailRecipientDispatchingInformation Hierarchy
Parent field: MaileeAndAddressee
Child field(s):
FieldTypeReqKeyDescription
oneOfchoicefalse
MailRecipientDispatchingInformation properties
PropertyValue
Name MailRecipientDispatchingInformation
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.38 Field oneOf
2.2.3.38.1 oneOf Tree Diagram
X
{Sub}
[1]
type
{Sub}
[0]
type
{Sub}
[1]
type
{Sub}
[0]
type
2.2.3.38.2 oneOf Hierarchy
Parent field: MailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
subschemasubschemafalse
subschemasubschemafalse
oneOf properties
PropertyValue
Choice oneOf
2.2.3.39 Field subschema
2.2.3.39.1 subschema Tree Diagram
{...}
StructuredMailRecipientDispatchingInformation
type
{Sub}
[subschema]
type
{...}
StructuredMailRecipientDispatchingInformation
type
{Sub}
[subschema]
type
2.2.3.39.2 subschema Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredMailRecipientDispatchingInformationdocumenttrue
subschema properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.2.3.40 Field StructuredMailRecipientDispatchingInformation
2.2.3.40.1 StructuredMailRecipientDispatchingInformation Tree Diagram
{ABC}
BuildingConstruction
type
{...}
Door
type
{...}
Floor
type
{...}
Stairwell
type
{...}
Wing
type
StructuredMailRecipientDispatchingInformation
type
{ABC}
BuildingConstruction
type
{...}
Door
type
{...}
Floor
type
{...}
Stairwell
type
{...}
Wing
type
StructuredMailRecipientDispatchingInformation
type
2.2.3.40.2 StructuredMailRecipientDispatchingInformation Hierarchy
Parent field: subschema
Child field(s):
FieldTypeReqKeyDescription
WingdocumentfalseElement identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed.
StairwelldocumentfalseElement indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west.
FloordocumentfalseElement indicating the floor or level on which a delivery point is located in a multi-story construction.
DoordocumentfalseAddress Element indicating the apartment, room or office in, at or adjacent to which a delivery point which is situated within a building is located.
BuildingConstructionstringfalseS42 name: Building/Construction Level 1, code: 30.26.1.0.0, Element identifying the "number" or "name and type" of the building, unit or construction in or adjacent to which a delivery point is located. E.g. Batiment A, Block 7, Houseboat, London Tower, ...
StructuredMailRecipientDispatchingInformation properties
PropertyValue
Name StructuredMailRecipientDispatchingInformation
Id
Type document
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.41 Field Wing
2.2.3.41.1 Wing Tree Diagram
{ABC}
WingIndicator
type
{ABC}
WingType
type
Wing
type
{ABC}
WingIndicator
type
{ABC}
WingType
type
Wing
type
2.2.3.41.2 Wing Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
WingTypestringfalseS42 name: Wing Type, code: 30.29.0.0.1
WingIndicatorstringfalseS42 name: Wing Indicator, code: 30.29.0.0.2
Wing properties
PropertyValue
Name Wing
Id
Type document
Description Element identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.42 Field WingType
2.2.3.42.1 WingType Tree Diagram
{ABC}
WingType
type
{ABC}
WingType
type
WingType properties
PropertyValue
Name WingType
Id
Type string
Description S42 name: Wing Type, code: 30.29.0.0.1
Dependencies 8e917890-df1e-11e6-a3dd-6de9a4b3cd36
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.43 Field WingIndicator
2.2.3.43.1 WingIndicator Tree Diagram
{ABC}
WingIndicator
type
{ABC}
WingIndicator
type
WingIndicator properties
PropertyValue
Name WingIndicator
Id
Type string
Description S42 name: Wing Indicator, code: 30.29.0.0.2
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.44 Field Stairwell
2.2.3.44.1 Stairwell Tree Diagram
{ABC}
StairwellIndicator
type
{ABC}
StairwellType
type
Stairwell
type
{ABC}
StairwellIndicator
type
{ABC}
StairwellType
type
Stairwell
type
2.2.3.44.2 Stairwell Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
StairwellTypestringfalseS42 name: Stairwell Type, code: 30.30.0.0.1
StairwellIndicatorstringfalseS42 name: Stairwell Indicator, code: 30.30.0.0.2
Stairwell properties
PropertyValue
Name Stairwell
Id
Type document
Description Element indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.45 Field StairwellType
2.2.3.45.1 StairwellType Tree Diagram
{ABC}
StairwellType
type
{ABC}
StairwellType
type
StairwellType properties
PropertyValue
Name StairwellType
Id
Type string
Description S42 name: Stairwell Type, code: 30.30.0.0.1
Dependencies ce18e610-df1e-11e6-a3dd-6de9a4b3cd36
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.46 Field StairwellIndicator
2.2.3.46.1 StairwellIndicator Tree Diagram
{ABC}
StairwellIndicator
type
{ABC}
StairwellIndicator
type
StairwellIndicator properties
PropertyValue
Name StairwellIndicator
Id
Type string
Description S42 name: Stairwell Indicator, code: 30.30.0.0.2
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.47 Field Floor
2.2.3.47.1 Floor Tree Diagram
{ABC}
FloorIndicator
type
{ABC}
FloorType
type
Floor
type
{ABC}
FloorIndicator
type
{ABC}
FloorType
type
Floor
type
2.2.3.47.2 Floor Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
FloorTypestringfalseS42 name: Floor Type, code: 30.31.0.0.1
FloorIndicatorstringfalseS42 name: Floor Indicator, code: 30.31.0.0.2
Floor properties
PropertyValue
Name Floor
Id
Type document
Description Element indicating the floor or level on which a delivery point is located in a multi-story construction.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.48 Field FloorType
2.2.3.48.1 FloorType Tree Diagram
{ABC}
FloorType
type
{ABC}
FloorType
type
FloorType properties
PropertyValue
Name FloorType
Id
Type string
Description S42 name: Floor Type, code: 30.31.0.0.1
Dependencies 16c83aa0-df1f-11e6-a3dd-6de9a4b3cd36
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.49 Field FloorIndicator
2.2.3.49.1 FloorIndicator Tree Diagram
{ABC}
FloorIndicator
type
{ABC}
FloorIndicator
type
FloorIndicator properties
PropertyValue
Name FloorIndicator
Id
Type string
Description S42 name: Floor Indicator, code: 30.31.0.0.2
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.50 Field Door
2.2.3.50.1 Door Tree Diagram
{ABC}
DoorIndicator
type
{ABC}
DoorType
type
Door
type
{ABC}
DoorIndicator
type
{ABC}
DoorType
type
Door
type
2.2.3.50.2 Door Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
DoorTypestringfalseS42 name: Door Type, code: 30.32.0.0.1
DoorIndicatorstringfalseS42 name: Door Indicator, code: 30.32.0.0.2
Door properties
PropertyValue
Name Door
Id
Type document
Description Address Element indicating the apartment, room or office in, at or adjacent to which a delivery point which is situated within a building is located.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.51 Field DoorType
2.2.3.51.1 DoorType Tree Diagram
{ABC}
DoorType
type
{ABC}
DoorType
type
DoorType properties
PropertyValue
Name DoorType
Id
Type string
Description S42 name: Door Type, code: 30.32.0.0.1
Dependencies 4e715810-df1f-11e6-a3dd-6de9a4b3cd36
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.52 Field DoorIndicator
2.2.3.52.1 DoorIndicator Tree Diagram
{ABC}
DoorIndicator
type
{ABC}
DoorIndicator
type
DoorIndicator properties
PropertyValue
Name DoorIndicator
Id
Type string
Description S42 name: Door Indicator, code: 30.32.0.0.2
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.53 Field BuildingConstruction
2.2.3.53.1 BuildingConstruction Tree Diagram
{ABC}
BuildingConstruction
type
{ABC}
BuildingConstruction
type
BuildingConstruction properties
PropertyValue
Name BuildingConstruction
Id
Type string
Description S42 name: Building/Construction Level 1, code: 30.26.1.0.0, Element identifying the "number" or "name and type" of the building, unit or construction in or adjacent to which a delivery point is located. E.g. Batiment A, Block 7, Houseboat, London Tower, ...
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.54 Field subschema
2.2.3.54.1 subschema Tree Diagram
{ABC}
UnstructuredMailRecipientDispatchingInformation
type
{Sub}
[subschema]
type
{ABC}
UnstructuredMailRecipientDispatchingInformation
type
{Sub}
[subschema]
type
2.2.3.54.2 subschema Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
UnstructuredMailRecipientDispatchingInformationstringtrue
subschema properties
PropertyValue
Id
Description
Required
Min Properties
Max Properties
Additional properties
Comments
2.2.3.55 Field UnstructuredMailRecipientDispatchingInformation
2.2.3.55.1 UnstructuredMailRecipientDispatchingInformation Tree Diagram
{ABC}
UnstructuredMailRecipientDispatchingInformation
type
{ABC}
UnstructuredMailRecipientDispatchingInformation
type
UnstructuredMailRecipientDispatchingInformation properties
PropertyValue
Name UnstructuredMailRecipientDispatchingInformation
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.56 Field ValidatedAddressList
2.2.3.56.1 ValidatedAddressList Tree Diagram
[...]
ValidatedAddress
type
ValidatedAddressList
type
[...]
ValidatedAddress
type
ValidatedAddressList
type
2.2.3.56.2 ValidatedAddressList Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
ValidatedAddressarraytrue
ValidatedAddressList properties
PropertyValue
Name ValidatedAddressList
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.57 Field ValidatedAddress
2.2.3.57.1 ValidatedAddress Tree Diagram
{...}
[0]*
type
[...]
ValidatedAddress
type
{...}
[0]*
type
[...]
ValidatedAddress
type
2.2.3.57.2 ValidatedAddress Hierarchy
Parent field: ValidatedAddressList
Child field(s):
FieldTypeReqKeyDescription
[0]documentfalse
ValidatedAddress properties
PropertyValue
Name ValidatedAddress
Id
Type array
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min items
Max items
Unique items
Additional items true
Comments
2.2.3.58 Field [0]
2.2.3.58.1 [0] Tree Diagram
{...}
Label
type
{...}
ServicePointDetail
type
{...}
ServicePointBoxList
type
{123}
NumberOfBoxes
type
{123}
score
type
{ABC}
AddressLanguage
type
{...}
PostalAddress
type
[0]
type
{...}
Label
type
{...}
ServicePointDetail
type
{...}
ServicePointBoxList
type
{123}
NumberOfBoxes
type
{123}
score
type
{ABC}
AddressLanguage
type
{...}
PostalAddress
type
[0]
type
2.2.3.58.2 [0] Hierarchy
Parent field: ValidatedAddress
Child field(s):
FieldTypeReqKeyDescription
PostalAddressdocumentfalse
AddressLanguagestringfalseS42 name: Address Parameter Language, code: 50.51.0.0.0. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’.
scoreintegerfalse
NumberOfBoxesintegerfalse
ServicePointBoxListdocumentfalse
ServicePointDetaildocumentfalse
Labeldocumentfalse
[0] properties
PropertyValue
Name
Id
Type document
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.59 Field PostalAddress
2.2.3.59.1 PostalAddress Tree Diagram
{ABC}
CountryName
type
{...}
StructuredPostalCodeMunicipality
type
{...}
StructuredDeliveryPointLocation
type
PostalAddress
type
{ABC}
CountryName
type
{...}
StructuredPostalCodeMunicipality
type
{...}
StructuredDeliveryPointLocation
type
PostalAddress
type
2.2.3.59.2 PostalAddress Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredDeliveryPointLocationdocumenttrue
StructuredPostalCodeMunicipalitydocumenttrue
CountryNamestringtrue
PostalAddress properties
PropertyValue
Name PostalAddress
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.60 Field StructuredDeliveryPointLocation
2.2.3.60.1 StructuredDeliveryPointLocation Tree Diagram
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
StreetName
type
StructuredDeliveryPointLocation
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
StreetName
type
StructuredDeliveryPointLocation
type
2.2.3.60.2 StructuredDeliveryPointLocation Hierarchy
Parent field: PostalAddress
Child field(s):
FieldTypeReqKeyDescription
StreetNamestringtrue
StreetNumberstringtrue
BoxNumberstringtrue
StructuredDeliveryPointLocation properties
PropertyValue
Name StructuredDeliveryPointLocation
Id
Type document
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.61 Field StreetName
2.2.3.61.1 StreetName Tree Diagram
{ABC}
StreetName
type
{ABC}
StreetName
type
StreetName properties
PropertyValue
Name StreetName
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample RUE EDOUARD DEKOSTER
Comments
2.2.3.62 Field StreetNumber
2.2.3.62.1 StreetNumber Tree Diagram
{ABC}
StreetNumber
type
{ABC}
StreetNumber
type
StreetNumber properties
PropertyValue
Name StreetNumber
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample 64
Comments
2.2.3.63 Field BoxNumber
2.2.3.63.1 BoxNumber Tree Diagram
{ABC}
BoxNumber
type
{ABC}
BoxNumber
type
BoxNumber properties
PropertyValue
Name BoxNumber
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample 84
Comments
2.2.3.64 Field StructuredPostalCodeMunicipality
2.2.3.64.1 StructuredPostalCodeMunicipality Tree Diagram
{ABC}
MunicipalityName
type
{ABC}
PostalCode
type
StructuredPostalCodeMunicipality
type
{ABC}
MunicipalityName
type
{ABC}
PostalCode
type
StructuredPostalCodeMunicipality
type
2.2.3.64.2 StructuredPostalCodeMunicipality Hierarchy
Parent field: PostalAddress
Child field(s):
FieldTypeReqKeyDescription
PostalCodestringtrue
MunicipalityNamestringtrue
StructuredPostalCodeMunicipality properties
PropertyValue
Name StructuredPostalCodeMunicipality
Id
Type document
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.65 Field PostalCode
2.2.3.65.1 PostalCode Tree Diagram
{ABC}
PostalCode
type
{ABC}
PostalCode
type
PostalCode properties
PropertyValue
Name PostalCode
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample 1140
Comments
2.2.3.66 Field MunicipalityName
2.2.3.66.1 MunicipalityName Tree Diagram
{ABC}
MunicipalityName
type
{ABC}
MunicipalityName
type
MunicipalityName properties
PropertyValue
Name MunicipalityName
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample EVERE
Comments
2.2.3.67 Field CountryName
2.2.3.67.1 CountryName Tree Diagram
{ABC}
CountryName
type
{ABC}
CountryName
type
CountryName properties
PropertyValue
Name CountryName
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample BELGIQUE
Comments
2.2.3.68 Field AddressLanguage
2.2.3.68.1 AddressLanguage Tree Diagram
{ABC}
AddressLanguage
type
{ABC}
AddressLanguage
type
AddressLanguage properties
PropertyValue
Name AddressLanguage
Id
Type string
Description S42 name: Address Parameter Language, code: 50.51.0.0.0. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum de,en,fr,nl
Sample
Comments
2.2.3.69 Field score
2.2.3.69.1 score Tree Diagram
{123}
score
type
{123}
score
type
score properties
PropertyValue
Name score
Id
Type integer
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Unit
Min value
Excl min false
Max value
Excl max false
Multiple of
Enum
Sample
Comments
2.2.3.70 Field NumberOfBoxes
2.2.3.70.1 NumberOfBoxes Tree Diagram
{123}
NumberOfBoxes
type
{123}
NumberOfBoxes
type
NumberOfBoxes properties
PropertyValue
Name NumberOfBoxes
Id
Type integer
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Unit
Min value
Excl min false
Max value
Excl max false
Multiple of
Enum
Sample
Comments
2.2.3.71 Field ServicePointBoxList
2.2.3.71.1 ServicePointBoxList Tree Diagram
[...]
ServicePointBoxResult
type
ServicePointBoxList
type
[...]
ServicePointBoxResult
type
ServicePointBoxList
type
2.2.3.71.2 ServicePointBoxList Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
ServicePointBoxResultarrayfalse
ServicePointBoxList properties
PropertyValue
Name ServicePointBoxList
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.2.3.72 Field ServicePointBoxResult
2.2.3.72.1 ServicePointBoxResult Tree Diagram
{...}
[0]*
type
[...]
ServicePointBoxResult
type
{...}
[0]*
type
[...]
ServicePointBoxResult
type
2.2.3.72.2 ServicePointBoxResult Hierarchy
Parent field: ServicePointBoxList
Child field(s):
FieldTypeReqKeyDescription
[0]documentfalse
ServicePointBoxResult properties
PropertyValue
Name ServicePointBoxResult
Id
Type array
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min items 1
Max items
Unique items false
Additional items true
Comments
2.2.3.73 Field New Field
2.2.3.73.1 New Field Tree Diagram
{ABC}
PostalCode
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
[0]
type
{ABC}
PostalCode
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
[0]
type
2.2.3.73.2 New Field Hierarchy
Parent field: ServicePointBoxResult
Child field(s):
FieldTypeReqKeyDescription
StreetNumberstringfalse
BoxNumberstringfalse
DeliveryServiceIndicatorstringfalse
PostalCodestringfalse
New Field properties
PropertyValue
Name New Field
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.2.3.74 Field StreetNumber
2.2.3.74.1 StreetNumber Tree Diagram
{ABC}
StreetNumber
type
{ABC}
StreetNumber
type
StreetNumber properties
PropertyValue
Name StreetNumber
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.75 Field BoxNumber
2.2.3.75.1 BoxNumber Tree Diagram
{ABC}
BoxNumber
type
{ABC}
BoxNumber
type
BoxNumber properties
PropertyValue
Name BoxNumber
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.76 Field DeliveryServiceIndicator
2.2.3.76.1 DeliveryServiceIndicator Tree Diagram
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceIndicator
type
DeliveryServiceIndicator properties
PropertyValue
Name DeliveryServiceIndicator
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.77 Field PostalCode
2.2.3.77.1 PostalCode Tree Diagram
{ABC}
PostalCode
type
{ABC}
PostalCode
type
PostalCode properties
PropertyValue
Name PostalCode
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.78 Field ServicePointDetail
2.2.3.78.1 ServicePointDetail Tree Diagram
{...}
GeographicalLocationInfo
type
ServicePointDetail
type
{...}
GeographicalLocationInfo
type
ServicePointDetail
type
2.2.3.78.2 ServicePointDetail Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
GeographicalLocationInfodocumentfalse
ServicePointDetail properties
PropertyValue
Name ServicePointDetail
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.2.3.79 Field GeographicalLocationInfo
2.2.3.79.1 GeographicalLocationInfo Tree Diagram
{...}
GeographicalLocation
type
GeographicalLocationInfo
type
{...}
GeographicalLocation
type
GeographicalLocationInfo
type
2.2.3.79.2 GeographicalLocationInfo Hierarchy
Parent field: ServicePointDetail
Child field(s):
FieldTypeReqKeyDescription
GeographicalLocationdocumentfalse
GeographicalLocationInfo properties
PropertyValue
Name GeographicalLocationInfo
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.2.3.80 Field GeographicalLocation
2.2.3.80.1 GeographicalLocation Tree Diagram
{...}
Elevation
type
{...}
Longitude
type
{...}
Latitude
type
GeographicalLocation
type
{...}
Elevation
type
{...}
Longitude
type
{...}
Latitude
type
GeographicalLocation
type
2.2.3.80.2 GeographicalLocation Hierarchy
Parent field: GeographicalLocationInfo
Child field(s):
FieldTypeReqKeyDescription
Latitudedocumentfalse
Longitudedocumentfalse
Elevationdocumentfalse
GeographicalLocation properties
PropertyValue
Name GeographicalLocation
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.2.3.81 Field Latitude
2.2.3.81.1 Latitude Tree Diagram
{ABC}
CoordinateType
type
{ABC}
Value
type
Latitude
type
{ABC}
CoordinateType
type
{ABC}
Value
type
Latitude
type
2.2.3.81.2 Latitude Hierarchy
Parent field: GeographicalLocation
Child field(s):
FieldTypeReqKeyDescription
Valuestringfalse
CoordinateTypestringfalse
Latitude properties
PropertyValue
Name Latitude
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.2.3.82 Field Value
2.2.3.82.1 Value Tree Diagram
{ABC}
Value
type
{ABC}
Value
type
Value properties
PropertyValue
Name Value
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.83 Field CoordinateType
2.2.3.83.1 CoordinateType Tree Diagram
{ABC}
CoordinateType
type
{ABC}
CoordinateType
type
CoordinateType properties
PropertyValue
Name CoordinateType
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.84 Field Longitude
2.2.3.84.1 Longitude Tree Diagram
{ABC}
CoordinateType
type
{ABC}
Value
type
Longitude
type
{ABC}
CoordinateType
type
{ABC}
Value
type
Longitude
type
2.2.3.84.2 Longitude Hierarchy
Parent field: GeographicalLocation
Child field(s):
FieldTypeReqKeyDescription
Valuestringfalse
CoordinateTypestringfalse
Longitude properties
PropertyValue
Name Longitude
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.2.3.85 Field Value
2.2.3.85.1 Value Tree Diagram
{ABC}
Value
type
{ABC}
Value
type
Value properties
PropertyValue
Name Value
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.86 Field CoordinateType
2.2.3.86.1 CoordinateType Tree Diagram
{ABC}
CoordinateType
type
{ABC}
CoordinateType
type
CoordinateType properties
PropertyValue
Name CoordinateType
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.87 Field Elevation
2.2.3.87.1 Elevation Tree Diagram
{ABC}
UnitOfDimension
type
{ABC}
Quantity
type
Elevation
type
{ABC}
UnitOfDimension
type
{ABC}
Quantity
type
Elevation
type
2.2.3.87.2 Elevation Hierarchy
Parent field: GeographicalLocation
Child field(s):
FieldTypeReqKeyDescription
Quantitystringfalse
UnitOfDimensionstringfalse
Elevation properties
PropertyValue
Name Elevation
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.2.3.88 Field Quantity
2.2.3.88.1 Quantity Tree Diagram
{ABC}
Quantity
type
{ABC}
Quantity
type
Quantity properties
PropertyValue
Name Quantity
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.89 Field UnitOfDimension
2.2.3.89.1 UnitOfDimension Tree Diagram
{ABC}
UnitOfDimension
type
{ABC}
UnitOfDimension
type
UnitOfDimension properties
PropertyValue
Name UnitOfDimension
Id
Type string
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.90 Field Label
2.2.3.90.1 Label Tree Diagram
[...]
Line
type
Label
type
[...]
Line
type
Label
type
2.2.3.90.2 Label Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
Linearrayfalse
Label properties
PropertyValue
Name Label
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.91 Field Line
2.2.3.91.1 Line Tree Diagram
{ABC}
[0]*
type
[...]
Line
type
{ABC}
[0]*
type
[...]
Line
type
2.2.3.91.2 Line Hierarchy
Parent field: Label
Child field(s):
FieldTypeReqKeyDescription
[0]stringfalse
Line properties
PropertyValue
Name Line
Id
Type array
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min items 1
Max items 7
Unique items
Additional items true
Comments
2.2.3.92 Field [0]
2.2.3.92.1 [0] Tree Diagram
{ABC}
[0]
type
{ABC}
[0]
type
[0] properties
PropertyValue
Name
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample Mr Jacques Martin Lorem
Comments
2.2.3.93 Field Error
2.2.3.93.1 Error Tree Diagram
{...}
[0]*
type
[...]
Error
type
{...}
[0]*
type
[...]
Error
type
2.2.3.93.2 Error Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
[0]documentfalse
Error properties
PropertyValue
Name Error
Id
Type array
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min items
Max items
Unique items false
Additional items true
Comments
2.2.3.94 Field [0]
2.2.3.94.1 [0] Tree Diagram
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{ABC}
ComponentRef
type
[0]
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{ABC}
ComponentRef
type
[0]
type
2.2.3.94.2 [0] Hierarchy
Parent field: Error
Child field(s):
FieldTypeReqKeyDescription
ComponentRefstringtrue
ErrorCodestringtrue
ErrorSeveritystringtrue
[0] properties
PropertyValue
Name
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.2.3.95 Field ComponentRef
2.2.3.95.1 ComponentRef Tree Diagram
{ABC}
ComponentRef
type
{ABC}
ComponentRef
type
ComponentRef properties
PropertyValue
Name ComponentRef
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.96 Field ErrorCode
2.2.3.96.1 ErrorCode Tree Diagram
{ABC}
ErrorCode
type
{ABC}
ErrorCode
type
ErrorCode properties
PropertyValue
Name ErrorCode
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.97 Field ErrorSeverity
2.2.3.97.1 ErrorSeverity Tree Diagram
{ABC}
ErrorSeverity
type
{ABC}
ErrorSeverity
type
ErrorSeverity properties
PropertyValue
Name ErrorSeverity
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum warning,error
Sample
Comments
2.2.3.98 Field DetectedInputAddressLanguage
2.2.3.98.1 DetectedInputAddressLanguage Tree Diagram
{ABC}
DetectedInputAddressLanguage
type
{ABC}
DetectedInputAddressLanguage
type
DetectedInputAddressLanguage properties
PropertyValue
Name DetectedInputAddressLanguage
Id
Type string
Description Address language that is detected by the system based on the given address as input. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum de,en,fr,nl
Sample fr
Comments
2.2.3.99 Field FormattedSubmittedAddress
2.2.3.99.1 FormattedSubmittedAddress Tree Diagram
[...]
Line
type
FormattedSubmittedAddress
type
[...]
Line
type
FormattedSubmittedAddress
type
2.2.3.99.2 FormattedSubmittedAddress Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
Linearraytrue
FormattedSubmittedAddress properties
PropertyValue
Name FormattedSubmittedAddress
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties
Comments
2.2.3.100 Field Line
2.2.3.100.1 Line Tree Diagram
{ABC}
[0]*
type
[...]
Line
type
{ABC}
[0]*
type
[...]
Line
type
2.2.3.100.2 Line Hierarchy
Parent field: FormattedSubmittedAddress
Child field(s):
FieldTypeReqKeyDescription
[0]stringfalse
Line properties
PropertyValue
Name Line
Id
Type array
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Min items 1
Max items 7
Unique items
Additional items true
Comments
2.2.3.101 Field [0]
2.2.3.101.1 [0] Tree Diagram
{ABC}
[0]
type
{ABC}
[0]
type
[0] properties
PropertyValue
Name
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample Mr Jacques Martin Lorem
Comments
2.2.3.102 Field TransactionID
2.2.3.102.1 TransactionID Tree Diagram
{ABC}
TransactionID
type
{ABC}
TransactionID
type
TransactionID properties
PropertyValue
Name TransactionID
Id
Type string
Description ID which identifies the address validation. Together with the ValidationRequestID, this id defines an address validation uniquely. Used for feedback and acces logging purposes.
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample 50627398-65a2-498d-b159-98e578b00c46
Comments
2.2.3.103 Field GeneralError
2.2.3.103.1 GeneralError Tree Diagram
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
GeneralError
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
GeneralError
type
2.2.3.103.2 GeneralError Hierarchy
Parent field: ValidateAddressesResponse
Child field(s):
FieldTypeReqKeyDescription
ErrorCodestringtrue
ErrorSeveritystringtrue
GeneralError properties
PropertyValue
Name GeneralError
Id
Type document
Description
Dependencies
Required false
Primary key false
Foreign document
Foreign field
Relationship type
Min Properties
Max Properties
Additional properties true
Comments
2.2.3.104 Field ErrorCode
2.2.3.104.1 ErrorCode Tree Diagram
{ABC}
ErrorCode
type
{ABC}
ErrorCode
type
ErrorCode properties
PropertyValue
Name ErrorCode
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.3.105 Field ErrorSeverity
2.2.3.105.1 ErrorSeverity Tree Diagram
{ABC}
ErrorSeverity
type
{ABC}
ErrorSeverity
type
ErrorSeverity properties
PropertyValue
Name ErrorSeverity
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.7 Response Definitions (TBD)
2.2.8 Response JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Response",
    "description": "Response schema specification for bpost Address Validation webservice",
    "additionalProperties": true,
    "isRestfulApi": true,
    "mediaType": "application/JSON",
    "properties": {
        "ValidateAddressesResponse": {
            "properties": {
                "ValidatedAddressResultList": {
                    "properties": {
                        "ValidatedAddressResult": {
                            "primaryKey": false,
                            "additionalItems": true,
                            "maxItems": 200,
                            "minItems": 1,
                            "type": "array",
                            "GUID": "1de8c9e3-df28-11e6-a3dd-6de9a4b3cd36",
                            "items": {
                                "properties": {
                                    "@id": {
                                        "primaryKey": false,
                                        "type": "string",
                                        "GUID": "1de8c9e5-df28-11e6-a3dd-6de9a4b3cd36",
                                        "sample": "1"
                                    },
                                    "MaileeAndAddressee": {
                                        "properties": {
                                            "AddresseeIndividualIdentification": {
                                                "primaryKey": false,
                                                "type": "object",
                                                "GUID": "1de8c9eb-df28-11e6-a3dd-6de9a4b3cd36",
                                                "oneOf": [
                                                    {
                                                        "properties": {
                                                            "StructuredAddresseeIndividualIdentification": {
                                                                "properties": {
                                                                    "AddresseeFormOfAddress": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "f4d3e3b0-e14c-11e6-898f-b7d201a89248",
                                                                        "sample": "Mr"
                                                                    },
                                                                    "AddresseeGivenName": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "f4d3e3b1-e14c-11e6-898f-b7d201a89248",
                                                                        "sample": "Jacques"
                                                                    },
                                                                    "AddresseeSurname": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "f4d3e3b2-e14c-11e6-898f-b7d201a89248",
                                                                        "sample": "Martin"
                                                                    },
                                                                    "AddresseeSupplementaryDispatchInfo": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "f4d3e3b3-e14c-11e6-898f-b7d201a89248"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "f4d3bca0-e14c-11e6-898f-b7d201a89248"
                                                            }
                                                        },
                                                        "type": "object",
                                                        "GUID": "ed53b930-e14c-11e6-898f-b7d201a89248",
                                                        "required": [
                                                            "StructuredAddresseeIndividualIdentification"
                                                        ]
                                                    },
                                                    {
                                                        "properties": {
                                                            "UnstructuredAddresseeIndividualIdentification": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "06623690-e14d-11e6-898f-b7d201a89248"
                                                            }
                                                        },
                                                        "type": "object",
                                                        "GUID": "fae45190-e14c-11e6-898f-b7d201a89248",
                                                        "required": [
                                                            "UnstructuredAddresseeIndividualIdentification"
                                                        ]
                                                    }
                                                ]
                                            },
                                            "MaileeIndividualIdentification": {
                                                "primaryKey": false,
                                                "type": "object",
                                                "GUID": "1de8c9f1-df28-11e6-a3dd-6de9a4b3cd36",
                                                "oneOf": [
                                                    {
                                                        "properties": {
                                                            "StructuredMaileeIndividualIdentification": {
                                                                "properties": {
                                                                    "MaileeRole": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "c7876750-e14d-11e6-898f-b7d201a89248"
                                                                    },
                                                                    "MaileeFormOfAddress": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "c7876751-e14d-11e6-898f-b7d201a89248"
                                                                    },
                                                                    "MaileeGivenName": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "c7876752-e14d-11e6-898f-b7d201a89248"
                                                                    },
                                                                    "MaileeSurname": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "c7876753-e14d-11e6-898f-b7d201a89248"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "c7874040-e14d-11e6-898f-b7d201a89248"
                                                            }
                                                        },
                                                        "type": "object",
                                                        "GUID": "c022db20-e14d-11e6-898f-b7d201a89248",
                                                        "required": [
                                                            "StructuredMaileeIndividualIdentification"
                                                        ]
                                                    },
                                                    {
                                                        "properties": {
                                                            "UnstructuredMaileeIndividualIdentification": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "d125ddf0-e14d-11e6-898f-b7d201a89248"
                                                            }
                                                        },
                                                        "type": "object",
                                                        "GUID": "cb99e250-e14d-11e6-898f-b7d201a89248",
                                                        "required": [
                                                            "UnstructuredMaileeIndividualIdentification"
                                                        ]
                                                    }
                                                ]
                                            },
                                            "MaileeOrganizationIdentification": {
                                                "primaryKey": false,
                                                "type": "object",
                                                "GUID": "1de8c9f7-df28-11e6-a3dd-6de9a4b3cd36",
                                                "oneOf": [
                                                    {
                                                        "properties": {
                                                            "StructuredMaileeOrganizationIdentification": {
                                                                "properties": {
                                                                    "MaileeOrganizationFunction": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "0b7d7991-e14e-11e6-898f-b7d201a89248"
                                                                    },
                                                                    "MaileeOrganizationOrganizationalUnit": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "0b7d7992-e14e-11e6-898f-b7d201a89248"
                                                                    },
                                                                    "MaileeOrganizationOrganizationalName": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "0b7d7993-e14e-11e6-898f-b7d201a89248"
                                                                    },
                                                                    "MaileeOrganizationLegalStatus": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "0b7d7994-e14e-11e6-898f-b7d201a89248"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "0b7d7990-e14e-11e6-898f-b7d201a89248"
                                                            }
                                                        },
                                                        "type": "object",
                                                        "GUID": "05da2560-e14e-11e6-898f-b7d201a89248",
                                                        "required": [
                                                            "StructuredMaileeOrganizationIdentification"
                                                        ]
                                                    },
                                                    {
                                                        "properties": {
                                                            "UnstructuredMaileeOrganizationIdentification": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "122f7ea0-e14e-11e6-898f-b7d201a89248"
                                                            }
                                                        },
                                                        "type": "object",
                                                        "GUID": "0f5387d0-e14e-11e6-898f-b7d201a89248",
                                                        "required": [
                                                            "UnstructuredMaileeOrganizationIdentification"
                                                        ]
                                                    }
                                                ]
                                            },
                                            "MailRecipientDispatchingInformation": {
                                                "primaryKey": false,
                                                "type": "object",
                                                "GUID": "1de8f0f5-df28-11e6-a3dd-6de9a4b3cd36",
                                                "oneOf": [
                                                    {
                                                        "properties": {
                                                            "StructuredMailRecipientDispatchingInformation": {
                                                                "properties": {
                                                                    "Wing": {
                                                                        "description": "Element identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed.",
                                                                        "properties": {
                                                                            "WingType": {
                                                                                "description": "S42 name: Wing Type, code: 30.29.0.0.1",
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "54dd3262-e14e-11e6-898f-b7d201a89248"
                                                                            },
                                                                            "WingIndicator": {
                                                                                "description": "S42 name: Wing Indicator, code: 30.29.0.0.2",
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "54dd3263-e14e-11e6-898f-b7d201a89248"
                                                                            }
                                                                        },
                                                                        "primaryKey": false,
                                                                        "type": "object",
                                                                        "GUID": "54dd3261-e14e-11e6-898f-b7d201a89248",
                                                                        "dependencies": {
                                                                            "WingType": [
                                                                                "WingIndicator"
                                                                            ]
                                                                        }
                                                                    },
                                                                    "Stairwell": {
                                                                        "description": "Element indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west.",
                                                                        "properties": {
                                                                            "StairwellType": {
                                                                                "description": "S42 name: Stairwell Type, code: 30.30.0.0.1",
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "54dd3265-e14e-11e6-898f-b7d201a89248"
                                                                            },
                                                                            "StairwellIndicator": {
                                                                                "description": "S42 name: Stairwell Indicator, code: 30.30.0.0.2",
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "54dd3266-e14e-11e6-898f-b7d201a89248"
                                                                            }
                                                                        },
                                                                        "primaryKey": false,
                                                                        "type": "object",
                                                                        "GUID": "54dd3264-e14e-11e6-898f-b7d201a89248",
                                                                        "dependencies": {
                                                                            "StairwellType": [
                                                                                "StairwellIndicator"
                                                                            ]
                                                                        }
                                                                    },
                                                                    "Floor": {
                                                                        "description": "Element indicating the floor or level on which a delivery point is located in a multi-story construction.",
                                                                        "properties": {
                                                                            "FloorType": {
                                                                                "description": "S42 name: Floor Type, code: 30.31.0.0.1",
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "54dd3268-e14e-11e6-898f-b7d201a89248"
                                                                            },
                                                                            "FloorIndicator": {
                                                                                "description": "S42 name: Floor Indicator, code: 30.31.0.0.2",
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "54dd3269-e14e-11e6-898f-b7d201a89248"
                                                                            }
                                                                        },
                                                                        "primaryKey": false,
                                                                        "type": "object",
                                                                        "GUID": "54dd3267-e14e-11e6-898f-b7d201a89248",
                                                                        "dependencies": {
                                                                            "FloorType": [
                                                                                "FloorIndicator"
                                                                            ]
                                                                        }
                                                                    },
                                                                    "Door": {
                                                                        "description": "Address Element indicating the apartment, room or office in, at or adjacent to which a delivery point which is situated within a building is located.",
                                                                        "properties": {
                                                                            "DoorType": {
                                                                                "description": "S42 name: Door Type, code: 30.32.0.0.1",
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "54dd326b-e14e-11e6-898f-b7d201a89248"
                                                                            },
                                                                            "DoorIndicator": {
                                                                                "description": "S42 name: Door Indicator, code: 30.32.0.0.2",
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "54dd326c-e14e-11e6-898f-b7d201a89248"
                                                                            }
                                                                        },
                                                                        "primaryKey": false,
                                                                        "type": "object",
                                                                        "GUID": "54dd326a-e14e-11e6-898f-b7d201a89248",
                                                                        "dependencies": {
                                                                            "DoorType": [
                                                                                "DoorIndicator"
                                                                            ]
                                                                        }
                                                                    },
                                                                    "BuildingConstruction": {
                                                                        "description": "S42 name: Building/Construction Level 1, code: 30.26.1.0.0, Element identifying the \"number\" or \"name and type\" of the building, unit or construction in or adjacent to which a delivery point is located. E.g. Batiment A, Block 7, Houseboat, London Tower, ...",
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "54dd326d-e14e-11e6-898f-b7d201a89248"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "54dd3260-e14e-11e6-898f-b7d201a89248"
                                                            }
                                                        },
                                                        "type": "object",
                                                        "GUID": "4f1a2130-e14e-11e6-898f-b7d201a89248",
                                                        "required": [
                                                            "StructuredMailRecipientDispatchingInformation"
                                                        ]
                                                    },
                                                    {
                                                        "properties": {
                                                            "UnstructuredMailRecipientDispatchingInformation": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "5b61bed0-e14e-11e6-898f-b7d201a89248"
                                                            }
                                                        },
                                                        "type": "object",
                                                        "GUID": "594e9640-e14e-11e6-898f-b7d201a89248",
                                                        "required": [
                                                            "UnstructuredMailRecipientDispatchingInformation"
                                                        ]
                                                    }
                                                ]
                                            }
                                        },
                                        "primaryKey": false,
                                        "type": "object",
                                        "GUID": "1de8c9ea-df28-11e6-a3dd-6de9a4b3cd36"
                                    },
                                    "ValidatedAddressList": {
                                        "properties": {
                                            "ValidatedAddress": {
                                                "primaryKey": false,
                                                "additionalItems": true,
                                                "type": "array",
                                                "GUID": "1de8f106-df28-11e6-a3dd-6de9a4b3cd36",
                                                "items": {
                                                    "properties": {
                                                        "PostalAddress": {
                                                            "properties": {
                                                                "StructuredDeliveryPointLocation": {
                                                                    "properties": {
                                                                        "StreetName": {
                                                                            "primaryKey": false,
                                                                            "type": "string",
                                                                            "GUID": "1de8f110-df28-11e6-a3dd-6de9a4b3cd36",
                                                                            "sample": "RUE EDOUARD DEKOSTER"
                                                                        },
                                                                        "StreetNumber": {
                                                                            "primaryKey": false,
                                                                            "type": "string",
                                                                            "GUID": "1de8f111-df28-11e6-a3dd-6de9a4b3cd36",
                                                                            "sample": "64"
                                                                        },
                                                                        "BoxNumber": {
                                                                            "primaryKey": false,
                                                                            "type": "string",
                                                                            "GUID": "1de8f10f-df28-11e6-a3dd-6de9a4b3cd36",
                                                                            "sample": "84"
                                                                        }
                                                                    },
                                                                    "primaryKey": false,
                                                                    "type": "object",
                                                                    "GUID": "1de8f10e-df28-11e6-a3dd-6de9a4b3cd36",
                                                                    "required": [
                                                                        "StreetName",
                                                                        "StreetNumber",
                                                                        "BoxNumber"
                                                                    ]
                                                                },
                                                                "StructuredPostalCodeMunicipality": {
                                                                    "properties": {
                                                                        "PostalCode": {
                                                                            "primaryKey": false,
                                                                            "type": "string",
                                                                            "GUID": "1de8f114-df28-11e6-a3dd-6de9a4b3cd36",
                                                                            "sample": "1140"
                                                                        },
                                                                        "MunicipalityName": {
                                                                            "primaryKey": false,
                                                                            "type": "string",
                                                                            "GUID": "1de8f113-df28-11e6-a3dd-6de9a4b3cd36",
                                                                            "sample": "EVERE"
                                                                        }
                                                                    },
                                                                    "primaryKey": false,
                                                                    "type": "object",
                                                                    "GUID": "1de8f112-df28-11e6-a3dd-6de9a4b3cd36",
                                                                    "required": [
                                                                        "PostalCode",
                                                                        "MunicipalityName"
                                                                    ]
                                                                },
                                                                "CountryName": {
                                                                    "primaryKey": false,
                                                                    "type": "string",
                                                                    "GUID": "1de8f10d-df28-11e6-a3dd-6de9a4b3cd36",
                                                                    "sample": "BELGIQUE"
                                                                }
                                                            },
                                                            "primaryKey": false,
                                                            "type": "object",
                                                            "GUID": "1de8f10c-df28-11e6-a3dd-6de9a4b3cd36",
                                                            "required": [
                                                                "StructuredDeliveryPointLocation",
                                                                "StructuredPostalCodeMunicipality",
                                                                "CountryName"
                                                            ]
                                                        },
                                                        "AddressLanguage": {
                                                            "description": "S42 name: Address Parameter Language, code: 50.51.0.0.0. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’.",
                                                            "primaryKey": false,
                                                            "type": "string",
                                                            "GUID": "e401b810-e150-11e6-898f-b7d201a89248",
                                                            "enum": [
                                                                "de",
                                                                "en",
                                                                "fr",
                                                                "nl"
                                                            ]
                                                        },
                                                        "score": {
                                                            "primaryKey": false,
                                                            "type": "integer",
                                                            "GUID": "0d2296b0-e151-11e6-898f-b7d201a89248",
                                                            "exclusiveMaximum": false,
                                                            "exclusiveMinimum": false
                                                        },
                                                        "NumberOfBoxes": {
                                                            "primaryKey": false,
                                                            "type": "integer",
                                                            "GUID": "096d08c0-e151-11e6-898f-b7d201a89248",
                                                            "exclusiveMaximum": false,
                                                            "exclusiveMinimum": false
                                                        },
                                                        "ServicePointBoxList": {
                                                            "additionalProperties": true,
                                                            "properties": {
                                                                "ServicePointBoxResult": {
                                                                    "primaryKey": false,
                                                                    "additionalItems": true,
                                                                    "minItems": 1,
                                                                    "type": "array",
                                                                    "GUID": "4e23abe0-e151-11e6-898f-b7d201a89248",
                                                                    "items": {
                                                                        "additionalProperties": true,
                                                                        "properties": {
                                                                            "DeliveryServiceIndicator": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "7ba99250-e151-11e6-898f-b7d201a89248"
                                                                            },
                                                                            "StreetNumber": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "78e1e6d0-e151-11e6-898f-b7d201a89248"
                                                                            },
                                                                            "BoxNumber": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "7b2f5940-e151-11e6-898f-b7d201a89248"
                                                                            },
                                                                            "PostalCode": {
                                                                                "primaryKey": false,
                                                                                "type": "string",
                                                                                "GUID": "7c2a5b10-e151-11e6-898f-b7d201a89248"
                                                                            }
                                                                        },
                                                                        "primaryKey": false,
                                                                        "type": "object",
                                                                        "GUID": "5e4109a0-e151-11e6-898f-b7d201a89248",
                                                                        "arrayItem": true
                                                                    },
                                                                    "uniqueItems": false
                                                                }
                                                            },
                                                            "primaryKey": false,
                                                            "type": "object",
                                                            "GUID": "08fbd060-e151-11e6-898f-b7d201a89248"
                                                        },
                                                        "ServicePointDetail": {
                                                            "additionalProperties": true,
                                                            "properties": {
                                                                "GeographicalLocationInfo": {
                                                                    "additionalProperties": true,
                                                                    "properties": {
                                                                        "GeographicalLocation": {
                                                                            "additionalProperties": true,
                                                                            "properties": {
                                                                                "Latitude": {
                                                                                    "additionalProperties": true,
                                                                                    "properties": {
                                                                                        "Value": {
                                                                                            "primaryKey": false,
                                                                                            "type": "string",
                                                                                            "GUID": "eb8fcfd0-e151-11e6-898f-b7d201a89248"
                                                                                        },
                                                                                        "CoordinateType": {
                                                                                            "primaryKey": false,
                                                                                            "type": "string",
                                                                                            "GUID": "f3983d20-e151-11e6-898f-b7d201a89248"
                                                                                        }
                                                                                    },
                                                                                    "primaryKey": false,
                                                                                    "type": "object",
                                                                                    "GUID": "d3465020-e151-11e6-898f-b7d201a89248"
                                                                                },
                                                                                "Longitude": {
                                                                                    "additionalProperties": true,
                                                                                    "properties": {
                                                                                        "Value": {
                                                                                            "primaryKey": false,
                                                                                            "type": "string",
                                                                                            "GUID": "056ac4f0-e152-11e6-898f-b7d201a89248"
                                                                                        },
                                                                                        "CoordinateType": {
                                                                                            "primaryKey": false,
                                                                                            "type": "string",
                                                                                            "GUID": "0ecd1cf0-e152-11e6-898f-b7d201a89248"
                                                                                        }
                                                                                    },
                                                                                    "primaryKey": false,
                                                                                    "type": "object",
                                                                                    "GUID": "fae43840-e151-11e6-898f-b7d201a89248"
                                                                                },
                                                                                "Elevation": {
                                                                                    "additionalProperties": true,
                                                                                    "properties": {
                                                                                        "Quantity": {
                                                                                            "primaryKey": false,
                                                                                            "type": "string",
                                                                                            "GUID": "3eea2900-e152-11e6-898f-b7d201a89248"
                                                                                        },
                                                                                        "UnitOfDimension": {
                                                                                            "primaryKey": false,
                                                                                            "type": "string",
                                                                                            "GUID": "41bcd100-e152-11e6-898f-b7d201a89248"
                                                                                        }
                                                                                    },
                                                                                    "primaryKey": false,
                                                                                    "type": "object",
                                                                                    "GUID": "15e054d0-e152-11e6-898f-b7d201a89248"
                                                                                }
                                                                            },
                                                                            "primaryKey": false,
                                                                            "type": "object",
                                                                            "GUID": "c77f7b40-e151-11e6-898f-b7d201a89248"
                                                                        }
                                                                    },
                                                                    "primaryKey": false,
                                                                    "type": "object",
                                                                    "GUID": "bec17990-e151-11e6-898f-b7d201a89248"
                                                                }
                                                            },
                                                            "primaryKey": false,
                                                            "type": "object",
                                                            "GUID": "087e3bf0-e151-11e6-898f-b7d201a89248"
                                                        },
                                                        "Label": {
                                                            "properties": {
                                                                "Line": {
                                                                    "primaryKey": false,
                                                                    "additionalItems": true,
                                                                    "maxItems": 7,
                                                                    "minItems": 1,
                                                                    "type": "array",
                                                                    "GUID": "1de8f10a-df28-11e6-a3dd-6de9a4b3cd36",
                                                                    "items": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "1de8f10b-df28-11e6-a3dd-6de9a4b3cd36",
                                                                        "arrayItem": true,
                                                                        "sample": "Mr Jacques Martin Lorem"
                                                                    }
                                                                }
                                                            },
                                                            "primaryKey": false,
                                                            "type": "object",
                                                            "GUID": "1de8f109-df28-11e6-a3dd-6de9a4b3cd36"
                                                        }
                                                    },
                                                    "primaryKey": false,
                                                    "type": "object",
                                                    "GUID": "1de8f107-df28-11e6-a3dd-6de9a4b3cd36",
                                                    "arrayItem": true
                                                }
                                            }
                                        },
                                        "primaryKey": false,
                                        "type": "object",
                                        "GUID": "1de8f105-df28-11e6-a3dd-6de9a4b3cd36",
                                        "required": [
                                            "ValidatedAddress"
                                        ]
                                    },
                                    "Error": {
                                        "primaryKey": false,
                                        "additionalItems": true,
                                        "type": "array",
                                        "GUID": "9e418670-e14b-11e6-898f-b7d201a89248",
                                        "items": {
                                            "additionalProperties": true,
                                            "properties": {
                                                "ComponentRef": {
                                                    "primaryKey": false,
                                                    "type": "string",
                                                    "GUID": "b11caf30-e14c-11e6-898f-b7d201a89248"
                                                },
                                                "ErrorCode": {
                                                    "primaryKey": false,
                                                    "type": "string",
                                                    "GUID": "c0136740-e14c-11e6-898f-b7d201a89248"
                                                },
                                                "ErrorSeverity": {
                                                    "primaryKey": false,
                                                    "type": "string",
                                                    "GUID": "c96b5f00-e14c-11e6-898f-b7d201a89248",
                                                    "enum": [
                                                        "warning",
                                                        "error"
                                                    ]
                                                }
                                            },
                                            "primaryKey": false,
                                            "type": "object",
                                            "GUID": "ab485ff0-e14c-11e6-898f-b7d201a89248",
                                            "arrayItem": true,
                                            "required": [
                                                "ComponentRef",
                                                "ErrorCode",
                                                "ErrorSeverity"
                                            ]
                                        },
                                        "uniqueItems": false
                                    },
                                    "DetectedInputAddressLanguage": {
                                        "description": "Address language that is detected by the system based on the given address as input. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’.",
                                        "primaryKey": false,
                                        "type": "string",
                                        "GUID": "1de8c9e6-df28-11e6-a3dd-6de9a4b3cd36",
                                        "sample": "fr",
                                        "enum": [
                                            "de",
                                            "en",
                                            "fr",
                                            "nl"
                                        ]
                                    },
                                    "FormattedSubmittedAddress": {
                                        "properties": {
                                            "Line": {
                                                "primaryKey": false,
                                                "additionalItems": true,
                                                "maxItems": 7,
                                                "minItems": 1,
                                                "type": "array",
                                                "GUID": "1de8c9e8-df28-11e6-a3dd-6de9a4b3cd36",
                                                "items": {
                                                    "primaryKey": false,
                                                    "type": "string",
                                                    "GUID": "1de8c9e9-df28-11e6-a3dd-6de9a4b3cd36",
                                                    "arrayItem": true,
                                                    "sample": "Mr Jacques Martin Lorem"
                                                }
                                            }
                                        },
                                        "primaryKey": false,
                                        "type": "object",
                                        "GUID": "1de8c9e7-df28-11e6-a3dd-6de9a4b3cd36",
                                        "required": [
                                            "Line"
                                        ]
                                    },
                                    "TransactionID": {
                                        "description": "ID which identifies the address validation. Together with the ValidationRequestID, this id defines an address validation uniquely. Used for feedback and acces logging purposes.",
                                        "primaryKey": false,
                                        "type": "string",
                                        "GUID": "1de8f104-df28-11e6-a3dd-6de9a4b3cd36",
                                        "sample": "50627398-65a2-498d-b159-98e578b00c46"
                                    }
                                },
                                "primaryKey": false,
                                "type": "object",
                                "GUID": "1de8c9e4-df28-11e6-a3dd-6de9a4b3cd36",
                                "arrayItem": true,
                                "required": [
                                    "@id"
                                ]
                            }
                        }
                    },
                    "primaryKey": false,
                    "type": "object",
                    "GUID": "1de8c9e2-df28-11e6-a3dd-6de9a4b3cd36",
                    "required": [
                        "ValidatedAddressResult"
                    ]
                },
                "GeneralError": {
                    "additionalProperties": true,
                    "properties": {
                        "ErrorCode": {
                            "primaryKey": false,
                            "type": "string",
                            "GUID": "127b8320-e14b-11e6-898f-b7d201a89248"
                        },
                        "ErrorSeverity": {
                            "primaryKey": false,
                            "type": "string",
                            "GUID": "1eddd4b0-e14b-11e6-898f-b7d201a89248"
                        }
                    },
                    "primaryKey": false,
                    "type": "object",
                    "GUID": "03677f10-e14b-11e6-898f-b7d201a89248",
                    "required": [
                        "ErrorCode",
                        "ErrorSeverity"
                    ]
                }
            },
            "primaryKey": false,
            "type": "object",
            "GUID": "1de8c9e1-df28-11e6-a3dd-6de9a4b3cd36",
            "required": [
                "ValidatedAddressResultList"
            ]
        }
    },
    "type": "object",
    "required": [
        "ValidateAddressesResponse"
    ],
    "transaction": "Response"
}
2.2.9 Response JSON data
{
    "ValidateAddressesResponse": {
        "ValidatedAddressResultList": {
            "ValidatedAddressResult": [
                {
                    "@id": "1",
                    "MaileeAndAddressee": {
                        "AddresseeIndividualIdentification": {
                            "StructuredAddresseeIndividualIdentification": {
                                "AddresseeFormOfAddress": "Mr",
                                "AddresseeGivenName": "Jacques",
                                "AddresseeSurname": "Martin",
                                "AddresseeSupplementaryDispatchInfo": "Lorem"
                            }
                        },
                        "MaileeIndividualIdentification": {
                            "StructuredMaileeIndividualIdentification": {
                                "MaileeRole": "Lorem",
                                "MaileeFormOfAddress": "Lorem",
                                "MaileeGivenName": "Lorem",
                                "MaileeSurname": "Lorem"
                            }
                        },
                        "MaileeOrganizationIdentification": {
                            "StructuredMaileeOrganizationIdentification": {
                                "MaileeOrganizationFunction": "Lorem",
                                "MaileeOrganizationOrganizationalUnit": "Lorem",
                                "MaileeOrganizationOrganizationalName": "Lorem",
                                "MaileeOrganizationLegalStatus": "Lorem"
                            }
                        },
                        "MailRecipientDispatchingInformation": {
                            "StructuredMailRecipientDispatchingInformation": {
                                "Wing": {
                                    "WingType": "Lorem",
                                    "WingIndicator": "Lorem"
                                },
                                "Stairwell": {
                                    "StairwellType": "Lorem",
                                    "StairwellIndicator": "Lorem"
                                },
                                "Floor": {
                                    "FloorType": "Lorem",
                                    "FloorIndicator": "Lorem"
                                },
                                "Door": {
                                    "DoorType": "Lorem",
                                    "DoorIndicator": "Lorem"
                                },
                                "BuildingConstruction": "Lorem"
                            }
                        }
                    },
                    "ValidatedAddressList": {
                        "ValidatedAddress": [
                            {
                                "PostalAddress": {
                                    "StructuredDeliveryPointLocation": {
                                        "StreetName": "RUE EDOUARD DEKOSTER",
                                        "StreetNumber": "64",
                                        "BoxNumber": "84"
                                    },
                                    "StructuredPostalCodeMunicipality": {
                                        "PostalCode": "1140",
                                        "MunicipalityName": "EVERE"
                                    },
                                    "CountryName": "BELGIQUE"
                                },
                                "AddressLanguage": "nl",
                                "score": 38,
                                "NumberOfBoxes": 43,
                                "ServicePointBoxList": {
                                    "ServicePointBoxResult": [
                                        {
                                            "StreetNumber": "Lorem",
                                            "BoxNumber": "Lorem",
                                            "DeliveryServiceIndicator": "Lorem",
                                            "PostalCode": "Lorem"
                                        }
                                    ]
                                },
                                "ServicePointDetail": {
                                    "GeographicalLocationInfo": {
                                        "GeographicalLocation": {
                                            "Latitude": {
                                                "Value": "Lorem",
                                                "CoordinateType": "Lorem"
                                            },
                                            "Longitude": {
                                                "Value": "Lorem",
                                                "CoordinateType": "Lorem"
                                            },
                                            "Elevation": {
                                                "Quantity": "Lorem",
                                                "UnitOfDimension": "Lorem"
                                            }
                                        }
                                    }
                                },
                                "Label": {
                                    "Line": [
                                        "Mr Jacques Martin Lorem"
                                    ]
                                }
                            }
                        ]
                    },
                    "Error": [
                        {
                            "ComponentRef": "Lorem",
                            "ErrorCode": "Lorem",
                            "ErrorSeverity": "error"
                        }
                    ],
                    "DetectedInputAddressLanguage": "fr",
                    "FormattedSubmittedAddress": {
                        "Line": [
                            "Mr Jacques Martin Lorem"
                        ]
                    },
                    "TransactionID": "50627398-65a2-498d-b159-98e578b00c46"
                }
            ]
        },
        "GeneralError": {
            "ErrorCode": "Lorem",
            "ErrorSeverity": "Lorem"
        }
    }
}
3. Relationships
3.1 Relationship AddressID
3.1.2 AddressID Properties
PropertyValue
Name AddressID
Description
Parent DocumentRequest
Parent field@id
Parent Cardinality 1
Child DocumentResponse
Child field@id
Child Cardinality 1
Comments