✕

JSON Physical Model

Schema for:

Model name: bpostAddressFormattingWebservice - External
Author: Pascal
Version: 1.4
File name: bpost Address Formatting Webservice - External v1.4.json
File path: /Users/pascal_hackolade/Documents/Hackolade/Models/bpost Address Formatting Webservice - External v1.4.json
Printed On: Thu Feb 16 2017 16:32:25 GMT+0100 (CET)
Created with: Hackolade - Visual data modeling for NoSQL and multimodel databases
1. Model
2. Documents
3. Relationships
1. Model
1.1 Model bpostAddressFormattingWebservice - External
1.1.1 bpostAddressFormattingWebservice - External Entity Relationship Diagram
Request
FormatAddressesRequest
<obj>
AddressToFormatList
<obj>
AddressToFormat
<arr>
[0]
<obj>
@id
<str>
oneOf
<ch>
[0]
<sub>
MaileeAndAddressee
<obj>
StructuredAddresseeIndividualIdentification
<obj>
AddresseeFormOfAddress
<str>
AddresseeGivenName
<str>
AddresseeSurname
<str>
AddresseeSupplementaryDispatchInfo
<str>
StructuredMaileeIndividualIdentification
<obj>
MaileeRole
<str>
MaileeFormOfAddress
<str>
MaileeGivenName
<str>
MaileeSurname
<str>
StructuredMaileeOrganizationIdentification
<obj>
MaileeOrganizationFunction
<str>
MaileeOrganizationOrganizationalUnit
<str>
MaileeOrganizationOrganizationalName
<str>
MaileeOrganizationLegalStatus
<str>
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>
PostalAddress
<obj>
StructuredOtherDeliveryInformation
<obj>
DeliveryServiceType
<str>
DeliveryServiceIndicator
<str>
StructuredDeliveryPointLocation
<obj>
StreetName
<obj>
@locale
<str>
*body
<str>
StreetNumber
<str>
BoxNumber
<str>
StructuredPostalCodeMunicipality
<obj>
PostalCode
<str>
MunicipalityName
<obj>
@locale
<str>
*body
<str>
DeliveryServiceQualifier
<str>
CountryName
<obj>
@locale
<str>
*body
<str>
[1]
<sub>
AddressBlockLines
<obj>
UnstructuredAddressLine
<arr>
[0]
<obj>
@locale
<str>
*body
<str>
AddressLanguage
<str>
DispatchingCountryISOCode
<str>
DeliveringCountryISOCode
<str>
CallerIdentification
<obj>
CallerName
<str>
Response
FormatAddressesResponse
<obj>
FormattedAddressResultList
<obj>
FormattedAddressResult
<arr>
[0]
<obj>
@id
fk
<str>
Label
<obj>
Line
<arr>
[0]
<str>
Error
<arr>
[0]
<obj>
ErrorCode
<str>
ErrorSeverity
<str>
GeneralError
<obj>
ErrorCode
<str>
ErrorSeverity
<str>
1.1.2 bpostAddressFormattingWebservice - External Properties
PropertyValue
Name bpostAddressFormattingWebservice - External
Description JSON Schema for bpost RESTful webservice for Address Formatting according to UPU/CEN S42 standard -- valid only with addresses for Belgium.
Author Pascal
Version 1
DB Vendor Plain JSON--no DB
Comments
1.1.4 bpostAddressFormattingWebservice - External DB Definitions (TBD)
2. Document
2.1 Document Request
2.1.1 Request Tree Diagram
X
{ABC}
CallerName
type
{...}
CallerIdentification
type
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
AddressLanguage
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
@id
type
{...}
[0]
type
[...]
AddressToFormat
type
{...}
AddressToFormatList
type
{...}
FormatAddressesRequest
type
Request
type
{ABC}
CallerName
type
{...}
CallerIdentification
type
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
AddressLanguage
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
@id
type
{...}
[0]
type
[...]
AddressToFormat
type
{...}
AddressToFormatList
type
{...}
FormatAddressesRequest
type
Request
type
2.1.2 Request Properties
PropertyValue
Document name Request
Id
Description Request schema specification for bpost Address Formatting webservice
RESTful API true
Transaction Request
Method Post
EndPoint http://webservices-pub.bpost.be
Resources /ws/ExternalMailingAddressProofingCSREST_v1/address/validateAddresses
Media type application/JSON
Additional properties
Comments
2.1.3 Request Fields
FieldTypeReqKeyDescription
FormatAddressesRequestdocumenttrue
AddressToFormatListdocumenttrue
AddressToFormatarraytrue
[0]documentfalse
@idstringtrue
oneOfchoicefalse
[0]subschemafalse
MaileeAndAddresseedocumentfalse
StructuredAddresseeIndividualIdentificationdocumentfalse
AddresseeFormOfAddressstringfalse
AddresseeGivenNamestringfalse
AddresseeSurnamestringfalse
AddresseeSupplementaryDispatchInfostringfalse
StructuredMaileeIndividualIdentificationdocumentfalse
MaileeRolestringfalse
MaileeFormOfAddressstringfalse
MaileeGivenNamestringfalse
MaileeSurnamestringfalse
StructuredMaileeOrganizationIdentificationdocumentfalse
MaileeOrganizationFunctionstringfalse
MaileeOrganizationOrganizationalUnitstringfalse
MaileeOrganizationOrganizationalNamestringfalse
MaileeOrganizationLegalStatusstringfalse
StructuredMailRecipientDispatchingInformationdocumentfalse
Wingdocumentfalse
WingTypestringtrue
WingIndicatorstringtrue
Stairwelldocumentfalse
StairwellTypestringtrue
StairwellIndicatorstringtrue
Floordocumentfalse
FloorTypestringtrue
FloorIndicatorstringtrue
Doordocumentfalse
DoorTypestringtrue
DoorIndicatorstringtrue
BuildingConstructionstringfalse
PostalAddressdocumenttrue
StructuredOtherDeliveryInformationdocumentfalse
DeliveryServiceTypestringfalse
DeliveryServiceIndicatorstringfalse
StructuredDeliveryPointLocationdocumentfalse
StreetNamedocumentfalse
@localestringfalse
*bodystringtrue
StreetNumberstringfalse
BoxNumberstringfalse
StructuredPostalCodeMunicipalitydocumenttrue
PostalCodestringtrue
MunicipalityNamedocumenttrue
@localestringfalse
*bodystringtrue
DeliveryServiceQualifierstringfalse
CountryNamedocumentfalse
@localestringfalse
*bodystringtrue
[1]subschemafalse
AddressBlockLinesdocumentfalse
UnstructuredAddressLinearraytrue
[0]documentfalse
@localestringfalse
*bodystringtrue
AddressLanguagestringfalse
DispatchingCountryISOCodestringfalse
DeliveringCountryISOCodestringfalse
CallerIdentificationdocumentfalse
CallerNamestringtrue
2.1.3.1 Field FormatAddressesRequest
2.1.3.1.1 FormatAddressesRequest Tree Diagram
X
{ABC}
CallerName
type
{...}
CallerIdentification
type
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
AddressLanguage
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
@id
type
{...}
[0]
type
[...]
AddressToFormat
type
{...}
AddressToFormatList
type
FormatAddressesRequest
type
{ABC}
CallerName
type
{...}
CallerIdentification
type
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
AddressLanguage
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
@id
type
{...}
[0]
type
[...]
AddressToFormat
type
{...}
AddressToFormatList
type
FormatAddressesRequest
type
2.1.3.1.2 FormatAddressesRequest Hierarchy
Parent field: Request
Child field(s):
FieldTypeReqKeyDescription
AddressToFormatListdocumenttrue
CallerIdentificationdocumentfalseInformation about the caller of the service, in case no authentication mechanism exists.
FormatAddressesRequest properties
PropertyValue
Name FormatAddressesRequest
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 AddressToFormatList
2.1.3.2.1 AddressToFormatList Tree Diagram
X
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
AddressLanguage
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
@id
type
{...}
[0]
type
[...]
AddressToFormat
type
AddressToFormatList
type
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
AddressLanguage
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
@id
type
{...}
[0]
type
[...]
AddressToFormat
type
AddressToFormatList
type
2.1.3.2.2 AddressToFormatList Hierarchy
Parent field: FormatAddressesRequest
Child field(s):
FieldTypeReqKeyDescription
AddressToFormatarraytrue
AddressToFormatList properties
PropertyValue
Name AddressToFormatList
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 AddressToFormat
2.1.3.3.1 AddressToFormat Tree Diagram
X
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
AddressLanguage
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
@id
type
{...}
[0]*
type
[...]
AddressToFormat
type
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
AddressLanguage
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
@id
type
{...}
[0]*
type
[...]
AddressToFormat
type
2.1.3.3.2 AddressToFormat Hierarchy
Parent field: AddressToFormatList
Child field(s):
FieldTypeReqKeyDescription
documentfalse
AddressToFormat properties
PropertyValue
Name AddressToFormat
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.1.3.4 Field
2.1.3.4.1 [0] Tree Diagram
X
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
AddressLanguage
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
@id
type
[0]
type
{ABC}
DeliveringCountryISOCode
type
{ABC}
DispatchingCountryISOCode
type
{ABC}
AddressLanguage
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
@id
type
[0]
type
2.1.3.4.2 [0] Hierarchy
Parent field: AddressToFormat
Child field(s):
FieldTypeReqKeyDescription
@idstringtrue
oneOfchoicefalse
AddressLanguagestringfalseS42 name: Address Parameter Language, code: 50.51.0.0.0. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’.
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
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
2.1.3.6.1 Tree Diagram
X
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[1]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[0]
type
2.1.3.6.2 Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
[undefined]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.
[undefined]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.
properties
PropertyValue
Choice oneOf
2.1.3.7 Field
2.1.3.7.1 Tree Diagram
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[subschema]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
{...}
PostalAddress
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
{...}
MaileeAndAddressee
type
{Sub}
[subschema]
type
2.1.3.7.2 Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
MaileeAndAddresseedocumentfalse
PostalAddressdocumenttrue
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.
Required
Min Properties
Max Properties
Additional properties true
Comments
2.1.3.8 Field MaileeAndAddressee
2.1.3.8.1 MaileeAndAddressee Tree Diagram
{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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
MaileeAndAddressee
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
{ABC}
MaileeOrganizationLegalStatus
type
{ABC}
MaileeOrganizationOrganizationalName
type
{ABC}
MaileeOrganizationOrganizationalUnit
type
{ABC}
MaileeOrganizationFunction
type
{...}
StructuredMaileeOrganizationIdentification
type
{ABC}
MaileeSurname
type
{ABC}
MaileeGivenName
type
{ABC}
MaileeFormOfAddress
type
{ABC}
MaileeRole
type
{...}
StructuredMaileeIndividualIdentification
type
{ABC}
AddresseeSupplementaryDispatchInfo
type
{ABC}
AddresseeSurname
type
{ABC}
AddresseeGivenName
type
{ABC}
AddresseeFormOfAddress
type
{...}
StructuredAddresseeIndividualIdentification
type
MaileeAndAddressee
type
2.1.3.8.2 MaileeAndAddressee Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredAddresseeIndividualIdentificationdocumentfalse
StructuredMaileeIndividualIdentificationdocumentfalse
StructuredMaileeOrganizationIdentificationdocumentfalse
StructuredMailRecipientDispatchingInformationdocumentfalse
MaileeAndAddressee properties
PropertyValue
Name MaileeAndAddressee
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.9 Field StructuredAddresseeIndividualIdentification
2.1.3.9.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.9.2 StructuredAddresseeIndividualIdentification Hierarchy
Parent field: MaileeAndAddressee
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.10 Field AddresseeFormOfAddress
2.1.3.10.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.11 Field AddresseeGivenName
2.1.3.11.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.12 Field AddresseeSurname
2.1.3.12.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.13 Field AddresseeSupplementaryDispatchInfo
2.1.3.13.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.14 Field StructuredMaileeIndividualIdentification
2.1.3.14.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.14.2 StructuredMaileeIndividualIdentification Hierarchy
Parent field: MaileeAndAddressee
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
Comments
2.1.3.15 Field MaileeRole
2.1.3.15.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.16 Field MaileeFormOfAddress
2.1.3.16.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.17 Field MaileeGivenName
2.1.3.17.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.18 Field MaileeSurname
2.1.3.18.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.19 Field StructuredMaileeOrganizationIdentification
2.1.3.19.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.19.2 StructuredMaileeOrganizationIdentification Hierarchy
Parent field: MaileeAndAddressee
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
Comments
2.1.3.20 Field MaileeOrganizationFunction
2.1.3.20.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.21 Field MaileeOrganizationOrganizationalUnit
2.1.3.21.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.22 Field MaileeOrganizationOrganizationalName
2.1.3.22.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.23 Field MaileeOrganizationLegalStatus
2.1.3.23.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.24 Field StructuredMailRecipientDispatchingInformation
2.1.3.24.1 StructuredMailRecipientDispatchingInformation Tree Diagram
{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
{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
2.1.3.24.2 StructuredMailRecipientDispatchingInformation Hierarchy
Parent field: MaileeAndAddressee
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
Comments
2.1.3.25 Field Wing
2.1.3.25.1 Wing Tree Diagram
{ABC}
WingIndicator
type
{ABC}
WingType
type
Wing
type
{ABC}
WingIndicator
type
{ABC}
WingType
type
Wing
type
2.1.3.25.2 Wing Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
WingTypestringtrueS42 name: Wing Type, code: 30.29.0.0.1
WingIndicatorstringtrueS42 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
Comments
2.1.3.26 Field WingType
2.1.3.26.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 b3cb54ca-e31e-11e6-aae7-27e5e7efbb51
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.27 Field WingIndicator
2.1.3.27.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 true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.28 Field Stairwell
2.1.3.28.1 Stairwell Tree Diagram
{ABC}
StairwellIndicator
type
{ABC}
StairwellType
type
Stairwell
type
{ABC}
StairwellIndicator
type
{ABC}
StairwellType
type
Stairwell
type
2.1.3.28.2 Stairwell Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
StairwellTypestringtrueS42 name: Stairwell Type, code: 30.30.0.0.1
StairwellIndicatorstringtrueS42 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
Comments
2.1.3.29 Field StairwellType
2.1.3.29.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 b3cb54cd-e31e-11e6-aae7-27e5e7efbb51
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.30 Field StairwellIndicator
2.1.3.30.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 true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.31 Field Floor
2.1.3.31.1 Floor Tree Diagram
{ABC}
FloorIndicator
type
{ABC}
FloorType
type
Floor
type
{ABC}
FloorIndicator
type
{ABC}
FloorType
type
Floor
type
2.1.3.31.2 Floor Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
FloorTypestringtrueS42 name: Floor Type, code: 30.31.0.0.1
FloorIndicatorstringtrueS42 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
Comments
2.1.3.32 Field FloorType
2.1.3.32.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 b3cb54d0-e31e-11e6-aae7-27e5e7efbb51
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.33 Field FloorIndicator
2.1.3.33.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 true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.34 Field Door
2.1.3.34.1 Door Tree Diagram
{ABC}
DoorIndicator
type
{ABC}
DoorType
type
Door
type
{ABC}
DoorIndicator
type
{ABC}
DoorType
type
Door
type
2.1.3.34.2 Door Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
FieldTypeReqKeyDescription
DoorTypestringtrueS42 name: Door Type, code: 30.32.0.0.1
DoorIndicatorstringtrueS42 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
Comments
2.1.3.35 Field DoorType
2.1.3.35.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 b3cb54d3-e31e-11e6-aae7-27e5e7efbb51
Required true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.36 Field DoorIndicator
2.1.3.36.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 true
Primary key false
Foreign document
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.3.37 Field BuildingConstruction
2.1.3.37.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.38 Field PostalAddress
2.1.3.38.1 PostalAddress Tree Diagram
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
PostalAddress
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
CountryName
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
{...}
StructuredPostalCodeMunicipality
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
{...}
StructuredDeliveryPointLocation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
{...}
StructuredOtherDeliveryInformation
type
PostalAddress
type
2.1.3.38.2 PostalAddress Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
StructuredOtherDeliveryInformationdocumentfalse
StructuredDeliveryPointLocationdocumentfalse
StructuredPostalCodeMunicipalitydocumenttrue
CountryNamedocumentfalse
PostalAddress properties
PropertyValue
Name PostalAddress
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.39 Field StructuredOtherDeliveryInformation
2.1.3.39.1 StructuredOtherDeliveryInformation Tree Diagram
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
StructuredOtherDeliveryInformation
type
{ABC}
DeliveryServiceIndicator
type
{ABC}
DeliveryServiceType
type
StructuredOtherDeliveryInformation
type
2.1.3.39.2 StructuredOtherDeliveryInformation Hierarchy
Parent field: PostalAddress
Child field(s):
FieldTypeReqKeyDescription
DeliveryServiceTypestringfalse
DeliveryServiceIndicatorstringfalse
StructuredOtherDeliveryInformation properties
PropertyValue
Name StructuredOtherDeliveryInformation
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.40 Field DeliveryServiceType
2.1.3.40.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.41 Field DeliveryServiceIndicator
2.1.3.41.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.42 Field StructuredDeliveryPointLocation
2.1.3.42.1 StructuredDeliveryPointLocation Tree Diagram
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
StructuredDeliveryPointLocation
type
{ABC}
BoxNumber
type
{ABC}
StreetNumber
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
StreetName
type
StructuredDeliveryPointLocation
type
2.1.3.42.2 StructuredDeliveryPointLocation Hierarchy
Parent field: PostalAddress
Child field(s):
FieldTypeReqKeyDescription
StreetNamedocumentfalse
StreetNumberstringfalse
BoxNumberstringfalse
StructuredDeliveryPointLocation properties
PropertyValue
Name StructuredDeliveryPointLocation
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.43 Field StreetName
2.1.3.43.1 StreetName Tree Diagram
{ABC}
*body
type
{ABC}
@locale
type
StreetName
type
{ABC}
*body
type
{ABC}
@locale
type
StreetName
type
2.1.3.43.2 StreetName Hierarchy
Parent field: StructuredDeliveryPointLocation
Child field(s):
FieldTypeReqKeyDescription
@localestringfalse
*bodystringtrue
StreetName properties
PropertyValue
Name StreetName
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.44 Field @locale
2.1.3.44.1 @locale Tree Diagram
{ABC}
@locale
type
{ABC}
@locale
type
@locale properties
PropertyValue
Name @locale
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 fr
Comments
2.1.3.45 Field *body
2.1.3.45.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 Rue du Vivier
Comments
2.1.3.46 Field StreetNumber
2.1.3.46.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.47 Field BoxNumber
2.1.3.47.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.48 Field StructuredPostalCodeMunicipality
2.1.3.48.1 StructuredPostalCodeMunicipality Tree Diagram
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
StructuredPostalCodeMunicipality
type
{ABC}
DeliveryServiceQualifier
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
MunicipalityName
type
{ABC}
PostalCode
type
StructuredPostalCodeMunicipality
type
2.1.3.48.2 StructuredPostalCodeMunicipality Hierarchy
Parent field: PostalAddress
Child field(s):
FieldTypeReqKeyDescription
PostalCodestringtrueMunicipality postal code
MunicipalityNamedocumenttrue
DeliveryServiceQualifierstringfalse
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.1.3.49 Field PostalCode
2.1.3.49.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
Max length
Pattern
Format
Enum
Sample 1140
Comments
2.1.3.50 Field MunicipalityName
2.1.3.50.1 MunicipalityName Tree Diagram
{ABC}
*body
type
{ABC}
@locale
type
MunicipalityName
type
{ABC}
*body
type
{ABC}
@locale
type
MunicipalityName
type
2.1.3.50.2 MunicipalityName Hierarchy
Parent field: StructuredPostalCodeMunicipality
Child field(s):
FieldTypeReqKeyDescription
@localestringfalse
*bodystringtrue
MunicipalityName properties
PropertyValue
Name MunicipalityName
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.51 Field @locale
2.1.3.51.1 @locale Tree Diagram
{ABC}
@locale
type
{ABC}
@locale
type
@locale properties
PropertyValue
Name @locale
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 nl
Comments
2.1.3.52 Field *body
2.1.3.52.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 Bruxelles
Comments
2.1.3.53 Field DeliveryServiceQualifier
2.1.3.53.1 DeliveryServiceQualifier Tree Diagram
{ABC}
DeliveryServiceQualifier
type
{ABC}
DeliveryServiceQualifier
type
DeliveryServiceQualifier properties
PropertyValue
Name DeliveryServiceQualifier
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.1.3.54 Field CountryName
2.1.3.54.1 CountryName Tree Diagram
{ABC}
*body
type
{ABC}
@locale
type
CountryName
type
{ABC}
*body
type
{ABC}
@locale
type
CountryName
type
2.1.3.54.2 CountryName Hierarchy
Parent field: PostalAddress
Child field(s):
FieldTypeReqKeyDescription
@localestringfalse
*bodystringtrue
CountryName properties
PropertyValue
Name CountryName
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.55 Field @locale
2.1.3.55.1 @locale Tree Diagram
{ABC}
@locale
type
{ABC}
@locale
type
@locale properties
PropertyValue
Name @locale
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 nl
Comments
2.1.3.56 Field *body
2.1.3.56.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 BELGIUM
Comments
2.1.3.57 Field
2.1.3.57.1 Tree Diagram
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[subschema]
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
{...}
AddressBlockLines
type
{Sub}
[subschema]
type
2.1.3.57.2 Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
AddressBlockLinesdocumentfalse
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 false
Comments
2.1.3.58 Field AddressBlockLines
2.1.3.58.1 AddressBlockLines Tree Diagram
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
AddressBlockLines
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]
type
[...]
UnstructuredAddressLine
type
AddressBlockLines
type
2.1.3.58.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.59 Field UnstructuredAddressLine
2.1.3.59.1 UnstructuredAddressLine Tree Diagram
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]*
type
[...]
UnstructuredAddressLine
type
{ABC}
*body
type
{ABC}
@locale
type
{...}
[0]*
type
[...]
UnstructuredAddressLine
type
2.1.3.59.2 UnstructuredAddressLine Hierarchy
Parent field: AddressBlockLines
Child field(s):
FieldTypeReqKeyDescription
documentfalse
UnstructuredAddressLine properties
PropertyValue
Name UnstructuredAddressLine
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.1.3.60 Field
2.1.3.60.1 [0] Tree Diagram
{ABC}
*body
type
{ABC}
@locale
type
[0]
type
{ABC}
*body
type
{ABC}
@locale
type
[0]
type
2.1.3.60.2 [0] Hierarchy
Parent field: UnstructuredAddressLine
Child field(s):
FieldTypeReqKeyDescription
@localestringfalse
*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.61 Field @locale
2.1.3.61.1 @locale Tree Diagram
{ABC}
@locale
type
{ABC}
@locale
type
@locale properties
PropertyValue
Name @locale
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 nl
Comments
2.1.3.62 Field *body
2.1.3.62.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.63 Field AddressLanguage
2.1.3.63.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.1.3.64 Field DispatchingCountryISOCode
2.1.3.64.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.65 Field DeliveringCountryISOCode
2.1.3.65.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.66 Field CallerIdentification
2.1.3.66.1 CallerIdentification Tree Diagram
{ABC}
CallerName
type
CallerIdentification
type
{ABC}
CallerName
type
CallerIdentification
type
2.1.3.66.2 CallerIdentification Hierarchy
Parent field: FormatAddressesRequest
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.67 Field CallerName
2.1.3.67.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 Formatting webservice",
    "endPoint": "http://webservices-pub.bpost.be",
    "isRestfulApi": true,
    "mediaType": "application/JSON",
    "method": "Post",
    "properties": {
        "FormatAddressesRequest": {
            "properties": {
                "AddressToFormatList": {
                    "properties": {
                        "AddressToFormat": {
                            "primaryKey": false,
                            "additionalItems": true,
                            "type": "array",
                            "GUID": "b3cb54b2-e31e-11e6-aae7-27e5e7efbb51",
                            "items": {
                                "properties": {
                                    "@id": {
                                        "primaryKey": false,
                                        "type": "string",
                                        "GUID": "b3cb54b4-e31e-11e6-aae7-27e5e7efbb51",
                                        "sample": "1"
                                    },
                                    "AddressLanguage": {
                                        "description": "S42 name: Address Parameter Language, code: 50.51.0.0.0. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’.",
                                        "primaryKey": false,
                                        "type": "string",
                                        "GUID": "b3cb7bd2-e31e-11e6-aae7-27e5e7efbb51",
                                        "enum": [
                                            "de",
                                            "en",
                                            "fr",
                                            "nl"
                                        ]
                                    },
                                    "DispatchingCountryISOCode": {
                                        "description": "S42 name: Dispatching Country ISO Code, code: 50.53.0.0.0",
                                        "primaryKey": false,
                                        "type": "string",
                                        "GUID": "b3cb7bd3-e31e-11e6-aae7-27e5e7efbb51",
                                        "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": "b3cb7bd4-e31e-11e6-aae7-27e5e7efbb51",
                                        "sample": "BE"
                                    }
                                },
                                "primaryKey": false,
                                "type": "object",
                                "GUID": "b3cb54b3-e31e-11e6-aae7-27e5e7efbb51",
                                "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.",
                                        "properties": {
                                            "MaileeAndAddressee": {
                                                "properties": {
                                                    "StructuredAddresseeIndividualIdentification": {
                                                        "properties": {
                                                            "AddresseeFormOfAddress": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54b9-e31e-11e6-aae7-27e5e7efbb51",
                                                                "sample": "Mr"
                                                            },
                                                            "AddresseeGivenName": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54ba-e31e-11e6-aae7-27e5e7efbb51",
                                                                "sample": "Jacques"
                                                            },
                                                            "AddresseeSurname": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54bb-e31e-11e6-aae7-27e5e7efbb51",
                                                                "sample": "Martin"
                                                            },
                                                            "AddresseeSupplementaryDispatchInfo": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54bc-e31e-11e6-aae7-27e5e7efbb51"
                                                            }
                                                        },
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b3cb54b8-e31e-11e6-aae7-27e5e7efbb51"
                                                    },
                                                    "StructuredMaileeIndividualIdentification": {
                                                        "properties": {
                                                            "MaileeRole": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54be-e31e-11e6-aae7-27e5e7efbb51"
                                                            },
                                                            "MaileeFormOfAddress": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54bf-e31e-11e6-aae7-27e5e7efbb51"
                                                            },
                                                            "MaileeGivenName": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54c0-e31e-11e6-aae7-27e5e7efbb51"
                                                            },
                                                            "MaileeSurname": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54c1-e31e-11e6-aae7-27e5e7efbb51"
                                                            }
                                                        },
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b3cb54bd-e31e-11e6-aae7-27e5e7efbb51"
                                                    },
                                                    "StructuredMaileeOrganizationIdentification": {
                                                        "properties": {
                                                            "MaileeOrganizationFunction": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54c3-e31e-11e6-aae7-27e5e7efbb51"
                                                            },
                                                            "MaileeOrganizationOrganizationalUnit": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54c4-e31e-11e6-aae7-27e5e7efbb51"
                                                            },
                                                            "MaileeOrganizationOrganizationalName": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54c5-e31e-11e6-aae7-27e5e7efbb51"
                                                            },
                                                            "MaileeOrganizationLegalStatus": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54c6-e31e-11e6-aae7-27e5e7efbb51"
                                                            }
                                                        },
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b3cb54c2-e31e-11e6-aae7-27e5e7efbb51"
                                                    },
                                                    "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": "b3cb54c9-e31e-11e6-aae7-27e5e7efbb51"
                                                                    },
                                                                    "WingIndicator": {
                                                                        "description": "S42 name: Wing Indicator, code: 30.29.0.0.2",
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "b3cb54ca-e31e-11e6-aae7-27e5e7efbb51"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "b3cb54c8-e31e-11e6-aae7-27e5e7efbb51",
                                                                "required": [
                                                                    "WingType",
                                                                    "WingIndicator"
                                                                ],
                                                                "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": "b3cb54cc-e31e-11e6-aae7-27e5e7efbb51"
                                                                    },
                                                                    "StairwellIndicator": {
                                                                        "description": "S42 name: Stairwell Indicator, code: 30.30.0.0.2",
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "b3cb54cd-e31e-11e6-aae7-27e5e7efbb51"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "b3cb54cb-e31e-11e6-aae7-27e5e7efbb51",
                                                                "required": [
                                                                    "StairwellType",
                                                                    "StairwellIndicator"
                                                                ],
                                                                "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": "b3cb54cf-e31e-11e6-aae7-27e5e7efbb51"
                                                                    },
                                                                    "FloorIndicator": {
                                                                        "description": "S42 name: Floor Indicator, code: 30.31.0.0.2",
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "b3cb54d0-e31e-11e6-aae7-27e5e7efbb51"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "b3cb54ce-e31e-11e6-aae7-27e5e7efbb51",
                                                                "required": [
                                                                    "FloorType",
                                                                    "FloorIndicator"
                                                                ],
                                                                "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": "b3cb54d2-e31e-11e6-aae7-27e5e7efbb51"
                                                                    },
                                                                    "DoorIndicator": {
                                                                        "description": "S42 name: Door Indicator, code: 30.32.0.0.2",
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "b3cb54d3-e31e-11e6-aae7-27e5e7efbb51"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "b3cb54d1-e31e-11e6-aae7-27e5e7efbb51",
                                                                "required": [
                                                                    "DoorType",
                                                                    "DoorIndicator"
                                                                ],
                                                                "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": "b3cb54d4-e31e-11e6-aae7-27e5e7efbb51"
                                                            }
                                                        },
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b3cb54c7-e31e-11e6-aae7-27e5e7efbb51"
                                                    }
                                                },
                                                "primaryKey": false,
                                                "type": "object",
                                                "GUID": "b3cb54b7-e31e-11e6-aae7-27e5e7efbb51"
                                            },
                                            "PostalAddress": {
                                                "properties": {
                                                    "StructuredOtherDeliveryInformation": {
                                                        "properties": {
                                                            "DeliveryServiceType": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54d7-e31e-11e6-aae7-27e5e7efbb51"
                                                            },
                                                            "DeliveryServiceIndicator": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb54d8-e31e-11e6-aae7-27e5e7efbb51"
                                                            }
                                                        },
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b3cb54d6-e31e-11e6-aae7-27e5e7efbb51"
                                                    },
                                                    "StructuredDeliveryPointLocation": {
                                                        "properties": {
                                                            "StreetName": {
                                                                "properties": {
                                                                    "@locale": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "b3cb54db-e31e-11e6-aae7-27e5e7efbb51",
                                                                        "sample": "fr"
                                                                    },
                                                                    "*body": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "b3cb7bc0-e31e-11e6-aae7-27e5e7efbb51",
                                                                        "sample": "Rue du Vivier"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "b3cb54da-e31e-11e6-aae7-27e5e7efbb51",
                                                                "required": [
                                                                    "*body"
                                                                ]
                                                            },
                                                            "StreetNumber": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb7bc1-e31e-11e6-aae7-27e5e7efbb51",
                                                                "sample": "64"
                                                            },
                                                            "BoxNumber": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb7bc2-e31e-11e6-aae7-27e5e7efbb51",
                                                                "sample": "84"
                                                            }
                                                        },
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b3cb54d9-e31e-11e6-aae7-27e5e7efbb51"
                                                    },
                                                    "StructuredPostalCodeMunicipality": {
                                                        "properties": {
                                                            "PostalCode": {
                                                                "description": "Municipality postal code",
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb7bc4-e31e-11e6-aae7-27e5e7efbb51",
                                                                "sample": "1140"
                                                            },
                                                            "MunicipalityName": {
                                                                "properties": {
                                                                    "@locale": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "b3cb7bc6-e31e-11e6-aae7-27e5e7efbb51",
                                                                        "sample": "nl"
                                                                    },
                                                                    "*body": {
                                                                        "primaryKey": false,
                                                                        "type": "string",
                                                                        "GUID": "b3cb7bc7-e31e-11e6-aae7-27e5e7efbb51",
                                                                        "sample": "Bruxelles"
                                                                    }
                                                                },
                                                                "primaryKey": false,
                                                                "type": "object",
                                                                "GUID": "b3cb7bc5-e31e-11e6-aae7-27e5e7efbb51",
                                                                "required": [
                                                                    "*body"
                                                                ]
                                                            },
                                                            "DeliveryServiceQualifier": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb7bc8-e31e-11e6-aae7-27e5e7efbb51"
                                                            }
                                                        },
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b3cb7bc3-e31e-11e6-aae7-27e5e7efbb51",
                                                        "required": [
                                                            "PostalCode",
                                                            "MunicipalityName"
                                                        ]
                                                    },
                                                    "CountryName": {
                                                        "properties": {
                                                            "@locale": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb7bca-e31e-11e6-aae7-27e5e7efbb51",
                                                                "sample": "nl"
                                                            },
                                                            "*body": {
                                                                "primaryKey": false,
                                                                "type": "string",
                                                                "GUID": "b3cb7bcb-e31e-11e6-aae7-27e5e7efbb51",
                                                                "sample": "BELGIUM"
                                                            }
                                                        },
                                                        "primaryKey": false,
                                                        "type": "object",
                                                        "GUID": "b3cb7bc9-e31e-11e6-aae7-27e5e7efbb51",
                                                        "required": [
                                                            "*body"
                                                        ]
                                                    }
                                                },
                                                "primaryKey": false,
                                                "type": "object",
                                                "GUID": "b3cb54d5-e31e-11e6-aae7-27e5e7efbb51",
                                                "required": [
                                                    "StructuredPostalCodeMunicipality"
                                                ]
                                            }
                                        },
                                        "primaryKey": false,
                                        "type": "object",
                                        "GUID": "b3cb54b6-e31e-11e6-aae7-27e5e7efbb51",
                                        "additionalProperties": true,
                                        "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.",
                                        "properties": {
                                            "AddressBlockLines": {
                                                "properties": {
                                                    "UnstructuredAddressLine": {
                                                        "primaryKey": false,
                                                        "additionalItems": true,
                                                        "type": "array",
                                                        "GUID": "b3cb7bce-e31e-11e6-aae7-27e5e7efbb51",
                                                        "items": {
                                                            "properties": {
                                                                "@locale": {
                                                                    "primaryKey": false,
                                                                    "type": "string",
                                                                    "GUID": "b3cb7bd0-e31e-11e6-aae7-27e5e7efbb51",
                                                                    "sample": "nl"
                                                                },
                                                                "*body": {
                                                                    "primaryKey": false,
                                                                    "type": "string",
                                                                    "GUID": "b3cb7bd1-e31e-11e6-aae7-27e5e7efbb51",
                                                                    "sample": "1150 Bruxelles"
                                                                }
                                                            },
                                                            "primaryKey": false,
                                                            "type": "object",
                                                            "GUID": "b3cb7bcf-e31e-11e6-aae7-27e5e7efbb51",
                                                            "arrayItem": true,
                                                            "required": [
                                                                "*body"
                                                            ]
                                                        }
                                                    }
                                                },
                                                "primaryKey": false,
                                                "type": "object",
                                                "GUID": "b3cb7bcd-e31e-11e6-aae7-27e5e7efbb51",
                                                "required": [
                                                    "UnstructuredAddressLine"
                                                ]
                                            }
                                        },
                                        "primaryKey": false,
                                        "type": "object",
                                        "GUID": "b3cb7bcc-e31e-11e6-aae7-27e5e7efbb51",
                                        "additionalProperties": false
                                    }
                                ],
                                "required": [
                                    "@id"
                                ]
                            }
                        }
                    },
                    "primaryKey": false,
                    "type": "object",
                    "GUID": "b3cb54b1-e31e-11e6-aae7-27e5e7efbb51",
                    "required": [
                        "AddressToFormat"
                    ]
                },
                "CallerIdentification": {
                    "description": "Information about the caller of the service, in case no authentication mechanism exists. ",
                    "properties": {
                        "CallerName": {
                            "primaryKey": false,
                            "type": "string",
                            "GUID": "b3cb7bd6-e31e-11e6-aae7-27e5e7efbb51",
                            "sample": "ZALANDO"
                        }
                    },
                    "primaryKey": false,
                    "type": "object",
                    "GUID": "b3cb7bd5-e31e-11e6-aae7-27e5e7efbb51",
                    "required": [
                        "CallerName"
                    ]
                }
            },
            "primaryKey": false,
            "type": "object",
            "GUID": "b3cb54b0-e31e-11e6-aae7-27e5e7efbb51",
            "required": [
                "AddressToFormatList"
            ]
        }
    },
    "type": "object",
    "required": [
        "FormatAddressesRequest"
    ],
    "resources": "/ws/ExternalMailingAddressProofingCSREST_v1/address/validateAddresses",
    "transaction": "Request"
}
2.1.9 Request JSON data
{
    "FormatAddressesRequest": {
        "AddressToFormatList": {
            "AddressToFormat": [
                {
                    "@id": "1",
                    "MaileeAndAddressee": {
                        "StructuredAddresseeIndividualIdentification": {
                            "AddresseeFormOfAddress": "Mr",
                            "AddresseeGivenName": "Jacques",
                            "AddresseeSurname": "Martin",
                            "AddresseeSupplementaryDispatchInfo": "Lorem"
                        },
                        "StructuredMaileeIndividualIdentification": {
                            "MaileeRole": "Lorem",
                            "MaileeFormOfAddress": "Lorem",
                            "MaileeGivenName": "Lorem",
                            "MaileeSurname": "Lorem"
                        },
                        "StructuredMaileeOrganizationIdentification": {
                            "MaileeOrganizationFunction": "Lorem",
                            "MaileeOrganizationOrganizationalUnit": "Lorem",
                            "MaileeOrganizationOrganizationalName": "Lorem",
                            "MaileeOrganizationLegalStatus": "Lorem"
                        },
                        "StructuredMailRecipientDispatchingInformation": {
                            "Wing": {
                                "WingType": "Lorem",
                                "WingIndicator": "Lorem"
                            },
                            "Stairwell": {
                                "StairwellType": "Lorem",
                                "StairwellIndicator": "Lorem"
                            },
                            "Floor": {
                                "FloorType": "Lorem",
                                "FloorIndicator": "Lorem"
                            },
                            "Door": {
                                "DoorType": "Lorem",
                                "DoorIndicator": "Lorem"
                            },
                            "BuildingConstruction": "Lorem"
                        }
                    },
                    "PostalAddress": {
                        "StructuredOtherDeliveryInformation": {
                            "DeliveryServiceType": "Lorem",
                            "DeliveryServiceIndicator": "Lorem"
                        },
                        "StructuredDeliveryPointLocation": {
                            "StreetName": {
                                "@locale": "fr",
                                "*body": "Rue du Vivier"
                            },
                            "StreetNumber": "64",
                            "BoxNumber": "84"
                        },
                        "StructuredPostalCodeMunicipality": {
                            "PostalCode": "1140",
                            "MunicipalityName": {
                                "@locale": "nl",
                                "*body": "Bruxelles"
                            },
                            "DeliveryServiceQualifier": "Lorem"
                        },
                        "CountryName": {
                            "@locale": "nl",
                            "*body": "BELGIUM"
                        }
                    },
                    "AddressLanguage": "nl",
                    "DispatchingCountryISOCode": "BE",
                    "DeliveringCountryISOCode": "BE"
                }
            ]
        },
        "CallerIdentification": {
            "CallerName": "ZALANDO"
        }
    }
}
2.2 Document Response
2.2.1 Response Tree Diagram
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
GeneralError
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
[0]
type
[...]
Error
type
{ABC}
[0]
type
[...]
Line
type
{...}
Label
type
{ABC}
@id
type
{...}
[0]
type
[...]
FormattedAddressResult
type
{...}
FormattedAddressResultList
type
{...}
FormatAddressesResponse
type
Response
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
GeneralError
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
[0]
type
[...]
Error
type
{ABC}
[0]
type
[...]
Line
type
{...}
Label
type
{ABC}
@id
type
{...}
[0]
type
[...]
FormattedAddressResult
type
{...}
FormattedAddressResultList
type
{...}
FormatAddressesResponse
type
Response
type
2.2.2 Response Properties
PropertyValue
Document name Response
Id
Description
RESTful API true
Transaction Response
Method
EndPoint
Resources
Media type application/JSON
Additional properties true
Comments
2.2.3 Response Fields
FieldTypeReqKeyDescription
FormatAddressesResponsedocumenttrue
FormattedAddressResultListdocumenttrue
FormattedAddressResultarraytrue
[0]documentfalse
@idstringtrue
Labeldocumenttrue
Linearraytrue
[0]stringfalse
Errorarrayfalse
[0]documentfalse
ErrorCodestringtrue
ErrorSeveritystringtrue
GeneralErrordocumentfalse
ErrorCodestringtrue
ErrorSeveritystringtrue
2.2.3.1 Field FormatAddressesResponse
2.2.3.1.1 FormatAddressesResponse Tree Diagram
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
GeneralError
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
[0]
type
[...]
Error
type
{ABC}
[0]
type
[...]
Line
type
{...}
Label
type
{ABC}
@id
type
{...}
[0]
type
[...]
FormattedAddressResult
type
{...}
FormattedAddressResultList
type
FormatAddressesResponse
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
GeneralError
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
[0]
type
[...]
Error
type
{ABC}
[0]
type
[...]
Line
type
{...}
Label
type
{ABC}
@id
type
{...}
[0]
type
[...]
FormattedAddressResult
type
{...}
FormattedAddressResultList
type
FormatAddressesResponse
type
2.2.3.1.2 FormatAddressesResponse Hierarchy
Parent field: Response
Child field(s):
FieldTypeReqKeyDescription
FormattedAddressResultListdocumenttrue
GeneralErrordocumentfalse
FormatAddressesResponse properties
PropertyValue
Name FormatAddressesResponse
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 FormattedAddressResultList
2.2.3.2.1 FormattedAddressResultList Tree Diagram
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
[0]
type
[...]
Error
type
{ABC}
[0]
type
[...]
Line
type
{...}
Label
type
{ABC}
@id
type
{...}
[0]
type
[...]
FormattedAddressResult
type
FormattedAddressResultList
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
[0]
type
[...]
Error
type
{ABC}
[0]
type
[...]
Line
type
{...}
Label
type
{ABC}
@id
type
{...}
[0]
type
[...]
FormattedAddressResult
type
FormattedAddressResultList
type
2.2.3.2.2 FormattedAddressResultList Hierarchy
Parent field: FormatAddressesResponse
Child field(s):
FieldTypeReqKeyDescription
FormattedAddressResultarraytrue
FormattedAddressResultList properties
PropertyValue
Name FormattedAddressResultList
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 FormattedAddressResult
2.2.3.3.1 FormattedAddressResult Tree Diagram
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
[0]
type
[...]
Error
type
{ABC}
[0]
type
[...]
Line
type
{...}
Label
type
{ABC}
@id
type
{...}
[0]*
type
[...]
FormattedAddressResult
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
[0]
type
[...]
Error
type
{ABC}
[0]
type
[...]
Line
type
{...}
Label
type
{ABC}
@id
type
{...}
[0]*
type
[...]
FormattedAddressResult
type
2.2.3.3.2 FormattedAddressResult Hierarchy
Parent field: FormattedAddressResultList
Child field(s):
FieldTypeReqKeyDescription
documentfalse
FormattedAddressResult properties
PropertyValue
Name FormattedAddressResult
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
2.2.3.4.1 [0] Tree Diagram
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
[0]
type
[...]
Error
type
{ABC}
[0]
type
[...]
Line
type
{...}
Label
type
{ABC}
@id
type
[0]
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
[0]
type
[...]
Error
type
{ABC}
[0]
type
[...]
Line
type
{...}
Label
type
{ABC}
@id
type
[0]
type
2.2.3.4.2 [0] Hierarchy
Parent field: FormattedAddressResult
Child field(s):
FieldTypeReqKeyDescription
@idstringtruefk
Labeldocumenttrue
Errorarrayfalse
[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 Label
2.2.3.6.1 Label Tree Diagram
{ABC}
[0]
type
[...]
Line
type
Label
type
{ABC}
[0]
type
[...]
Line
type
Label
type
2.2.3.6.2 Label Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
Linearraytrue
Label properties
PropertyValue
Name Label
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.7 Field Line
2.2.3.7.1 Line Tree Diagram
{ABC}
[0]*
type
[...]
Line
type
{ABC}
[0]*
type
[...]
Line
type
2.2.3.7.2 Line Hierarchy
Parent field: Label
Child field(s):
FieldTypeReqKeyDescription
stringfalse
Line properties
PropertyValue
Name Line
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.8 Field
2.2.3.8.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.9 Field Error
2.2.3.9.1 Error Tree Diagram
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
[0]*
type
[...]
Error
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
{...}
[0]*
type
[...]
Error
type
2.2.3.9.2 Error Hierarchy
Parent field:
Child field(s):
FieldTypeReqKeyDescription
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.10 Field
2.2.3.10.1 [0] Tree Diagram
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
[0]
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
[0]
type
2.2.3.10.2 [0] Hierarchy
Parent field: Error
Child field(s):
FieldTypeReqKeyDescription
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.11 Field ErrorCode
2.2.3.11.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.12 Field ErrorSeverity
2.2.3.12.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.13 Field GeneralError
2.2.3.13.1 GeneralError Tree Diagram
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
GeneralError
type
{ABC}
ErrorSeverity
type
{ABC}
ErrorCode
type
GeneralError
type
2.2.3.13.2 GeneralError Hierarchy
Parent field: FormatAddressesResponse
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.14 Field ErrorCode
2.2.3.14.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.15 Field ErrorSeverity
2.2.3.15.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",
    "isRestfulApi": true,
    "mediaType": "application/JSON",
    "properties": {
        "FormatAddressesResponse": {
            "properties": {
                "FormattedAddressResultList": {
                    "properties": {
                        "FormattedAddressResult": {
                            "primaryKey": false,
                            "additionalItems": true,
                            "type": "array",
                            "GUID": "bbcb3682-e31e-11e6-aae7-27e5e7efbb51",
                            "items": {
                                "properties": {
                                    "@id": {
                                        "primaryKey": false,
                                        "type": "string",
                                        "GUID": "bbcb3684-e31e-11e6-aae7-27e5e7efbb51",
                                        "sample": "1"
                                    },
                                    "Label": {
                                        "properties": {
                                            "Line": {
                                                "primaryKey": false,
                                                "additionalItems": true,
                                                "type": "array",
                                                "GUID": "bbcb3687-e31e-11e6-aae7-27e5e7efbb51",
                                                "items": {
                                                    "primaryKey": false,
                                                    "type": "string",
                                                    "GUID": "bbcb3688-e31e-11e6-aae7-27e5e7efbb51",
                                                    "arrayItem": true,
                                                    "sample": "Mr Jacques Martin Lorem"
                                                }
                                            }
                                        },
                                        "primaryKey": false,
                                        "type": "object",
                                        "GUID": "bbcb3686-e31e-11e6-aae7-27e5e7efbb51",
                                        "required": [
                                            "Line"
                                        ]
                                    },
                                    "Error": {
                                        "primaryKey": false,
                                        "additionalItems": true,
                                        "type": "array",
                                        "GUID": "bbcb3689-e31e-11e6-aae7-27e5e7efbb51",
                                        "items": {
                                            "properties": {
                                                "ErrorCode": {
                                                    "primaryKey": false,
                                                    "type": "string",
                                                    "GUID": "bbcb368b-e31e-11e6-aae7-27e5e7efbb51"
                                                },
                                                "ErrorSeverity": {
                                                    "primaryKey": false,
                                                    "type": "string",
                                                    "GUID": "bbcb368c-e31e-11e6-aae7-27e5e7efbb51",
                                                    "enum": [
                                                        "warning",
                                                        "error"
                                                    ]
                                                }
                                            },
                                            "primaryKey": false,
                                            "type": "object",
                                            "GUID": "bbcb368a-e31e-11e6-aae7-27e5e7efbb51",
                                            "arrayItem": true,
                                            "additionalProperties": true,
                                            "required": [
                                                "ErrorCode",
                                                "ErrorSeverity"
                                            ]
                                        },
                                        "uniqueItems": false
                                    }
                                },
                                "primaryKey": false,
                                "type": "object",
                                "GUID": "bbcb3683-e31e-11e6-aae7-27e5e7efbb51",
                                "arrayItem": true,
                                "required": [
                                    "@id",
                                    "Label"
                                ]
                            },
                            "maxItems": 200,
                            "minItems": 1
                        }
                    },
                    "primaryKey": false,
                    "type": "object",
                    "GUID": "bbcb3681-e31e-11e6-aae7-27e5e7efbb51",
                    "required": [
                        "FormattedAddressResult"
                    ]
                },
                "GeneralError": {
                    "properties": {
                        "ErrorCode": {
                            "primaryKey": false,
                            "type": "string",
                            "GUID": "bbcb368e-e31e-11e6-aae7-27e5e7efbb51"
                        },
                        "ErrorSeverity": {
                            "primaryKey": false,
                            "type": "string",
                            "GUID": "bbcb368f-e31e-11e6-aae7-27e5e7efbb51"
                        }
                    },
                    "primaryKey": false,
                    "type": "object",
                    "GUID": "bbcb368d-e31e-11e6-aae7-27e5e7efbb51",
                    "additionalProperties": true,
                    "required": [
                        "ErrorCode",
                        "ErrorSeverity"
                    ]
                }
            },
            "primaryKey": false,
            "type": "object",
            "GUID": "bbcb3680-e31e-11e6-aae7-27e5e7efbb51",
            "required": [
                "FormattedAddressResultList"
            ]
        }
    },
    "type": "object",
    "additionalProperties": true,
    "required": [
        "FormatAddressesResponse"
    ],
    "transaction": "Response"
}
2.2.9 Response JSON data
{
    "FormatAddressesResponse": {
        "FormattedAddressResultList": {
            "FormattedAddressResult": [
                {
                    "@id": "1",
                    "Label": {
                        "Line": [
                            "Mr Jacques Martin Lorem"
                        ]
                    },
                    "Error": [
                        {
                            "ErrorCode": "Lorem",
                            "ErrorSeverity": "error"
                        }
                    ]
                }
            ]
        },
        "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