Property | Value |
Name | bpostAddressValidationWebservice - External |
Description | |
Author | Pascal |
Version | 1 |
DB Vendor | Plain JSON--no DB |
Comments |
Property | Value |
Document name | Request |
Id | |
Description | Request schema specification for bpost Address Validation webservice |
RESTful API | true |
Transaction | |
Method | |
EndPoint | http://webservices-pub.bpost.be |
Resources | /ws/ExternalMailingAddressProofingCSREST_v1/address/validateAddresses |
Media type | application/JSON |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
AddressToValidateList | document | true | ||
ValidateAddressOptions | document | false | ||
CallerIdentification | document | false | Information about the caller of the service, in case no authentication mechanism exists. |
Property | Value |
Name | ValidateAddressesRequest |
Id | |
Type | document |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
AddressToValidate | array | true |
Property | Value |
Name | AddressToValidateList |
Id | |
Type | document |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
[0] | document | false |
Property | Value |
Name | AddressToValidate |
Id | |
Type | array |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min items | 1 |
Max items | 200 |
Unique items | |
Additional items | true |
Comments |
Field | Type | Req | Key | Description |
@id | string | true | ||
oneOf | choice | false | ||
DispatchingCountryISOCode | string | false | S42 name: Dispatching Country ISO Code, code: 50.53.0.0.0 | |
DeliveringCountryISOCode | string | false | S42 name: Delivering Country ISO Code, code: 50.54.0.0.0. This field determines which S42 template will be chosen. |
Property | Value |
Name | |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
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 |
Field | Type | Req | Key | Description |
[0] | subschema | false | Addresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components. This branch of the choice describes the address components. Each address is divided in logical groups, for example the 'delivery point location' group (typically used to store the street name and house number). Each logical group can itself be submitted in a structured manner (prefered method) identifying each individual field: one for the street name, one for the house number, and possibly one for the mailbox number. Or it can be submitted in one one unstructured field. While in any individual group, you cannot submit a mix of structured and unstructured fields, you are allowed to make the choice of structured or unstructured for any group, and mix the mode between groups. In other words, you could submit the group 'delivery point location' in an unstructured mode, and submit the 'postal code municipality' group in a structured mode. Address recognition will be better if fully structured addresses are submitted. | |
[1] | subschema | false | 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. |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
MaileeAndAddressee | document | false | This section is optional, but recommended. At least the Addressee Individual Identification group. | |
PostalAddress | document | true | This section is mandatory, and needs to include at least the Postal Code Municipality group, plus typically the Delivery Point Location group (with a stree tname and house number), or alternatively the Other Delivery Information group (for a PO Box). |
Property | Value |
Id | |
Description | Addresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components. This branch of the choice describes the address components. Each address is divided in logical groups, for example the 'delivery point location' group (typically used to store the street name and house number). Each logical group can itself be submitted in a structured manner (prefered method) identifying each individual field: one for the street name, one for the house number, and possibly one for the mailbox number. Or it can be submitted in one one unstructured field. While in any individual group, you cannot submit a mix of structured and unstructured fields, you are allowed to make the choice of structured or unstructured for any group, and mix the mode between groups. In other words, you could submit the group 'delivery point location' in an unstructured mode, and submit the 'postal code municipality' group in a structured mode. Address recognition will be better if fully structured addresses are submitted. |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
AddresseeIndividualIdentification | document | false | ||
MaileeIndividualIdentification | document | false | ||
MaileeOrganizationIdentification | document | false | ||
MailRecipientDispatchingInformation | document | false |
Property | Value |
Name | MaileeAndAddressee |
Id | |
Type | document |
Description | This section is optional, but recommended. At least the Addressee Individual Identification group. |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
oneOf | choice | false |
Property | Value |
Name | AddresseeIndividualIdentification |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments | Mandatory if addressed mail |
Field | Type | Req | Key | Description |
[0] | subschema | false | ||
[1] | subschema | false |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
StructuredAddresseeIndividualIdentification | document | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
AddresseeFormOfAddress | string | false | ||
AddresseeGivenName | string | false | ||
AddresseeSurname | string | false | ||
AddresseeSupplementaryDispatchInfo | string | false |
Property | Value |
Name | StructuredAddresseeIndividualIdentification |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
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 |
Property | Value |
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 |
Property | Value |
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 |
Property | Value |
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 |
Field | Type | Req | Key | Description |
UnstructuredAddresseeIndividualIdentification | string | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | UnstructuredAddresseeIndividualIdentification |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | Mr François Hollande |
Comments |
Field | Type | Req | Key | Description |
oneOf | choice | false |
Property | Value |
Name | MaileeIndividualIdentification |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
[0] | subschema | false | ||
[1] | subschema | false |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
StructuredMaileeIndividualIdentification | document | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
MaileeRole | string | false | ||
MaileeFormOfAddress | string | false | ||
MaileeGivenName | string | false | ||
MaileeSurname | string | false |
Property | Value |
Name | StructuredMaileeIndividualIdentification |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
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 |
Property | Value |
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 |
Property | Value |
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 |
Property | Value |
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 |
Field | Type | Req | Key | Description |
UnstructuredMaileeIndividualIdentification | string | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | UnstructuredMaileeIndividualIdentification |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | A la soeur de |
Comments |
Field | Type | Req | Key | Description |
oneOf | choice | false |
Property | Value |
Name | MaileeOrganizationIdentification |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
[0] | subschema | false | ||
[1] | subschema | false |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
StructuredMaileeOrganizationIdentification | document | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
MaileeOrganizationFunction | string | false | ||
MaileeOrganizationOrganizationalUnit | string | false | ||
MaileeOrganizationOrganizationalName | string | false | ||
MaileeOrganizationLegalStatus | string | false |
Property | Value |
Name | StructuredMaileeOrganizationIdentification |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
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 |
Property | Value |
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 |
Property | Value |
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 |
Property | Value |
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 |
Field | Type | Req | Key | Description |
UnstructuredMaileeOrganizationIdentification | string | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | UnstructuredMaileeOrganizationIdentification |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | GHE Consulting SCS |
Comments |
Field | Type | Req | Key | Description |
oneOf | choice | false |
Property | Value |
Name | MailRecipientDispatchingInformation |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments | Optional, but preferable for Registered mail and Parcels |
Field | Type | Req | Key | Description |
[0] | subschema | false | ||
[1] | subschema | false |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
StructuredMailRecipientDispatchingInformation | document | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
Wing | document | false | Element identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed. | |
Stairwell | document | false | Element indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west. | |
Floor | document | false | Element indicating the floor or level on which a delivery point is located in a multi-story construction. | |
Door | document | false | 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. | |
BuildingConstruction | string | false | 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, ... |
Property | Value |
Name | StructuredMailRecipientDispatchingInformation |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
WingType | string | false | S42 name: Wing Type, code: 30.29.0.0.1 | |
WingIndicator | string | false | S42 name: Wing Indicator, code: 30.29.0.0.2 |
Property | Value |
Name | Wing |
Id | |
Type | document |
Description | Element identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed. |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | WingType |
Id | |
Type | string |
Description | S42 name: Wing Type, code: 30.29.0.0.1 |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | WingIndicator |
Id | |
Type | string |
Description | S42 name: Wing Indicator, code: 30.29.0.0.2 |
Dependencies | 5f2d0e20-df1e-11e6-a3dd-6de9a4b3cd36 |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
StairwellType | string | false | S42 name: Stairwell Type, code: 30.30.0.0.1 | |
StairwellIndicator | string | false | S42 name: Stairwell Indicator, code: 30.30.0.0.2 |
Property | Value |
Name | Stairwell |
Id | |
Type | document |
Description | Element indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west. |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | StairwellType |
Id | |
Type | string |
Description | S42 name: Stairwell Type, code: 30.30.0.0.1 |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | StairwellIndicator |
Id | |
Type | string |
Description | S42 name: Stairwell Indicator, code: 30.30.0.0.2 |
Dependencies | b508bb00-df1e-11e6-a3dd-6de9a4b3cd36 |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
FloorType | string | false | S42 name: Floor Type, code: 30.31.0.0.1 | |
FloorIndicator | string | false | S42 name: Floor Indicator, code: 30.31.0.0.2 |
Property | Value |
Name | Floor |
Id | |
Type | document |
Description | Element indicating the floor or level on which a delivery point is located in a multi-story construction. |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | FloorType |
Id | |
Type | string |
Description | S42 name: Floor Type, code: 30.31.0.0.1 |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FloorIndicator |
Id | |
Type | string |
Description | S42 name: Floor Indicator, code: 30.31.0.0.2 |
Dependencies | 01a99510-df1f-11e6-a3dd-6de9a4b3cd36 |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
DoorType | string | false | S42 name: Door Type, code: 30.32.0.0.1 | |
DoorIndicator | string | false | S42 name: Door Indicator, code: 30.32.0.0.2 |
Property | Value |
Name | Door |
Id | |
Type | document |
Description | Address Element indicating the apartment, room or office in, at or adjacent to which a delivery point which is situated within a building is located. |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | DoorType |
Id | |
Type | string |
Description | S42 name: Door Type, code: 30.32.0.0.1 |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DoorIndicator |
Id | |
Type | string |
Description | S42 name: Door Indicator, code: 30.32.0.0.2 |
Dependencies | 3c71a5c0-df1f-11e6-a3dd-6de9a4b3cd36 |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
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 |
Field | Type | Req | Key | Description |
UnstructuredMailRecipientDispatchingInformation | string | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | UnstructuredMailRecipientDispatchingInformation |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
OtherDeliveryInformation | document | false | PO Box Number or bpack 24/7 name | |
DeliveryPointLocation | document | false | ||
PostalCodeMunicipality | document | true | ||
CountryName | string | false | S42 name: Country, code: 40.14.0.0.0 - Only for cross-border mail |
Property | Value |
Name | PostalAddress |
Id | |
Type | document |
Description | This section is mandatory, and needs to include at least the Postal Code Municipality group, plus typically the Delivery Point Location group (with a stree tname and house number), or alternatively the Other Delivery Information group (for a PO Box). |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
oneOf | choice | false |
Property | Value |
Name | OtherDeliveryInformation |
Id | |
Type | document |
Description | PO Box Number or bpack 24/7 name |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
[0] | subschema | false | ||
[1] | subschema | false |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
StructuredOtherDeliveryInformation | document | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
DeliveryServiceType | string | false | ||
DeliveryServiceIndicator | string | false |
Property | Value |
Name | StructuredOtherDeliveryInformation |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
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 |
Property | Value |
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 |
Field | Type | Req | Key | Description |
UnstructuredOtherDeliveryInformation | string | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | UnstructuredOtherDeliveryInformation |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
oneOf | choice | false |
Property | Value |
Name | DeliveryPointLocation |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
[0] | subschema | false | ||
[1] | subschema | false |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
StructuredDeliveryPointLocation | document | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
StreetName | string | false | ||
StreetNumber | string | false | ||
BoxNumber | string | false |
Property | Value |
Name | StructuredDeliveryPointLocation |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | StreetName |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | Rue Edouard dekoster |
Comments |
Property | Value |
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 |
Property | Value |
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 |
Field | Type | Req | Key | Description |
UnstructuredDeliveryPointLocation | string | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | UnstructuredDeliveryPointLocation |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
oneOf | choice | false |
Property | Value |
Name | PostalCodeMunicipality |
Id | |
Type | document |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
[0] | subschema | false | ||
[1] | subschema | false |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
StructuredPostalCodeMunicipality | document | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
PostalCode | string | true | Municipality postal code | |
MunicipalityName | string | true | ||
DeliveryServiceQualifier | string | false | In case of a PO Box, this field is used to designate the bpost retail office where the box is located. It is used to differentiate the retail office in case of multiple offices per municipality. |
Property | Value |
Name | StructuredPostalCodeMunicipality |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | PostalCode |
Id | |
Type | string |
Description | Municipality postal code |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | 4 |
Max length | 4 |
Pattern | |
Format | |
Enum | |
Sample | 1140 |
Comments |
Property | Value |
Name | MunicipalityName |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | Bruxelles |
Comments |
Property | Value |
Name | DeliveryServiceQualifier |
Id | |
Type | string |
Description | In case of a PO Box, this field is used to designate the bpost retail office where the box is located. It is used to differentiate the retail office in case of multiple offices per municipality. |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
UnstructuredPostalCodeMunicipality | string | false |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | UnstructuredPostalCodeMunicipality |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | 70035 Paris |
Comments |
Property | Value |
Name | CountryName |
Id | |
Type | string |
Description | S42 name: Country, code: 40.14.0.0.0 - Only for cross-border mail |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | Belgique |
Comments |
Field | Type | Req | Key | Description |
AddressBlockLines | document | false |
Property | Value |
Id | |
Description | Addresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components. This branch of the choice describes the address block lines. This is not the prefered method for address recognition, but it is permitted. bpost's algorithms will attempt to parse the submitted lines and identify the different elements so they can be mapped to the standard structure of an address. |
Required | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
UnstructuredAddressLine | array | true |
Property | Value |
Name | AddressBlockLines |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
[0] | document | false |
Property | Value |
Name | UnstructuredAddressLine |
Id | |
Type | array |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min items | 1 |
Max items | 7 |
Unique items | |
Additional items | true |
Comments |
Field | Type | Req | Key | Description |
*body | string | true |
Property | Value |
Name | |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
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 |
Property | Value |
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 |
Property | Value |
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 |
Field | Type | Req | Key | Description |
IncludeFormatting | boolean | false | This option returns the formatted label for each validated address (or address alternative or address suggestion). Default = true. | |
IncludeSuggestions | boolean | false | This option returns suggestions (if there are any) for a validation request. Default = true. | |
IncludeSubmittedAddress | boolean | false | ||
IncludeDefaultGeoLocation | boolean | false | S42 name: Include Default GeoLocation: Default. GeoLocation is the set of coordinates that better matches the standard bpost consumer need, in terms of geodesic system (WGS84), high reliability, perspective type (highest priority given to OSM projections), type of coordinates (DEGDEC). This set of coordinates can be used to load a GPS, call a Google service to visualize the point on a card, … . Default = false. | |
IncludeListOfBoxes | boolean | false | This option, returns the list of normal mailboxes for the requested address. | |
IncludeNumberOfBoxes | boolean | false | This option, returns the number of normal mailboxes for the requested address. |
Property | Value |
Name | ValidateAddressOptions |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | IncludeFormatting |
Id | |
Type | boolean |
Description | This option returns the formatted label for each validated address (or address alternative or address suggestion). Default = true. |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Sample | true |
Comments |
Property | Value |
Name | IncludeSuggestions |
Id | |
Type | boolean |
Description | This option returns suggestions (if there are any) for a validation request. Default = true. |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Sample | true |
Comments |
Property | Value |
Name | IncludeSubmittedAddress |
Id | |
Type | boolean |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Sample | true |
Comments |
Property | Value |
Name | IncludeDefaultGeoLocation |
Id | |
Type | boolean |
Description | S42 name: Include Default GeoLocation: Default. GeoLocation is the set of coordinates that better matches the standard bpost consumer need, in terms of geodesic system (WGS84), high reliability, perspective type (highest priority given to OSM projections), type of coordinates (DEGDEC). This set of coordinates can be used to load a GPS, call a Google service to visualize the point on a card, … . Default = false. |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | IncludeListOfBoxes |
Id | |
Type | boolean |
Description | This option, returns the list of normal mailboxes for the requested address. |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | IncludeNumberOfBoxes |
Id | |
Type | boolean |
Description | This option, returns the number of normal mailboxes for the requested address. |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
CallerName | string | true |
Property | Value |
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 |
Property | Value |
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 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "Request", "description": "Request schema specification for bpost Address Validation webservice", "additionalProperties": true, "endPoint": "http://webservices-pub.bpost.be", "isRestfulApi": true, "mediaType": "application/JSON", "properties": { "ValidateAddressesRequest": { "properties": { "AddressToValidateList": { "properties": { "AddressToValidate": { "primaryKey": false, "additionalItems": true, "maxItems": 200, "minItems": 1, "type": "array", "GUID": "187d9863-de46-11e6-a3dd-6de9a4b3cd36", "items": { "additionalProperties": true, "properties": { "@id": { "primaryKey": false, "type": "string", "GUID": "187d9865-de46-11e6-a3dd-6de9a4b3cd36", "sample": "1" }, "DispatchingCountryISOCode": { "description": "S42 name: Dispatching Country ISO Code, code: 50.53.0.0.0", "primaryKey": false, "type": "string", "GUID": "187d9867-de46-11e6-a3dd-6de9a4b3cd36", "sample": "BE" }, "DeliveringCountryISOCode": { "description": "S42 name: Delivering Country ISO Code, code: 50.54.0.0.0. This field determines which S42 template will be chosen.", "primaryKey": false, "type": "string", "GUID": "187d9866-de46-11e6-a3dd-6de9a4b3cd36", "sample": "BE" } }, "primaryKey": false, "type": "object", "GUID": "187d9864-de46-11e6-a3dd-6de9a4b3cd36", "arrayItem": true, "oneOf": [ { "description": "Addresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components.\n\nThis branch of the choice describes the address components. Each address is divided in logical groups, for example the 'delivery point location' group (typically used to store the street name and house number). Each logical group can itself be submitted in a structured manner (prefered method) identifying each individual field: one for the street name, one for the house number, and possibly one for the mailbox number. Or it can be submitted in one one unstructured field.\n\nWhile in any individual group, you cannot submit a mix of structured and unstructured fields, you are allowed to make the choice of structured or unstructured for any group, and mix the mode between groups. In other words, you could submit the group 'delivery point location' in an unstructured mode, and submit the 'postal code municipality' group in a structured mode.\n\nAddress recognition will be better if fully structured addresses are submitted.", "properties": { "MaileeAndAddressee": { "description": "This section is optional, but recommended. At least the Addressee Individual Identification group.", "properties": { "AddresseeIndividualIdentification": { "additionalProperties": true, "primaryKey": false, "type": "object", "GUID": "b1e19491-ded5-11e6-a3dd-6de9a4b3cd36", "oneOf": [ { "properties": { "StructuredAddresseeIndividualIdentification": { "properties": { "AddresseeFormOfAddress": { "primaryKey": false, "type": "string", "GUID": "99e29c51-dede-11e6-a3dd-6de9a4b3cd36", "sample": "Mr" }, "AddresseeGivenName": { "primaryKey": false, "type": "string", "GUID": "99e29c52-dede-11e6-a3dd-6de9a4b3cd36", "sample": "Jacques" }, "AddresseeSurname": { "primaryKey": false, "type": "string", "GUID": "99e29c53-dede-11e6-a3dd-6de9a4b3cd36", "sample": "Martin" }, "AddresseeSupplementaryDispatchInfo": { "primaryKey": false, "type": "string", "GUID": "25ae89e0-df1d-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "99e29c50-dede-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "6b670b40-dede-11e6-a3dd-6de9a4b3cd36" }, { "additionalProperties": true, "properties": { "UnstructuredAddresseeIndividualIdentification": { "primaryKey": false, "type": "string", "GUID": "821c7d70-dede-11e6-a3dd-6de9a4b3cd36", "sample": "Mr François Hollande" } }, "primaryKey": false, "type": "object", "GUID": "762ebfa0-dede-11e6-a3dd-6de9a4b3cd36" } ], "comments": "Mandatory if addressed mail" }, "MaileeIndividualIdentification": { "additionalProperties": true, "primaryKey": false, "type": "object", "GUID": "b1e19496-ded5-11e6-a3dd-6de9a4b3cd36", "oneOf": [ { "properties": { "StructuredMaileeIndividualIdentification": { "additionalProperties": true, "properties": { "MaileeRole": { "primaryKey": false, "type": "string", "GUID": "453ba040-df1d-11e6-a3dd-6de9a4b3cd36" }, "MaileeFormOfAddress": { "primaryKey": false, "type": "string", "GUID": "492d73e0-df1d-11e6-a3dd-6de9a4b3cd36" }, "MaileeGivenName": { "primaryKey": false, "type": "string", "GUID": "5a02aff0-df1d-11e6-a3dd-6de9a4b3cd36" }, "MaileeSurname": { "primaryKey": false, "type": "string", "GUID": "61894310-df1d-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "933d6120-dee1-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "5b9937a0-dedf-11e6-a3dd-6de9a4b3cd36" }, { "additionalProperties": true, "properties": { "UnstructuredMaileeIndividualIdentification": { "primaryKey": false, "type": "string", "GUID": "658447a0-dedf-11e6-a3dd-6de9a4b3cd36", "sample": "A la soeur de" } }, "primaryKey": false, "type": "object", "GUID": "5f2b8620-dedf-11e6-a3dd-6de9a4b3cd36" } ] }, "MaileeOrganizationIdentification": { "additionalProperties": true, "primaryKey": false, "type": "object", "GUID": "b1e19498-ded5-11e6-a3dd-6de9a4b3cd36", "oneOf": [ { "properties": { "StructuredMaileeOrganizationIdentification": { "additionalProperties": true, "properties": { "MaileeOrganizationFunction": { "primaryKey": false, "type": "string", "GUID": "b139f530-df1d-11e6-a3dd-6de9a4b3cd36" }, "MaileeOrganizationOrganizationalUnit": { "primaryKey": false, "type": "string", "GUID": "b85cbd70-df1d-11e6-a3dd-6de9a4b3cd36" }, "MaileeOrganizationOrganizationalName": { "primaryKey": false, "type": "string", "GUID": "bf91d530-df1d-11e6-a3dd-6de9a4b3cd36" }, "MaileeOrganizationLegalStatus": { "primaryKey": false, "type": "string", "GUID": "c9126390-df1d-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "8f134830-df1d-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "9b5fd000-deea-11e6-a3dd-6de9a4b3cd36" }, { "additionalProperties": true, "properties": { "UnstructuredMaileeOrganizationIdentification": { "primaryKey": false, "type": "string", "GUID": "75bd6ac0-dedf-11e6-a3dd-6de9a4b3cd36", "sample": "GHE Consulting SCS" } }, "primaryKey": false, "type": "object", "GUID": "701dc010-dedf-11e6-a3dd-6de9a4b3cd36" } ] }, "MailRecipientDispatchingInformation": { "additionalProperties": true, "primaryKey": false, "type": "object", "GUID": "e6071bd0-df1d-11e6-a3dd-6de9a4b3cd36", "oneOf": [ { "properties": { "StructuredMailRecipientDispatchingInformation": { "additionalProperties": true, "properties": { "Wing": { "description": "Element identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed.", "additionalProperties": true, "properties": { "WingType": { "description": "S42 name: Wing Type, code: 30.29.0.0.1", "primaryKey": false, "type": "string", "GUID": "5f2d0e20-df1e-11e6-a3dd-6de9a4b3cd36" }, "WingIndicator": { "description": "S42 name: Wing Indicator, code: 30.29.0.0.2", "primaryKey": false, "type": "string", "GUID": "8e917890-df1e-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "2db09920-df1e-11e6-a3dd-6de9a4b3cd36", "dependencies": { "WingIndicator": [ "WingType" ] } }, "Stairwell": { "description": "Element indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west.", "additionalProperties": true, "properties": { "StairwellType": { "description": "S42 name: Stairwell Type, code: 30.30.0.0.1", "primaryKey": false, "type": "string", "GUID": "b508bb00-df1e-11e6-a3dd-6de9a4b3cd36" }, "StairwellIndicator": { "description": "S42 name: Stairwell Indicator, code: 30.30.0.0.2", "primaryKey": false, "type": "string", "GUID": "ce18e610-df1e-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "a9319270-df1e-11e6-a3dd-6de9a4b3cd36", "dependencies": { "StairwellIndicator": [ "StairwellType" ] } }, "Floor": { "description": "Element indicating the floor or level on which a delivery point is located in a multi-story construction.", "additionalProperties": true, "properties": { "FloorType": { "description": "S42 name: Floor Type, code: 30.31.0.0.1", "primaryKey": false, "type": "string", "GUID": "01a99510-df1f-11e6-a3dd-6de9a4b3cd36" }, "FloorIndicator": { "description": "S42 name: Floor Indicator, code: 30.31.0.0.2", "primaryKey": false, "type": "string", "GUID": "16c83aa0-df1f-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "f36a4620-df1e-11e6-a3dd-6de9a4b3cd36", "dependencies": { "FloorIndicator": [ "FloorType" ] } }, "Door": { "description": "Address Element indicating the apartment, room or office in, at or adjacent to which a delivery point which is situated within a building is located.", "additionalProperties": true, "properties": { "DoorType": { "description": "S42 name: Door Type, code: 30.32.0.0.1", "primaryKey": false, "type": "string", "GUID": "3c71a5c0-df1f-11e6-a3dd-6de9a4b3cd36" }, "DoorIndicator": { "description": "S42 name: Door Indicator, code: 30.32.0.0.2", "primaryKey": false, "type": "string", "GUID": "4e715810-df1f-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "30b09d40-df1f-11e6-a3dd-6de9a4b3cd36", "dependencies": { "DoorIndicator": [ "DoorType" ] } }, "BuildingConstruction": { "description": "S42 name: Building/Construction Level 1, code: 30.26.1.0.0, Element identifying the \"number\" or \"name and type\" of the building, unit or construction in or adjacent to which a delivery point is located. E.g. Batiment A, Block 7, Houseboat, London Tower, ...", "primaryKey": false, "type": "string", "GUID": "587a7760-df1f-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "10db28b0-df1e-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "01acbed0-df1e-11e6-a3dd-6de9a4b3cd36" }, { "additionalProperties": true, "properties": { "UnstructuredMailRecipientDispatchingInformation": { "primaryKey": false, "type": "string", "GUID": "20693ec0-df1e-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "0c4ee9d0-df1e-11e6-a3dd-6de9a4b3cd36" } ], "comments": "Optional, but preferable for Registered mail and Parcels" } }, "primaryKey": false, "type": "object", "GUID": "b1e19490-ded5-11e6-a3dd-6de9a4b3cd36" }, "PostalAddress": { "description": "This section is mandatory, and needs to include at least the Postal Code Municipality group, plus typically the Delivery Point Location group (with a stree tname and house number), or alternatively the Other Delivery Information group (for a PO Box).", "properties": { "OtherDeliveryInformation": { "description": "PO Box Number or bpack 24/7 name", "additionalProperties": true, "primaryKey": false, "type": "object", "GUID": "a77287e0-df1f-11e6-a3dd-6de9a4b3cd36", "oneOf": [ { "properties": { "StructuredOtherDeliveryInformation": { "additionalProperties": true, "properties": { "DeliveryServiceType": { "primaryKey": false, "type": "string", "GUID": "04d934b0-df20-11e6-a3dd-6de9a4b3cd36" }, "DeliveryServiceIndicator": { "primaryKey": false, "type": "string", "GUID": "10dd87c0-df20-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "f3578c00-df1f-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "d6e5bf60-df1f-11e6-a3dd-6de9a4b3cd36" }, { "additionalProperties": true, "properties": { "UnstructuredOtherDeliveryInformation": { "primaryKey": false, "type": "string", "GUID": "ec7e28d0-df1f-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "db543d10-df1f-11e6-a3dd-6de9a4b3cd36" } ] }, "DeliveryPointLocation": { "additionalProperties": true, "primaryKey": false, "type": "object", "GUID": "b87b0891-ded5-11e6-a3dd-6de9a4b3cd36", "oneOf": [ { "properties": { "StructuredDeliveryPointLocation": { "properties": { "StreetName": { "primaryKey": false, "type": "string", "GUID": "75dfd4f0-dee1-11e6-a3dd-6de9a4b3cd36", "sample": "Rue Edouard dekoster" }, "StreetNumber": { "primaryKey": false, "type": "string", "GUID": "75dfd4f1-dee1-11e6-a3dd-6de9a4b3cd36", "sample": "64" }, "BoxNumber": { "primaryKey": false, "type": "string", "GUID": "75dfd4f2-dee1-11e6-a3dd-6de9a4b3cd36", "sample": "84" } }, "primaryKey": false, "type": "object", "GUID": "75dfade0-dee1-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "66e23f10-dee1-11e6-a3dd-6de9a4b3cd36" }, { "additionalProperties": true, "properties": { "UnstructuredDeliveryPointLocation": { "primaryKey": false, "type": "string", "GUID": "287088b0-df20-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "6c215330-dee1-11e6-a3dd-6de9a4b3cd36" } ] }, "PostalCodeMunicipality": { "additionalProperties": true, "primaryKey": false, "type": "object", "GUID": "b87b0896-ded5-11e6-a3dd-6de9a4b3cd36", "oneOf": [ { "properties": { "StructuredPostalCodeMunicipality": { "properties": { "PostalCode": { "description": "Municipality postal code", "primaryKey": false, "type": "string", "GUID": "e3595f91-dede-11e6-a3dd-6de9a4b3cd36", "sample": "1140", "maxLength": 4, "minLength": 4 }, "MunicipalityName": { "primaryKey": false, "type": "string", "GUID": "e3595f92-dede-11e6-a3dd-6de9a4b3cd36", "sample": "Bruxelles" }, "DeliveryServiceQualifier": { "description": "In case of a PO Box, this field is used to designate the bpost retail office where the box is located. It is used to differentiate the retail office in case of multiple offices per municipality.", "primaryKey": false, "type": "string", "GUID": "5470b980-df20-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "e3595f90-dede-11e6-a3dd-6de9a4b3cd36", "required": [ "PostalCode", "MunicipalityName" ] } }, "primaryKey": false, "type": "object", "GUID": "d6a2d380-dede-11e6-a3dd-6de9a4b3cd36" }, { "additionalProperties": true, "properties": { "UnstructuredPostalCodeMunicipality": { "primaryKey": false, "type": "string", "GUID": "ed7ae8e0-dede-11e6-a3dd-6de9a4b3cd36", "sample": "70035 Paris" } }, "primaryKey": false, "type": "object", "GUID": "dad16200-dede-11e6-a3dd-6de9a4b3cd36" } ] }, "CountryName": { "description": "S42 name: Country, code: 40.14.0.0.0 - Only for cross-border mail", "primaryKey": false, "type": "string", "GUID": "b87b089a-ded5-11e6-a3dd-6de9a4b3cd36", "sample": "Belgique" } }, "primaryKey": false, "type": "object", "GUID": "b87b0890-ded5-11e6-a3dd-6de9a4b3cd36", "required": [ "PostalCodeMunicipality" ] } }, "primaryKey": false, "type": "object", "GUID": "a85a4f70-ded5-11e6-a3dd-6de9a4b3cd36", "required": [ "PostalAddress" ] }, { "description": "Addresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components.\n\nThis branch of the choice describes the address block lines. This is not the prefered method for address recognition, but it is permitted. bpost's algorithms will attempt to parse the submitted lines and identify the different elements so they can be mapped to the standard structure of an address.", "additionalProperties": true, "properties": { "AddressBlockLines": { "properties": { "UnstructuredAddressLine": { "primaryKey": false, "additionalItems": true, "maxItems": 7, "minItems": 1, "type": "array", "GUID": "953cf821-ded5-11e6-a3dd-6de9a4b3cd36", "items": { "properties": { "*body": { "primaryKey": false, "type": "string", "GUID": "953cf823-ded5-11e6-a3dd-6de9a4b3cd36", "sample": "1150 Bruxelles" } }, "primaryKey": false, "type": "object", "GUID": "953cf822-ded5-11e6-a3dd-6de9a4b3cd36", "arrayItem": true, "required": [ "*body" ] } } }, "primaryKey": false, "type": "object", "GUID": "953cf820-ded5-11e6-a3dd-6de9a4b3cd36", "required": [ "UnstructuredAddressLine" ] } }, "primaryKey": false, "type": "object", "GUID": "8b244870-ded5-11e6-a3dd-6de9a4b3cd36" } ], "required": [ "@id" ] } } }, "primaryKey": false, "type": "object", "GUID": "187d9862-de46-11e6-a3dd-6de9a4b3cd36", "required": [ "AddressToValidate" ] }, "ValidateAddressOptions": { "properties": { "IncludeFormatting": { "description": "This option returns the formatted label for each validated address (or address alternative or address suggestion). Default = true.", "primaryKey": false, "type": "boolean", "GUID": "187d987e-de46-11e6-a3dd-6de9a4b3cd36", "sample": true }, "IncludeSuggestions": { "description": "This option returns suggestions (if there are any) for a validation request. Default = true.", "primaryKey": false, "type": "boolean", "GUID": "187d987f-de46-11e6-a3dd-6de9a4b3cd36", "sample": true }, "IncludeSubmittedAddress": { "primaryKey": false, "type": "boolean", "GUID": "187d9880-de46-11e6-a3dd-6de9a4b3cd36", "sample": true }, "IncludeDefaultGeoLocation": { "description": "S42 name: Include Default GeoLocation: Default.\n\nGeoLocation is the set of coordinates that better matches the standard bpost consumer need, in terms of geodesic system (WGS84), \thigh reliability, perspective type (highest priority given to OSM \t\t\t\tprojections), type of coordinates (DEGDEC). This set of coordinates \tcan be used to load a GPS, call a Google service to visualize the point on a card, … . \n\nDefault = false.", "primaryKey": false, "type": "boolean", "GUID": "54b51fb0-e148-11e6-898f-b7d201a89248" }, "IncludeListOfBoxes": { "description": "This option, returns the list of normal mailboxes for the requested address.", "primaryKey": false, "type": "boolean", "GUID": "b5fc3b00-e148-11e6-898f-b7d201a89248" }, "IncludeNumberOfBoxes": { "description": "This option, returns the number of normal mailboxes for the requested address.", "primaryKey": false, "type": "boolean", "GUID": "a83a3cf0-e149-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "187d987d-de46-11e6-a3dd-6de9a4b3cd36" }, "CallerIdentification": { "description": "Information about the caller of the service, in case no authentication mechanism exists. ", "properties": { "CallerName": { "primaryKey": false, "type": "string", "GUID": "187d9882-de46-11e6-a3dd-6de9a4b3cd36", "sample": "ZALANDO" } }, "primaryKey": false, "type": "object", "GUID": "187d9881-de46-11e6-a3dd-6de9a4b3cd36", "required": [ "CallerName" ] } }, "primaryKey": false, "type": "object", "GUID": "187d9861-de46-11e6-a3dd-6de9a4b3cd36", "required": [ "AddressToValidateList" ] } }, "type": "object", "required": [ "ValidateAddressesRequest" ], "resources": "/ws/ExternalMailingAddressProofingCSREST_v1/address/validateAddresses" }
{ "ValidateAddressesRequest": { "AddressToValidateList": { "AddressToValidate": [ { "@id": "1", "MaileeAndAddressee": { "AddresseeIndividualIdentification": { "StructuredAddresseeIndividualIdentification": { "AddresseeFormOfAddress": "Mr", "AddresseeGivenName": "Jacques", "AddresseeSurname": "Martin", "AddresseeSupplementaryDispatchInfo": "Lorem" } }, "MaileeIndividualIdentification": { "StructuredMaileeIndividualIdentification": { "MaileeRole": "Lorem", "MaileeFormOfAddress": "Lorem", "MaileeGivenName": "Lorem", "MaileeSurname": "Lorem" } }, "MaileeOrganizationIdentification": { "StructuredMaileeOrganizationIdentification": { "MaileeOrganizationFunction": "Lorem", "MaileeOrganizationOrganizationalUnit": "Lorem", "MaileeOrganizationOrganizationalName": "Lorem", "MaileeOrganizationLegalStatus": "Lorem" } }, "MailRecipientDispatchingInformation": { "StructuredMailRecipientDispatchingInformation": { "Wing": { "WingType": "Lorem", "WingIndicator": "Lorem" }, "Stairwell": { "StairwellType": "Lorem", "StairwellIndicator": "Lorem" }, "Floor": { "FloorType": "Lorem", "FloorIndicator": "Lorem" }, "Door": { "DoorType": "Lorem", "DoorIndicator": "Lorem" }, "BuildingConstruction": "Lorem" } } }, "PostalAddress": { "OtherDeliveryInformation": { "StructuredOtherDeliveryInformation": { "DeliveryServiceType": "Lorem", "DeliveryServiceIndicator": "Lorem" } }, "DeliveryPointLocation": { "StructuredDeliveryPointLocation": { "StreetName": "Rue Edouard dekoster", "StreetNumber": "64", "BoxNumber": "84" } }, "PostalCodeMunicipality": { "StructuredPostalCodeMunicipality": { "PostalCode": "1140", "MunicipalityName": "Bruxelles", "DeliveryServiceQualifier": "Lorem" } }, "CountryName": "Belgique" }, "DispatchingCountryISOCode": "BE", "DeliveringCountryISOCode": "BE" } ] }, "ValidateAddressOptions": { "IncludeFormatting": true, "IncludeSuggestions": true, "IncludeSubmittedAddress": true, "IncludeDefaultGeoLocation": true, "IncludeListOfBoxes": true, "IncludeNumberOfBoxes": true }, "CallerIdentification": { "CallerName": "ZALANDO" } } }
Property | Value |
Document name | Response |
Id | |
Description | Response schema specification for bpost Address Validation webservice |
RESTful API | true |
Transaction | Response |
Method | |
EndPoint | |
Resources | |
Media type | application/JSON |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
ValidatedAddressResultList | document | true | ||
GeneralError | document | false |
Property | Value |
Name | ValidateAddressesResponse |
Id | |
Type | document |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
ValidatedAddressResult | array | true |
Property | Value |
Name | ValidatedAddressResultList |
Id | |
Type | document |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
[0] | document | false |
Property | Value |
Name | ValidatedAddressResult |
Id | |
Type | array |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min items | 1 |
Max items | 200 |
Unique items | |
Additional items | true |
Comments |
Field | Type | Req | Key | Description |
@id | string | true | fk | |
MaileeAndAddressee | document | false | ||
ValidatedAddressList | document | false | ||
Error | array | false | ||
DetectedInputAddressLanguage | string | false | Address language that is detected by the system based on the given address as input. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’. | |
FormattedSubmittedAddress | document | false | ||
TransactionID | string | false | ID which identifies the address validation. Together with the ValidationRequestID, this id defines an address validation uniquely. Used for feedback and acces logging purposes. |
Property | Value |
Name | |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
AddresseeIndividualIdentification | document | false | ||
MaileeIndividualIdentification | document | false | ||
MaileeOrganizationIdentification | document | false | ||
MailRecipientDispatchingInformation | document | false |
Property | Value |
Name | MaileeAndAddressee |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
oneOf | choice | false |
Property | Value |
Name | AddresseeIndividualIdentification |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
subschema | subschema | false | ||
subschema | subschema | false |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
StructuredAddresseeIndividualIdentification | document | true |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
AddresseeFormOfAddress | string | false | ||
AddresseeGivenName | string | false | ||
AddresseeSurname | string | false | ||
AddresseeSupplementaryDispatchInfo | string | false |
Property | Value |
Name | StructuredAddresseeIndividualIdentification |
Id | |
Type | document |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | AddresseeFormOfAddress |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | Mr |
Comments |
Property | Value |
Name | AddresseeGivenName |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | Jacques |
Comments |
Property | Value |
Name | AddresseeSurname |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | Martin |
Comments |
Property | Value |
Name | AddresseeSupplementaryDispatchInfo |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
UnstructuredAddresseeIndividualIdentification | string | true |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | UnstructuredAddresseeIndividualIdentification |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
oneOf | choice | false |
Property | Value |
Name | MaileeIndividualIdentification |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
subschema | subschema | false | ||
subschema | subschema | false |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
StructuredMaileeIndividualIdentification | document | true |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
MaileeRole | string | false | ||
MaileeFormOfAddress | string | false | ||
MaileeGivenName | string | false | ||
MaileeSurname | string | false |
Property | Value |
Name | StructuredMaileeIndividualIdentification |
Id | |
Type | document |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | MaileeRole |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MaileeFormOfAddress |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MaileeGivenName |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MaileeSurname |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
UnstructuredMaileeIndividualIdentification | string | true |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | UnstructuredMaileeIndividualIdentification |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
oneOf | choice | false |
Property | Value |
Name | MaileeOrganizationIdentification |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
subschema | subschema | false | ||
subschema | subschema | false |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
StructuredMaileeOrganizationIdentification | document | true |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
MaileeOrganizationFunction | string | false | ||
MaileeOrganizationOrganizationalUnit | string | false | ||
MaileeOrganizationOrganizationalName | string | false | ||
MaileeOrganizationLegalStatus | string | false |
Property | Value |
Name | StructuredMaileeOrganizationIdentification |
Id | |
Type | document |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | MaileeOrganizationFunction |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MaileeOrganizationOrganizationalUnit |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MaileeOrganizationOrganizationalName |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MaileeOrganizationLegalStatus |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
UnstructuredMaileeOrganizationIdentification | string | true |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | UnstructuredMaileeOrganizationIdentification |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
oneOf | choice | false |
Property | Value |
Name | MailRecipientDispatchingInformation |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
subschema | subschema | false | ||
subschema | subschema | false |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
StructuredMailRecipientDispatchingInformation | document | true |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
Wing | document | false | Element identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed. | |
Stairwell | document | false | Element indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west. | |
Floor | document | false | Element indicating the floor or level on which a delivery point is located in a multi-story construction. | |
Door | document | false | 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. | |
BuildingConstruction | string | false | 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, ... |
Property | Value |
Name | StructuredMailRecipientDispatchingInformation |
Id | |
Type | document |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
WingType | string | false | S42 name: Wing Type, code: 30.29.0.0.1 | |
WingIndicator | string | false | S42 name: Wing Indicator, code: 30.29.0.0.2 |
Property | Value |
Name | Wing |
Id | |
Type | document |
Description | Element identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed. |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | WingType |
Id | |
Type | string |
Description | S42 name: Wing Type, code: 30.29.0.0.1 |
Dependencies | 8e917890-df1e-11e6-a3dd-6de9a4b3cd36 |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | WingIndicator |
Id | |
Type | string |
Description | S42 name: Wing Indicator, code: 30.29.0.0.2 |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
StairwellType | string | false | S42 name: Stairwell Type, code: 30.30.0.0.1 | |
StairwellIndicator | string | false | S42 name: Stairwell Indicator, code: 30.30.0.0.2 |
Property | Value |
Name | Stairwell |
Id | |
Type | document |
Description | Element indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west. |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | StairwellType |
Id | |
Type | string |
Description | S42 name: Stairwell Type, code: 30.30.0.0.1 |
Dependencies | ce18e610-df1e-11e6-a3dd-6de9a4b3cd36 |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | StairwellIndicator |
Id | |
Type | string |
Description | S42 name: Stairwell Indicator, code: 30.30.0.0.2 |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
FloorType | string | false | S42 name: Floor Type, code: 30.31.0.0.1 | |
FloorIndicator | string | false | S42 name: Floor Indicator, code: 30.31.0.0.2 |
Property | Value |
Name | Floor |
Id | |
Type | document |
Description | Element indicating the floor or level on which a delivery point is located in a multi-story construction. |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | FloorType |
Id | |
Type | string |
Description | S42 name: Floor Type, code: 30.31.0.0.1 |
Dependencies | 16c83aa0-df1f-11e6-a3dd-6de9a4b3cd36 |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FloorIndicator |
Id | |
Type | string |
Description | S42 name: Floor Indicator, code: 30.31.0.0.2 |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
DoorType | string | false | S42 name: Door Type, code: 30.32.0.0.1 | |
DoorIndicator | string | false | S42 name: Door Indicator, code: 30.32.0.0.2 |
Property | Value |
Name | Door |
Id | |
Type | document |
Description | Address Element indicating the apartment, room or office in, at or adjacent to which a delivery point which is situated within a building is located. |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | DoorType |
Id | |
Type | string |
Description | S42 name: Door Type, code: 30.32.0.0.1 |
Dependencies | 4e715810-df1f-11e6-a3dd-6de9a4b3cd36 |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DoorIndicator |
Id | |
Type | string |
Description | S42 name: Door Indicator, code: 30.32.0.0.2 |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingConstruction |
Id | |
Type | string |
Description | S42 name: Building/Construction Level 1, code: 30.26.1.0.0, Element identifying the "number" or "name and type" of the building, unit or construction in or adjacent to which a delivery point is located. E.g. Batiment A, Block 7, Houseboat, London Tower, ... |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
UnstructuredMailRecipientDispatchingInformation | string | true |
Property | Value |
Id | |
Description | |
Required | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | UnstructuredMailRecipientDispatchingInformation |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
ValidatedAddress | array | true |
Property | Value |
Name | ValidatedAddressList |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
[0] | document | false |
Property | Value |
Name | ValidatedAddress |
Id | |
Type | array |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min items | |
Max items | |
Unique items | |
Additional items | true |
Comments |
Field | Type | Req | Key | Description |
PostalAddress | document | false | ||
AddressLanguage | string | false | S42 name: Address Parameter Language, code: 50.51.0.0.0. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’. | |
score | integer | false | ||
NumberOfBoxes | integer | false | ||
ServicePointBoxList | document | false | ||
ServicePointDetail | document | false | ||
Label | document | false |
Property | Value |
Name | |
Id | |
Type | document |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
StructuredDeliveryPointLocation | document | true | ||
StructuredPostalCodeMunicipality | document | true | ||
CountryName | string | true |
Property | Value |
Name | PostalAddress |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
StreetName | string | true | ||
StreetNumber | string | true | ||
BoxNumber | string | true |
Property | Value |
Name | StructuredDeliveryPointLocation |
Id | |
Type | document |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Property | Value |
Name | StreetName |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | RUE EDOUARD DEKOSTER |
Comments |
Property | Value |
Name | StreetNumber |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | 64 |
Comments |
Property | Value |
Name | BoxNumber |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | 84 |
Comments |
Field | Type | Req | Key | Description |
PostalCode | string | true | ||
MunicipalityName | string | true |
Property | Value |
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 |
Property | Value |
Name | PostalCode |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | 1140 |
Comments |
Property | Value |
Name | MunicipalityName |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | EVERE |
Comments |
Property | Value |
Name | CountryName |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | BELGIQUE |
Comments |
Property | Value |
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 |
Property | Value |
Name | score |
Id | |
Type | integer |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | false |
Max value | |
Excl max | false |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfBoxes |
Id | |
Type | integer |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | false |
Max value | |
Excl max | false |
Multiple of | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
ServicePointBoxResult | array | false |
Property | Value |
Name | ServicePointBoxList |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
[0] | document | false |
Property | Value |
Name | ServicePointBoxResult |
Id | |
Type | array |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min items | 1 |
Max items | |
Unique items | false |
Additional items | true |
Comments |
Field | Type | Req | Key | Description |
StreetNumber | string | false | ||
BoxNumber | string | false | ||
DeliveryServiceIndicator | string | false | ||
PostalCode | string | false |
Property | Value |
Name | New Field |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | StreetNumber |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BoxNumber |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DeliveryServiceIndicator |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PostalCode |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
GeographicalLocationInfo | document | false |
Property | Value |
Name | ServicePointDetail |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
GeographicalLocation | document | false |
Property | Value |
Name | GeographicalLocationInfo |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
Latitude | document | false | ||
Longitude | document | false | ||
Elevation | document | false |
Property | Value |
Name | GeographicalLocation |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Field | Type | Req | Key | Description |
Value | string | false | ||
CoordinateType | string | false |
Property | Value |
Name | Latitude |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | Value |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CoordinateType |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
Value | string | false | ||
CoordinateType | string | false |
Property | Value |
Name | Longitude |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | Value |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CoordinateType |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
Quantity | string | false | ||
UnitOfDimension | string | false |
Property | Value |
Name | Elevation |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | true |
Comments |
Property | Value |
Name | Quantity |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | UnitOfDimension |
Id | |
Type | string |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Field | Type | Req | Key | Description |
Line | array | false |
Property | Value |
Name | Label |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
[0] | string | false |
Property | Value |
Name | Line |
Id | |
Type | array |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min items | 1 |
Max items | 7 |
Unique items | |
Additional items | true |
Comments |
Property | Value |
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 |
Field | Type | Req | Key | Description |
[0] | document | false |
Property | Value |
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 |
Field | Type | Req | Key | Description |
ComponentRef | string | true | ||
ErrorCode | string | true | ||
ErrorSeverity | string | true |
Property | Value |
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 |
Property | Value |
Name | ComponentRef |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
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 |
Property | Value |
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 |
Property | Value |
Name | DetectedInputAddressLanguage |
Id | |
Type | string |
Description | Address language that is detected by the system based on the given address as input. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’. |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | de,en,fr,nl |
Sample | fr |
Comments |
Field | Type | Req | Key | Description |
Line | array | true |
Property | Value |
Name | FormattedSubmittedAddress |
Id | |
Type | document |
Description | |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min Properties | |
Max Properties | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description |
[0] | string | false |
Property | Value |
Name | Line |
Id | |
Type | array |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Min items | 1 |
Max items | 7 |
Unique items | |
Additional items | true |
Comments |
Property | Value |
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 |
Property | Value |
Name | TransactionID |
Id | |
Type | string |
Description | ID which identifies the address validation. Together with the ValidationRequestID, this id defines an address validation uniquely. Used for feedback and acces logging purposes. |
Dependencies | |
Required | false |
Primary key | false |
Foreign document | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | 50627398-65a2-498d-b159-98e578b00c46 |
Comments |
Field | Type | Req | Key | Description |
ErrorCode | string | true | ||
ErrorSeverity | string | true |
Property | Value |
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 |
Property | Value |
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 |
Property | Value |
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 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "Response", "description": "Response schema specification for bpost Address Validation webservice", "additionalProperties": true, "isRestfulApi": true, "mediaType": "application/JSON", "properties": { "ValidateAddressesResponse": { "properties": { "ValidatedAddressResultList": { "properties": { "ValidatedAddressResult": { "primaryKey": false, "additionalItems": true, "maxItems": 200, "minItems": 1, "type": "array", "GUID": "1de8c9e3-df28-11e6-a3dd-6de9a4b3cd36", "items": { "properties": { "@id": { "primaryKey": false, "type": "string", "GUID": "1de8c9e5-df28-11e6-a3dd-6de9a4b3cd36", "sample": "1" }, "MaileeAndAddressee": { "properties": { "AddresseeIndividualIdentification": { "primaryKey": false, "type": "object", "GUID": "1de8c9eb-df28-11e6-a3dd-6de9a4b3cd36", "oneOf": [ { "properties": { "StructuredAddresseeIndividualIdentification": { "properties": { "AddresseeFormOfAddress": { "primaryKey": false, "type": "string", "GUID": "f4d3e3b0-e14c-11e6-898f-b7d201a89248", "sample": "Mr" }, "AddresseeGivenName": { "primaryKey": false, "type": "string", "GUID": "f4d3e3b1-e14c-11e6-898f-b7d201a89248", "sample": "Jacques" }, "AddresseeSurname": { "primaryKey": false, "type": "string", "GUID": "f4d3e3b2-e14c-11e6-898f-b7d201a89248", "sample": "Martin" }, "AddresseeSupplementaryDispatchInfo": { "primaryKey": false, "type": "string", "GUID": "f4d3e3b3-e14c-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "f4d3bca0-e14c-11e6-898f-b7d201a89248" } }, "type": "object", "GUID": "ed53b930-e14c-11e6-898f-b7d201a89248", "required": [ "StructuredAddresseeIndividualIdentification" ] }, { "properties": { "UnstructuredAddresseeIndividualIdentification": { "primaryKey": false, "type": "string", "GUID": "06623690-e14d-11e6-898f-b7d201a89248" } }, "type": "object", "GUID": "fae45190-e14c-11e6-898f-b7d201a89248", "required": [ "UnstructuredAddresseeIndividualIdentification" ] } ] }, "MaileeIndividualIdentification": { "primaryKey": false, "type": "object", "GUID": "1de8c9f1-df28-11e6-a3dd-6de9a4b3cd36", "oneOf": [ { "properties": { "StructuredMaileeIndividualIdentification": { "properties": { "MaileeRole": { "primaryKey": false, "type": "string", "GUID": "c7876750-e14d-11e6-898f-b7d201a89248" }, "MaileeFormOfAddress": { "primaryKey": false, "type": "string", "GUID": "c7876751-e14d-11e6-898f-b7d201a89248" }, "MaileeGivenName": { "primaryKey": false, "type": "string", "GUID": "c7876752-e14d-11e6-898f-b7d201a89248" }, "MaileeSurname": { "primaryKey": false, "type": "string", "GUID": "c7876753-e14d-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "c7874040-e14d-11e6-898f-b7d201a89248" } }, "type": "object", "GUID": "c022db20-e14d-11e6-898f-b7d201a89248", "required": [ "StructuredMaileeIndividualIdentification" ] }, { "properties": { "UnstructuredMaileeIndividualIdentification": { "primaryKey": false, "type": "string", "GUID": "d125ddf0-e14d-11e6-898f-b7d201a89248" } }, "type": "object", "GUID": "cb99e250-e14d-11e6-898f-b7d201a89248", "required": [ "UnstructuredMaileeIndividualIdentification" ] } ] }, "MaileeOrganizationIdentification": { "primaryKey": false, "type": "object", "GUID": "1de8c9f7-df28-11e6-a3dd-6de9a4b3cd36", "oneOf": [ { "properties": { "StructuredMaileeOrganizationIdentification": { "properties": { "MaileeOrganizationFunction": { "primaryKey": false, "type": "string", "GUID": "0b7d7991-e14e-11e6-898f-b7d201a89248" }, "MaileeOrganizationOrganizationalUnit": { "primaryKey": false, "type": "string", "GUID": "0b7d7992-e14e-11e6-898f-b7d201a89248" }, "MaileeOrganizationOrganizationalName": { "primaryKey": false, "type": "string", "GUID": "0b7d7993-e14e-11e6-898f-b7d201a89248" }, "MaileeOrganizationLegalStatus": { "primaryKey": false, "type": "string", "GUID": "0b7d7994-e14e-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "0b7d7990-e14e-11e6-898f-b7d201a89248" } }, "type": "object", "GUID": "05da2560-e14e-11e6-898f-b7d201a89248", "required": [ "StructuredMaileeOrganizationIdentification" ] }, { "properties": { "UnstructuredMaileeOrganizationIdentification": { "primaryKey": false, "type": "string", "GUID": "122f7ea0-e14e-11e6-898f-b7d201a89248" } }, "type": "object", "GUID": "0f5387d0-e14e-11e6-898f-b7d201a89248", "required": [ "UnstructuredMaileeOrganizationIdentification" ] } ] }, "MailRecipientDispatchingInformation": { "primaryKey": false, "type": "object", "GUID": "1de8f0f5-df28-11e6-a3dd-6de9a4b3cd36", "oneOf": [ { "properties": { "StructuredMailRecipientDispatchingInformation": { "properties": { "Wing": { "description": "Element identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed.", "properties": { "WingType": { "description": "S42 name: Wing Type, code: 30.29.0.0.1", "primaryKey": false, "type": "string", "GUID": "54dd3262-e14e-11e6-898f-b7d201a89248" }, "WingIndicator": { "description": "S42 name: Wing Indicator, code: 30.29.0.0.2", "primaryKey": false, "type": "string", "GUID": "54dd3263-e14e-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "54dd3261-e14e-11e6-898f-b7d201a89248", "dependencies": { "WingType": [ "WingIndicator" ] } }, "Stairwell": { "description": "Element indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west.", "properties": { "StairwellType": { "description": "S42 name: Stairwell Type, code: 30.30.0.0.1", "primaryKey": false, "type": "string", "GUID": "54dd3265-e14e-11e6-898f-b7d201a89248" }, "StairwellIndicator": { "description": "S42 name: Stairwell Indicator, code: 30.30.0.0.2", "primaryKey": false, "type": "string", "GUID": "54dd3266-e14e-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "54dd3264-e14e-11e6-898f-b7d201a89248", "dependencies": { "StairwellType": [ "StairwellIndicator" ] } }, "Floor": { "description": "Element indicating the floor or level on which a delivery point is located in a multi-story construction.", "properties": { "FloorType": { "description": "S42 name: Floor Type, code: 30.31.0.0.1", "primaryKey": false, "type": "string", "GUID": "54dd3268-e14e-11e6-898f-b7d201a89248" }, "FloorIndicator": { "description": "S42 name: Floor Indicator, code: 30.31.0.0.2", "primaryKey": false, "type": "string", "GUID": "54dd3269-e14e-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "54dd3267-e14e-11e6-898f-b7d201a89248", "dependencies": { "FloorType": [ "FloorIndicator" ] } }, "Door": { "description": "Address Element indicating the apartment, room or office in, at or adjacent to which a delivery point which is situated within a building is located.", "properties": { "DoorType": { "description": "S42 name: Door Type, code: 30.32.0.0.1", "primaryKey": false, "type": "string", "GUID": "54dd326b-e14e-11e6-898f-b7d201a89248" }, "DoorIndicator": { "description": "S42 name: Door Indicator, code: 30.32.0.0.2", "primaryKey": false, "type": "string", "GUID": "54dd326c-e14e-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "54dd326a-e14e-11e6-898f-b7d201a89248", "dependencies": { "DoorType": [ "DoorIndicator" ] } }, "BuildingConstruction": { "description": "S42 name: Building/Construction Level 1, code: 30.26.1.0.0, Element identifying the \"number\" or \"name and type\" of the building, unit or construction in or adjacent to which a delivery point is located. E.g. Batiment A, Block 7, Houseboat, London Tower, ...", "primaryKey": false, "type": "string", "GUID": "54dd326d-e14e-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "54dd3260-e14e-11e6-898f-b7d201a89248" } }, "type": "object", "GUID": "4f1a2130-e14e-11e6-898f-b7d201a89248", "required": [ "StructuredMailRecipientDispatchingInformation" ] }, { "properties": { "UnstructuredMailRecipientDispatchingInformation": { "primaryKey": false, "type": "string", "GUID": "5b61bed0-e14e-11e6-898f-b7d201a89248" } }, "type": "object", "GUID": "594e9640-e14e-11e6-898f-b7d201a89248", "required": [ "UnstructuredMailRecipientDispatchingInformation" ] } ] } }, "primaryKey": false, "type": "object", "GUID": "1de8c9ea-df28-11e6-a3dd-6de9a4b3cd36" }, "ValidatedAddressList": { "properties": { "ValidatedAddress": { "primaryKey": false, "additionalItems": true, "type": "array", "GUID": "1de8f106-df28-11e6-a3dd-6de9a4b3cd36", "items": { "properties": { "PostalAddress": { "properties": { "StructuredDeliveryPointLocation": { "properties": { "StreetName": { "primaryKey": false, "type": "string", "GUID": "1de8f110-df28-11e6-a3dd-6de9a4b3cd36", "sample": "RUE EDOUARD DEKOSTER" }, "StreetNumber": { "primaryKey": false, "type": "string", "GUID": "1de8f111-df28-11e6-a3dd-6de9a4b3cd36", "sample": "64" }, "BoxNumber": { "primaryKey": false, "type": "string", "GUID": "1de8f10f-df28-11e6-a3dd-6de9a4b3cd36", "sample": "84" } }, "primaryKey": false, "type": "object", "GUID": "1de8f10e-df28-11e6-a3dd-6de9a4b3cd36", "required": [ "StreetName", "StreetNumber", "BoxNumber" ] }, "StructuredPostalCodeMunicipality": { "properties": { "PostalCode": { "primaryKey": false, "type": "string", "GUID": "1de8f114-df28-11e6-a3dd-6de9a4b3cd36", "sample": "1140" }, "MunicipalityName": { "primaryKey": false, "type": "string", "GUID": "1de8f113-df28-11e6-a3dd-6de9a4b3cd36", "sample": "EVERE" } }, "primaryKey": false, "type": "object", "GUID": "1de8f112-df28-11e6-a3dd-6de9a4b3cd36", "required": [ "PostalCode", "MunicipalityName" ] }, "CountryName": { "primaryKey": false, "type": "string", "GUID": "1de8f10d-df28-11e6-a3dd-6de9a4b3cd36", "sample": "BELGIQUE" } }, "primaryKey": false, "type": "object", "GUID": "1de8f10c-df28-11e6-a3dd-6de9a4b3cd36", "required": [ "StructuredDeliveryPointLocation", "StructuredPostalCodeMunicipality", "CountryName" ] }, "AddressLanguage": { "description": "S42 name: Address Parameter Language, code: 50.51.0.0.0. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’.", "primaryKey": false, "type": "string", "GUID": "e401b810-e150-11e6-898f-b7d201a89248", "enum": [ "de", "en", "fr", "nl" ] }, "score": { "primaryKey": false, "type": "integer", "GUID": "0d2296b0-e151-11e6-898f-b7d201a89248", "exclusiveMaximum": false, "exclusiveMinimum": false }, "NumberOfBoxes": { "primaryKey": false, "type": "integer", "GUID": "096d08c0-e151-11e6-898f-b7d201a89248", "exclusiveMaximum": false, "exclusiveMinimum": false }, "ServicePointBoxList": { "additionalProperties": true, "properties": { "ServicePointBoxResult": { "primaryKey": false, "additionalItems": true, "minItems": 1, "type": "array", "GUID": "4e23abe0-e151-11e6-898f-b7d201a89248", "items": { "additionalProperties": true, "properties": { "DeliveryServiceIndicator": { "primaryKey": false, "type": "string", "GUID": "7ba99250-e151-11e6-898f-b7d201a89248" }, "StreetNumber": { "primaryKey": false, "type": "string", "GUID": "78e1e6d0-e151-11e6-898f-b7d201a89248" }, "BoxNumber": { "primaryKey": false, "type": "string", "GUID": "7b2f5940-e151-11e6-898f-b7d201a89248" }, "PostalCode": { "primaryKey": false, "type": "string", "GUID": "7c2a5b10-e151-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "5e4109a0-e151-11e6-898f-b7d201a89248", "arrayItem": true }, "uniqueItems": false } }, "primaryKey": false, "type": "object", "GUID": "08fbd060-e151-11e6-898f-b7d201a89248" }, "ServicePointDetail": { "additionalProperties": true, "properties": { "GeographicalLocationInfo": { "additionalProperties": true, "properties": { "GeographicalLocation": { "additionalProperties": true, "properties": { "Latitude": { "additionalProperties": true, "properties": { "Value": { "primaryKey": false, "type": "string", "GUID": "eb8fcfd0-e151-11e6-898f-b7d201a89248" }, "CoordinateType": { "primaryKey": false, "type": "string", "GUID": "f3983d20-e151-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "d3465020-e151-11e6-898f-b7d201a89248" }, "Longitude": { "additionalProperties": true, "properties": { "Value": { "primaryKey": false, "type": "string", "GUID": "056ac4f0-e152-11e6-898f-b7d201a89248" }, "CoordinateType": { "primaryKey": false, "type": "string", "GUID": "0ecd1cf0-e152-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "fae43840-e151-11e6-898f-b7d201a89248" }, "Elevation": { "additionalProperties": true, "properties": { "Quantity": { "primaryKey": false, "type": "string", "GUID": "3eea2900-e152-11e6-898f-b7d201a89248" }, "UnitOfDimension": { "primaryKey": false, "type": "string", "GUID": "41bcd100-e152-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "15e054d0-e152-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "c77f7b40-e151-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "bec17990-e151-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "087e3bf0-e151-11e6-898f-b7d201a89248" }, "Label": { "properties": { "Line": { "primaryKey": false, "additionalItems": true, "maxItems": 7, "minItems": 1, "type": "array", "GUID": "1de8f10a-df28-11e6-a3dd-6de9a4b3cd36", "items": { "primaryKey": false, "type": "string", "GUID": "1de8f10b-df28-11e6-a3dd-6de9a4b3cd36", "arrayItem": true, "sample": "Mr Jacques Martin Lorem" } } }, "primaryKey": false, "type": "object", "GUID": "1de8f109-df28-11e6-a3dd-6de9a4b3cd36" } }, "primaryKey": false, "type": "object", "GUID": "1de8f107-df28-11e6-a3dd-6de9a4b3cd36", "arrayItem": true } } }, "primaryKey": false, "type": "object", "GUID": "1de8f105-df28-11e6-a3dd-6de9a4b3cd36", "required": [ "ValidatedAddress" ] }, "Error": { "primaryKey": false, "additionalItems": true, "type": "array", "GUID": "9e418670-e14b-11e6-898f-b7d201a89248", "items": { "additionalProperties": true, "properties": { "ComponentRef": { "primaryKey": false, "type": "string", "GUID": "b11caf30-e14c-11e6-898f-b7d201a89248" }, "ErrorCode": { "primaryKey": false, "type": "string", "GUID": "c0136740-e14c-11e6-898f-b7d201a89248" }, "ErrorSeverity": { "primaryKey": false, "type": "string", "GUID": "c96b5f00-e14c-11e6-898f-b7d201a89248", "enum": [ "warning", "error" ] } }, "primaryKey": false, "type": "object", "GUID": "ab485ff0-e14c-11e6-898f-b7d201a89248", "arrayItem": true, "required": [ "ComponentRef", "ErrorCode", "ErrorSeverity" ] }, "uniqueItems": false }, "DetectedInputAddressLanguage": { "description": "Address language that is detected by the system based on the given address as input. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’.", "primaryKey": false, "type": "string", "GUID": "1de8c9e6-df28-11e6-a3dd-6de9a4b3cd36", "sample": "fr", "enum": [ "de", "en", "fr", "nl" ] }, "FormattedSubmittedAddress": { "properties": { "Line": { "primaryKey": false, "additionalItems": true, "maxItems": 7, "minItems": 1, "type": "array", "GUID": "1de8c9e8-df28-11e6-a3dd-6de9a4b3cd36", "items": { "primaryKey": false, "type": "string", "GUID": "1de8c9e9-df28-11e6-a3dd-6de9a4b3cd36", "arrayItem": true, "sample": "Mr Jacques Martin Lorem" } } }, "primaryKey": false, "type": "object", "GUID": "1de8c9e7-df28-11e6-a3dd-6de9a4b3cd36", "required": [ "Line" ] }, "TransactionID": { "description": "ID which identifies the address validation. Together with the ValidationRequestID, this id defines an address validation uniquely. Used for feedback and acces logging purposes.", "primaryKey": false, "type": "string", "GUID": "1de8f104-df28-11e6-a3dd-6de9a4b3cd36", "sample": "50627398-65a2-498d-b159-98e578b00c46" } }, "primaryKey": false, "type": "object", "GUID": "1de8c9e4-df28-11e6-a3dd-6de9a4b3cd36", "arrayItem": true, "required": [ "@id" ] } } }, "primaryKey": false, "type": "object", "GUID": "1de8c9e2-df28-11e6-a3dd-6de9a4b3cd36", "required": [ "ValidatedAddressResult" ] }, "GeneralError": { "additionalProperties": true, "properties": { "ErrorCode": { "primaryKey": false, "type": "string", "GUID": "127b8320-e14b-11e6-898f-b7d201a89248" }, "ErrorSeverity": { "primaryKey": false, "type": "string", "GUID": "1eddd4b0-e14b-11e6-898f-b7d201a89248" } }, "primaryKey": false, "type": "object", "GUID": "03677f10-e14b-11e6-898f-b7d201a89248", "required": [ "ErrorCode", "ErrorSeverity" ] } }, "primaryKey": false, "type": "object", "GUID": "1de8c9e1-df28-11e6-a3dd-6de9a4b3cd36", "required": [ "ValidatedAddressResultList" ] } }, "type": "object", "required": [ "ValidateAddressesResponse" ], "transaction": "Response" }
{ "ValidateAddressesResponse": { "ValidatedAddressResultList": { "ValidatedAddressResult": [ { "@id": "1", "MaileeAndAddressee": { "AddresseeIndividualIdentification": { "StructuredAddresseeIndividualIdentification": { "AddresseeFormOfAddress": "Mr", "AddresseeGivenName": "Jacques", "AddresseeSurname": "Martin", "AddresseeSupplementaryDispatchInfo": "Lorem" } }, "MaileeIndividualIdentification": { "StructuredMaileeIndividualIdentification": { "MaileeRole": "Lorem", "MaileeFormOfAddress": "Lorem", "MaileeGivenName": "Lorem", "MaileeSurname": "Lorem" } }, "MaileeOrganizationIdentification": { "StructuredMaileeOrganizationIdentification": { "MaileeOrganizationFunction": "Lorem", "MaileeOrganizationOrganizationalUnit": "Lorem", "MaileeOrganizationOrganizationalName": "Lorem", "MaileeOrganizationLegalStatus": "Lorem" } }, "MailRecipientDispatchingInformation": { "StructuredMailRecipientDispatchingInformation": { "Wing": { "WingType": "Lorem", "WingIndicator": "Lorem" }, "Stairwell": { "StairwellType": "Lorem", "StairwellIndicator": "Lorem" }, "Floor": { "FloorType": "Lorem", "FloorIndicator": "Lorem" }, "Door": { "DoorType": "Lorem", "DoorIndicator": "Lorem" }, "BuildingConstruction": "Lorem" } } }, "ValidatedAddressList": { "ValidatedAddress": [ { "PostalAddress": { "StructuredDeliveryPointLocation": { "StreetName": "RUE EDOUARD DEKOSTER", "StreetNumber": "64", "BoxNumber": "84" }, "StructuredPostalCodeMunicipality": { "PostalCode": "1140", "MunicipalityName": "EVERE" }, "CountryName": "BELGIQUE" }, "AddressLanguage": "nl", "score": 38, "NumberOfBoxes": 43, "ServicePointBoxList": { "ServicePointBoxResult": [ { "StreetNumber": "Lorem", "BoxNumber": "Lorem", "DeliveryServiceIndicator": "Lorem", "PostalCode": "Lorem" } ] }, "ServicePointDetail": { "GeographicalLocationInfo": { "GeographicalLocation": { "Latitude": { "Value": "Lorem", "CoordinateType": "Lorem" }, "Longitude": { "Value": "Lorem", "CoordinateType": "Lorem" }, "Elevation": { "Quantity": "Lorem", "UnitOfDimension": "Lorem" } } } }, "Label": { "Line": [ "Mr Jacques Martin Lorem" ] } } ] }, "Error": [ { "ComponentRef": "Lorem", "ErrorCode": "Lorem", "ErrorSeverity": "error" } ], "DetectedInputAddressLanguage": "fr", "FormattedSubmittedAddress": { "Line": [ "Mr Jacques Martin Lorem" ] }, "TransactionID": "50627398-65a2-498d-b159-98e578b00c46" } ] }, "GeneralError": { "ErrorCode": "Lorem", "ErrorSeverity": "Lorem" } } }
Parent Table | Parent field |
Request | ValidateAddressesRequest.AddressToValidateList.AddressToValidate.[0].@id |
Child Table | Child field |
Response | ValidateAddressesResponse.ValidatedAddressResultList.ValidatedAddressResult.[0].@id |