✕
JSON Physical Model
Schema for:
Model name: bpostAddressFormattingWebservice - External
Author: Pascal
Version: 1.4
File name: bpost Address Formatting Webservice - External v1.4.json
File path: /Users/pascal_hackolade/Documents/Hackolade/Models/bpost Address Formatting Webservice - External v1.4.json
Printed On: Thu Feb 16 2017 16:32:25 GMT+0100 (CET)
Created with: Hackolade - Visual data modeling for NoSQL and multimodel databases
1. Model
1.1 Model bpostAddressFormattingWebservice - External
1.1.1 bpostAddressFormattingWebservice - External Entity Relationship Diagram
1.1.2 bpostAddressFormattingWebservice - External Properties
| Property | Value |
| Name | bpostAddressFormattingWebservice - External |
| Description | JSON Schema for bpost RESTful webservice for Address Formatting according to UPU/CEN S42 standard -- valid only with addresses for Belgium. |
| Author | Pascal |
| Version | 1 |
| DB Vendor | Plain JSON--no DB |
| Comments |
1.1.4 bpostAddressFormattingWebservice - External DB Definitions (TBD)
2. Document
2.1 Document Request
2.1.1 Request Tree Diagram
2.1.2 Request Properties
| Property | Value |
| Document name | Request |
| Id | |
| Description | Request schema specification for bpost Address Formatting webservice |
| RESTful API | true |
| Transaction | Request |
| Method | Post |
| EndPoint | http://webservices-pub.bpost.be |
| Resources | /ws/ExternalMailingAddressProofingCSREST_v1/address/validateAddresses |
| Media type | application/JSON |
| Additional properties | |
| Comments |
2.1.3 Request Fields
2.1.3.1 Field FormatAddressesRequest
2.1.3.1.1 FormatAddressesRequest Tree Diagram
2.1.3.1.2 FormatAddressesRequest Hierarchy
Parent field: Request
Child field(s):
| Field | Type | Req | Key | Description |
| AddressToFormatList | document | true | ||
| CallerIdentification | document | false | Information about the caller of the service, in case no authentication mechanism exists. |
FormatAddressesRequest properties
| Property | Value |
| Name | FormatAddressesRequest |
| Id | |
| Type | document |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min Properties | |
| Max Properties | |
| Additional properties | |
| Comments |
2.1.3.2 Field AddressToFormatList
2.1.3.2.1 AddressToFormatList Tree Diagram
2.1.3.2.2 AddressToFormatList Hierarchy
Parent field: FormatAddressesRequest
Child field(s):
| Field | Type | Req | Key | Description |
| AddressToFormat | array | true |
AddressToFormatList properties
| Property | Value |
| Name | AddressToFormatList |
| Id | |
| Type | document |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min Properties | |
| Max Properties | |
| Additional properties | |
| Comments |
2.1.3.3 Field AddressToFormat
2.1.3.3.1 AddressToFormat Tree Diagram
2.1.3.3.2 AddressToFormat Hierarchy
Parent field: AddressToFormatList
Child field(s):
| Field | Type | Req | Key | Description |
| document | false |
AddressToFormat properties
| Property | Value |
| Name | AddressToFormat |
| Id | |
| Type | array |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
2.1.3.4 Field
2.1.3.4.1 [0] Tree Diagram
2.1.3.4.2 [0] Hierarchy
Parent field: AddressToFormat
Child field(s):
| Field | Type | Req | Key | Description |
| @id | string | true | ||
| oneOf | choice | false | ||
| AddressLanguage | string | false | S42 name: Address Parameter Language, code: 50.51.0.0.0. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’. | |
| 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. |
[0] properties
| 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 |
2.1.3.5 Field @id
2.1.3.5.1 @id Tree Diagram
@id properties
| 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 |
2.1.3.6 Field
2.1.3.6.1 Tree Diagram
2.1.3.6.2 Hierarchy
Parent field:
Child field(s):
| Field | Type | Req | Key | Description |
| [undefined] | 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. | |
| [undefined] | 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. |
properties
| Property | Value |
| Choice | oneOf |
2.1.3.7 Field
2.1.3.7.1 Tree Diagram
2.1.3.7.2 Hierarchy
Parent field:
Child field(s):
| Field | Type | Req | Key | Description |
| MaileeAndAddressee | document | false | ||
| PostalAddress | document | true |
properties
| 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. |
| Required | |
| Min Properties | |
| Max Properties | |
| Additional properties | true |
| Comments |
2.1.3.8 Field MaileeAndAddressee
2.1.3.8.1 MaileeAndAddressee Tree Diagram
2.1.3.8.2 MaileeAndAddressee Hierarchy
Parent field:
Child field(s):
| Field | Type | Req | Key | Description |
| StructuredAddresseeIndividualIdentification | document | false | ||
| StructuredMaileeIndividualIdentification | document | false | ||
| StructuredMaileeOrganizationIdentification | document | false | ||
| StructuredMailRecipientDispatchingInformation | document | false |
MaileeAndAddressee properties
| Property | Value |
| Name | MaileeAndAddressee |
| Id | |
| Type | document |
| Description | |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min Properties | |
| Max Properties | |
| Additional properties | |
| Comments |
2.1.3.9 Field StructuredAddresseeIndividualIdentification
2.1.3.9.1 StructuredAddresseeIndividualIdentification Tree Diagram
2.1.3.9.2 StructuredAddresseeIndividualIdentification Hierarchy
Parent field: MaileeAndAddressee
Child field(s):
| Field | Type | Req | Key | Description |
| AddresseeFormOfAddress | string | false | ||
| AddresseeGivenName | string | false | ||
| AddresseeSurname | string | false | ||
| AddresseeSupplementaryDispatchInfo | string | false |
StructuredAddresseeIndividualIdentification properties
| 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 |
2.1.3.10 Field AddresseeFormOfAddress
2.1.3.10.1 AddresseeFormOfAddress Tree Diagram
AddresseeFormOfAddress properties
| 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 |
2.1.3.11 Field AddresseeGivenName
2.1.3.11.1 AddresseeGivenName Tree Diagram
AddresseeGivenName properties
| 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 |
2.1.3.12 Field AddresseeSurname
2.1.3.12.1 AddresseeSurname Tree Diagram
AddresseeSurname properties
| 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 |
2.1.3.13 Field AddresseeSupplementaryDispatchInfo
2.1.3.13.1 AddresseeSupplementaryDispatchInfo Tree Diagram
AddresseeSupplementaryDispatchInfo properties
| 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 |
2.1.3.14 Field StructuredMaileeIndividualIdentification
2.1.3.14.1 StructuredMaileeIndividualIdentification Tree Diagram
2.1.3.14.2 StructuredMaileeIndividualIdentification Hierarchy
Parent field: MaileeAndAddressee
Child field(s):
| Field | Type | Req | Key | Description |
| MaileeRole | string | false | ||
| MaileeFormOfAddress | string | false | ||
| MaileeGivenName | string | false | ||
| MaileeSurname | string | false |
StructuredMaileeIndividualIdentification properties
| 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 | |
| Comments |
2.1.3.15 Field MaileeRole
2.1.3.15.1 MaileeRole Tree Diagram
MaileeRole properties
| 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 |
2.1.3.16 Field MaileeFormOfAddress
2.1.3.16.1 MaileeFormOfAddress Tree Diagram
MaileeFormOfAddress properties
| 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 |
2.1.3.17 Field MaileeGivenName
2.1.3.17.1 MaileeGivenName Tree Diagram
MaileeGivenName properties
| 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 |
2.1.3.18 Field MaileeSurname
2.1.3.18.1 MaileeSurname Tree Diagram
MaileeSurname properties
| 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 |
2.1.3.19 Field StructuredMaileeOrganizationIdentification
2.1.3.19.1 StructuredMaileeOrganizationIdentification Tree Diagram
2.1.3.19.2 StructuredMaileeOrganizationIdentification Hierarchy
Parent field: MaileeAndAddressee
Child field(s):
| Field | Type | Req | Key | Description |
| MaileeOrganizationFunction | string | false | ||
| MaileeOrganizationOrganizationalUnit | string | false | ||
| MaileeOrganizationOrganizationalName | string | false | ||
| MaileeOrganizationLegalStatus | string | false |
StructuredMaileeOrganizationIdentification properties
| 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 | |
| Comments |
2.1.3.20 Field MaileeOrganizationFunction
2.1.3.20.1 MaileeOrganizationFunction Tree Diagram
MaileeOrganizationFunction properties
| 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 |
2.1.3.21 Field MaileeOrganizationOrganizationalUnit
2.1.3.21.1 MaileeOrganizationOrganizationalUnit Tree Diagram
MaileeOrganizationOrganizationalUnit properties
| 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 |
2.1.3.22 Field MaileeOrganizationOrganizationalName
2.1.3.22.1 MaileeOrganizationOrganizationalName Tree Diagram
MaileeOrganizationOrganizationalName properties
| 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 |
2.1.3.23 Field MaileeOrganizationLegalStatus
2.1.3.23.1 MaileeOrganizationLegalStatus Tree Diagram
MaileeOrganizationLegalStatus properties
| 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 |
2.1.3.24 Field StructuredMailRecipientDispatchingInformation
2.1.3.24.1 StructuredMailRecipientDispatchingInformation Tree Diagram
2.1.3.24.2 StructuredMailRecipientDispatchingInformation Hierarchy
Parent field: MaileeAndAddressee
Child field(s):
| 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, ... |
StructuredMailRecipientDispatchingInformation properties
| 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 | |
| Comments |
2.1.3.25 Field Wing
2.1.3.25.1 Wing Tree Diagram
2.1.3.25.2 Wing Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
| Field | Type | Req | Key | Description |
| WingType | string | true | S42 name: Wing Type, code: 30.29.0.0.1 | |
| WingIndicator | string | true | S42 name: Wing Indicator, code: 30.29.0.0.2 |
Wing properties
| 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 | |
| Comments |
2.1.3.26 Field WingType
2.1.3.26.1 WingType Tree Diagram
WingType properties
| Property | Value |
| Name | WingType |
| Id | |
| Type | string |
| Description | S42 name: Wing Type, code: 30.29.0.0.1 |
| Dependencies | b3cb54ca-e31e-11e6-aae7-27e5e7efbb51 |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.1.3.27 Field WingIndicator
2.1.3.27.1 WingIndicator Tree Diagram
WingIndicator properties
| Property | Value |
| Name | WingIndicator |
| Id | |
| Type | string |
| Description | S42 name: Wing Indicator, code: 30.29.0.0.2 |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.1.3.28 Field Stairwell
2.1.3.28.1 Stairwell Tree Diagram
2.1.3.28.2 Stairwell Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
| Field | Type | Req | Key | Description |
| StairwellType | string | true | S42 name: Stairwell Type, code: 30.30.0.0.1 | |
| StairwellIndicator | string | true | S42 name: Stairwell Indicator, code: 30.30.0.0.2 |
Stairwell properties
| 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 | |
| Comments |
2.1.3.29 Field StairwellType
2.1.3.29.1 StairwellType Tree Diagram
StairwellType properties
| Property | Value |
| Name | StairwellType |
| Id | |
| Type | string |
| Description | S42 name: Stairwell Type, code: 30.30.0.0.1 |
| Dependencies | b3cb54cd-e31e-11e6-aae7-27e5e7efbb51 |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.1.3.30 Field StairwellIndicator
2.1.3.30.1 StairwellIndicator Tree Diagram
StairwellIndicator properties
| Property | Value |
| Name | StairwellIndicator |
| Id | |
| Type | string |
| Description | S42 name: Stairwell Indicator, code: 30.30.0.0.2 |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.1.3.31 Field Floor
2.1.3.31.1 Floor Tree Diagram
2.1.3.31.2 Floor Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
| Field | Type | Req | Key | Description |
| FloorType | string | true | S42 name: Floor Type, code: 30.31.0.0.1 | |
| FloorIndicator | string | true | S42 name: Floor Indicator, code: 30.31.0.0.2 |
Floor properties
| 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 | |
| Comments |
2.1.3.32 Field FloorType
2.1.3.32.1 FloorType Tree Diagram
FloorType properties
| Property | Value |
| Name | FloorType |
| Id | |
| Type | string |
| Description | S42 name: Floor Type, code: 30.31.0.0.1 |
| Dependencies | b3cb54d0-e31e-11e6-aae7-27e5e7efbb51 |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.1.3.33 Field FloorIndicator
2.1.3.33.1 FloorIndicator Tree Diagram
FloorIndicator properties
| Property | Value |
| Name | FloorIndicator |
| Id | |
| Type | string |
| Description | S42 name: Floor Indicator, code: 30.31.0.0.2 |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.1.3.34 Field Door
2.1.3.34.1 Door Tree Diagram
2.1.3.34.2 Door Hierarchy
Parent field: StructuredMailRecipientDispatchingInformation
Child field(s):
| Field | Type | Req | Key | Description |
| DoorType | string | true | S42 name: Door Type, code: 30.32.0.0.1 | |
| DoorIndicator | string | true | S42 name: Door Indicator, code: 30.32.0.0.2 |
Door properties
| 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 | |
| Comments |
2.1.3.35 Field DoorType
2.1.3.35.1 DoorType Tree Diagram
DoorType properties
| Property | Value |
| Name | DoorType |
| Id | |
| Type | string |
| Description | S42 name: Door Type, code: 30.32.0.0.1 |
| Dependencies | b3cb54d3-e31e-11e6-aae7-27e5e7efbb51 |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.1.3.36 Field DoorIndicator
2.1.3.36.1 DoorIndicator Tree Diagram
DoorIndicator properties
| Property | Value |
| Name | DoorIndicator |
| Id | |
| Type | string |
| Description | S42 name: Door Indicator, code: 30.32.0.0.2 |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.1.3.37 Field BuildingConstruction
2.1.3.37.1 BuildingConstruction Tree Diagram
BuildingConstruction properties
| 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 |
2.1.3.38 Field PostalAddress
2.1.3.38.1 PostalAddress Tree Diagram
2.1.3.38.2 PostalAddress Hierarchy
Parent field:
Child field(s):
| Field | Type | Req | Key | Description |
| StructuredOtherDeliveryInformation | document | false | ||
| StructuredDeliveryPointLocation | document | false | ||
| StructuredPostalCodeMunicipality | document | true | ||
| CountryName | document | false |
PostalAddress properties
| Property | Value |
| Name | PostalAddress |
| Id | |
| Type | document |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min Properties | |
| Max Properties | |
| Additional properties | |
| Comments |
2.1.3.39 Field StructuredOtherDeliveryInformation
2.1.3.39.1 StructuredOtherDeliveryInformation Tree Diagram
2.1.3.39.2 StructuredOtherDeliveryInformation Hierarchy
Parent field: PostalAddress
Child field(s):
| Field | Type | Req | Key | Description |
| DeliveryServiceType | string | false | ||
| DeliveryServiceIndicator | string | false |
StructuredOtherDeliveryInformation properties
| Property | Value |
| Name | StructuredOtherDeliveryInformation |
| Id | |
| Type | document |
| Description | |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min Properties | |
| Max Properties | |
| Additional properties | |
| Comments |
2.1.3.40 Field DeliveryServiceType
2.1.3.40.1 DeliveryServiceType Tree Diagram
DeliveryServiceType properties
| 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 |
2.1.3.41 Field DeliveryServiceIndicator
2.1.3.41.1 DeliveryServiceIndicator Tree Diagram
DeliveryServiceIndicator properties
| 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 |
2.1.3.42 Field StructuredDeliveryPointLocation
2.1.3.42.1 StructuredDeliveryPointLocation Tree Diagram
2.1.3.42.2 StructuredDeliveryPointLocation Hierarchy
Parent field: PostalAddress
Child field(s):
| Field | Type | Req | Key | Description |
| StreetName | document | false | ||
| StreetNumber | string | false | ||
| BoxNumber | string | false |
StructuredDeliveryPointLocation properties
| Property | Value |
| Name | StructuredDeliveryPointLocation |
| Id | |
| Type | document |
| Description | |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min Properties | |
| Max Properties | |
| Additional properties | |
| Comments |
2.1.3.43 Field StreetName
2.1.3.43.1 StreetName Tree Diagram
2.1.3.43.2 StreetName Hierarchy
Parent field: StructuredDeliveryPointLocation
Child field(s):
| Field | Type | Req | Key | Description |
| @locale | string | false | ||
| *body | string | true |
StreetName properties
| Property | Value |
| Name | StreetName |
| Id | |
| Type | document |
| Description | |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min Properties | |
| Max Properties | |
| Additional properties | |
| Comments |
2.1.3.44 Field @locale
2.1.3.44.1 @locale Tree Diagram
@locale properties
| Property | Value |
| Name | @locale |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | fr |
| Comments |
2.1.3.45 Field *body
2.1.3.45.1 *body Tree Diagram
*body properties
| 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 | Rue du Vivier |
| Comments |
2.1.3.46 Field StreetNumber
2.1.3.46.1 StreetNumber Tree Diagram
StreetNumber properties
| 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 |
2.1.3.47 Field BoxNumber
2.1.3.47.1 BoxNumber Tree Diagram
BoxNumber properties
| 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 |
2.1.3.48 Field StructuredPostalCodeMunicipality
2.1.3.48.1 StructuredPostalCodeMunicipality Tree Diagram
2.1.3.48.2 StructuredPostalCodeMunicipality Hierarchy
Parent field: PostalAddress
Child field(s):
| Field | Type | Req | Key | Description |
| PostalCode | string | true | Municipality postal code | |
| MunicipalityName | document | true | ||
| DeliveryServiceQualifier | string | false |
StructuredPostalCodeMunicipality properties
| 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 |
2.1.3.49 Field PostalCode
2.1.3.49.1 PostalCode Tree Diagram
PostalCode properties
| 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 | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | 1140 |
| Comments |
2.1.3.50 Field MunicipalityName
2.1.3.50.1 MunicipalityName Tree Diagram
2.1.3.50.2 MunicipalityName Hierarchy
Parent field: StructuredPostalCodeMunicipality
Child field(s):
| Field | Type | Req | Key | Description |
| @locale | string | false | ||
| *body | string | true |
MunicipalityName properties
| Property | Value |
| Name | MunicipalityName |
| Id | |
| Type | document |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min Properties | |
| Max Properties | |
| Additional properties | |
| Comments |
2.1.3.51 Field @locale
2.1.3.51.1 @locale Tree Diagram
@locale properties
| Property | Value |
| Name | @locale |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | nl |
| Comments |
2.1.3.52 Field *body
2.1.3.52.1 *body Tree Diagram
*body properties
| 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 | Bruxelles |
| Comments |
2.1.3.53 Field DeliveryServiceQualifier
2.1.3.53.1 DeliveryServiceQualifier Tree Diagram
DeliveryServiceQualifier properties
| Property | Value |
| Name | DeliveryServiceQualifier |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | |
| Comments |
2.1.3.54 Field CountryName
2.1.3.54.1 CountryName Tree Diagram
2.1.3.54.2 CountryName Hierarchy
Parent field: PostalAddress
Child field(s):
| Field | Type | Req | Key | Description |
| @locale | string | false | ||
| *body | string | true |
CountryName properties
| Property | Value |
| Name | CountryName |
| Id | |
| Type | document |
| Description | |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min Properties | |
| Max Properties | |
| Additional properties | |
| Comments |
2.1.3.55 Field @locale
2.1.3.55.1 @locale Tree Diagram
@locale properties
| Property | Value |
| Name | @locale |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | nl |
| Comments |
2.1.3.56 Field *body
2.1.3.56.1 *body Tree Diagram
*body properties
| 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 | BELGIUM |
| Comments |
2.1.3.57 Field
2.1.3.57.1 Tree Diagram
2.1.3.57.2 Hierarchy
Parent field:
Child field(s):
| Field | Type | Req | Key | Description |
| AddressBlockLines | document | false |
properties
| 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 | false |
| Comments |
2.1.3.58 Field AddressBlockLines
2.1.3.58.1 AddressBlockLines Tree Diagram
2.1.3.58.2 AddressBlockLines Hierarchy
Parent field:
Child field(s):
| Field | Type | Req | Key | Description |
| UnstructuredAddressLine | array | true |
AddressBlockLines properties
| 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 |
2.1.3.59 Field UnstructuredAddressLine
2.1.3.59.1 UnstructuredAddressLine Tree Diagram
2.1.3.59.2 UnstructuredAddressLine Hierarchy
Parent field: AddressBlockLines
Child field(s):
| Field | Type | Req | Key | Description |
| document | false |
UnstructuredAddressLine properties
| Property | Value |
| Name | UnstructuredAddressLine |
| Id | |
| Type | array |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
2.1.3.60 Field
2.1.3.60.1 [0] Tree Diagram
2.1.3.60.2 [0] Hierarchy
Parent field: UnstructuredAddressLine
Child field(s):
| Field | Type | Req | Key | Description |
| @locale | string | false | ||
| *body | string | true |
[0] properties
| 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 |
2.1.3.61 Field @locale
2.1.3.61.1 @locale Tree Diagram
@locale properties
| Property | Value |
| Name | @locale |
| Id | |
| Type | string |
| Description | |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Default | |
| Min length | |
| Max length | |
| Pattern | |
| Format | |
| Enum | |
| Sample | nl |
| Comments |
2.1.3.62 Field *body
2.1.3.62.1 *body Tree Diagram
*body properties
| 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 |
2.1.3.63 Field AddressLanguage
2.1.3.63.1 AddressLanguage Tree Diagram
AddressLanguage properties
| 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 |
2.1.3.64 Field DispatchingCountryISOCode
2.1.3.64.1 DispatchingCountryISOCode Tree Diagram
DispatchingCountryISOCode properties
| 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 |
2.1.3.65 Field DeliveringCountryISOCode
2.1.3.65.1 DeliveringCountryISOCode Tree Diagram
DeliveringCountryISOCode properties
| 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 |
2.1.3.66 Field CallerIdentification
2.1.3.66.1 CallerIdentification Tree Diagram
2.1.3.66.2 CallerIdentification Hierarchy
Parent field: FormatAddressesRequest
Child field(s):
| Field | Type | Req | Key | Description |
| CallerName | string | true |
CallerIdentification properties
| 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 |
2.1.3.67 Field CallerName
2.1.3.67.1 CallerName Tree Diagram
CallerName properties
| 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 |
2.1.7 Request Definitions (TBD)
2.1.8 Request JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Request",
"description": "Request schema specification for bpost Address Formatting webservice",
"endPoint": "http://webservices-pub.bpost.be",
"isRestfulApi": true,
"mediaType": "application/JSON",
"method": "Post",
"properties": {
"FormatAddressesRequest": {
"properties": {
"AddressToFormatList": {
"properties": {
"AddressToFormat": {
"primaryKey": false,
"additionalItems": true,
"type": "array",
"GUID": "b3cb54b2-e31e-11e6-aae7-27e5e7efbb51",
"items": {
"properties": {
"@id": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54b4-e31e-11e6-aae7-27e5e7efbb51",
"sample": "1"
},
"AddressLanguage": {
"description": "S42 name: Address Parameter Language, code: 50.51.0.0.0. Possible values: ‘de’, ‘en’, ‘fr’, ‘nl’.",
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bd2-e31e-11e6-aae7-27e5e7efbb51",
"enum": [
"de",
"en",
"fr",
"nl"
]
},
"DispatchingCountryISOCode": {
"description": "S42 name: Dispatching Country ISO Code, code: 50.53.0.0.0",
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bd3-e31e-11e6-aae7-27e5e7efbb51",
"sample": "BE"
},
"DeliveringCountryISOCode": {
"description": "S42 name: Delivering Country ISO Code, code: 50.54.0.0.0. This field determines which S42 template will be chosen.",
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bd4-e31e-11e6-aae7-27e5e7efbb51",
"sample": "BE"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54b3-e31e-11e6-aae7-27e5e7efbb51",
"arrayItem": true,
"oneOf": [
{
"description": "Addresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components.\n\nThis branch of the choice describes the address components. Each address is divided in logical groups, for example the 'delivery point location' group (typically used to store the street name and house number). Each logical group can itself be submitted in a structured manner (prefered method) identifying each individual field: one for the street name, one for the house number, and possibly one for the mailbox number. Or it can be submitted in one one unstructured field.\n\nWhile in any individual group, you cannot submit a mix of structured and unstructured fields, you are allowed to make the choice of structured or unstructured for any group, and mix the mode between groups. In other words, you could submit the group 'delivery point location' in an unstructured mode, and submit the 'postal code municipality' group in a structured mode.",
"properties": {
"MaileeAndAddressee": {
"properties": {
"StructuredAddresseeIndividualIdentification": {
"properties": {
"AddresseeFormOfAddress": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54b9-e31e-11e6-aae7-27e5e7efbb51",
"sample": "Mr"
},
"AddresseeGivenName": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54ba-e31e-11e6-aae7-27e5e7efbb51",
"sample": "Jacques"
},
"AddresseeSurname": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54bb-e31e-11e6-aae7-27e5e7efbb51",
"sample": "Martin"
},
"AddresseeSupplementaryDispatchInfo": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54bc-e31e-11e6-aae7-27e5e7efbb51"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54b8-e31e-11e6-aae7-27e5e7efbb51"
},
"StructuredMaileeIndividualIdentification": {
"properties": {
"MaileeRole": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54be-e31e-11e6-aae7-27e5e7efbb51"
},
"MaileeFormOfAddress": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54bf-e31e-11e6-aae7-27e5e7efbb51"
},
"MaileeGivenName": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54c0-e31e-11e6-aae7-27e5e7efbb51"
},
"MaileeSurname": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54c1-e31e-11e6-aae7-27e5e7efbb51"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54bd-e31e-11e6-aae7-27e5e7efbb51"
},
"StructuredMaileeOrganizationIdentification": {
"properties": {
"MaileeOrganizationFunction": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54c3-e31e-11e6-aae7-27e5e7efbb51"
},
"MaileeOrganizationOrganizationalUnit": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54c4-e31e-11e6-aae7-27e5e7efbb51"
},
"MaileeOrganizationOrganizationalName": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54c5-e31e-11e6-aae7-27e5e7efbb51"
},
"MaileeOrganizationLegalStatus": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54c6-e31e-11e6-aae7-27e5e7efbb51"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54c2-e31e-11e6-aae7-27e5e7efbb51"
},
"StructuredMailRecipientDispatchingInformation": {
"properties": {
"Wing": {
"description": "Element identifying the building, unit or construction section in which it is housed and/or the main entry door through which it is accessed.",
"properties": {
"WingType": {
"description": "S42 name: Wing Type, code: 30.29.0.0.1",
"primaryKey": false,
"type": "string",
"GUID": "b3cb54c9-e31e-11e6-aae7-27e5e7efbb51"
},
"WingIndicator": {
"description": "S42 name: Wing Indicator, code: 30.29.0.0.2",
"primaryKey": false,
"type": "string",
"GUID": "b3cb54ca-e31e-11e6-aae7-27e5e7efbb51"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54c8-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"WingType",
"WingIndicator"
],
"dependencies": {
"WingType": [
"WingIndicator"
]
}
},
"Stairwell": {
"description": "Element indicating access to floor or door within a building, unit or construction. E.g. escalier 1, staircase west.",
"properties": {
"StairwellType": {
"description": "S42 name: Stairwell Type, code: 30.30.0.0.1",
"primaryKey": false,
"type": "string",
"GUID": "b3cb54cc-e31e-11e6-aae7-27e5e7efbb51"
},
"StairwellIndicator": {
"description": "S42 name: Stairwell Indicator, code: 30.30.0.0.2",
"primaryKey": false,
"type": "string",
"GUID": "b3cb54cd-e31e-11e6-aae7-27e5e7efbb51"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54cb-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"StairwellType",
"StairwellIndicator"
],
"dependencies": {
"StairwellType": [
"StairwellIndicator"
]
}
},
"Floor": {
"description": "Element indicating the floor or level on which a delivery point is located in a multi-story construction.",
"properties": {
"FloorType": {
"description": "S42 name: Floor Type, code: 30.31.0.0.1",
"primaryKey": false,
"type": "string",
"GUID": "b3cb54cf-e31e-11e6-aae7-27e5e7efbb51"
},
"FloorIndicator": {
"description": "S42 name: Floor Indicator, code: 30.31.0.0.2",
"primaryKey": false,
"type": "string",
"GUID": "b3cb54d0-e31e-11e6-aae7-27e5e7efbb51"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54ce-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"FloorType",
"FloorIndicator"
],
"dependencies": {
"FloorType": [
"FloorIndicator"
]
}
},
"Door": {
"description": "Address Element indicating the apartment, room or office in, at or adjacent to which a delivery point which is situated within a building is located.",
"properties": {
"DoorType": {
"description": "S42 name: Door Type, code: 30.32.0.0.1",
"primaryKey": false,
"type": "string",
"GUID": "b3cb54d2-e31e-11e6-aae7-27e5e7efbb51"
},
"DoorIndicator": {
"description": "S42 name: Door Indicator, code: 30.32.0.0.2",
"primaryKey": false,
"type": "string",
"GUID": "b3cb54d3-e31e-11e6-aae7-27e5e7efbb51"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54d1-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"DoorType",
"DoorIndicator"
],
"dependencies": {
"DoorType": [
"DoorIndicator"
]
}
},
"BuildingConstruction": {
"description": "S42 name: Building/Construction Level 1, code: 30.26.1.0.0, Element identifying the \"number\" or \"name and type\" of the building, unit or construction in or adjacent to which a delivery point is located. E.g. Batiment A, Block 7, Houseboat, London Tower, ...",
"primaryKey": false,
"type": "string",
"GUID": "b3cb54d4-e31e-11e6-aae7-27e5e7efbb51"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54c7-e31e-11e6-aae7-27e5e7efbb51"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54b7-e31e-11e6-aae7-27e5e7efbb51"
},
"PostalAddress": {
"properties": {
"StructuredOtherDeliveryInformation": {
"properties": {
"DeliveryServiceType": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54d7-e31e-11e6-aae7-27e5e7efbb51"
},
"DeliveryServiceIndicator": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54d8-e31e-11e6-aae7-27e5e7efbb51"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54d6-e31e-11e6-aae7-27e5e7efbb51"
},
"StructuredDeliveryPointLocation": {
"properties": {
"StreetName": {
"properties": {
"@locale": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb54db-e31e-11e6-aae7-27e5e7efbb51",
"sample": "fr"
},
"*body": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bc0-e31e-11e6-aae7-27e5e7efbb51",
"sample": "Rue du Vivier"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54da-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"*body"
]
},
"StreetNumber": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bc1-e31e-11e6-aae7-27e5e7efbb51",
"sample": "64"
},
"BoxNumber": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bc2-e31e-11e6-aae7-27e5e7efbb51",
"sample": "84"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54d9-e31e-11e6-aae7-27e5e7efbb51"
},
"StructuredPostalCodeMunicipality": {
"properties": {
"PostalCode": {
"description": "Municipality postal code",
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bc4-e31e-11e6-aae7-27e5e7efbb51",
"sample": "1140"
},
"MunicipalityName": {
"properties": {
"@locale": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bc6-e31e-11e6-aae7-27e5e7efbb51",
"sample": "nl"
},
"*body": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bc7-e31e-11e6-aae7-27e5e7efbb51",
"sample": "Bruxelles"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb7bc5-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"*body"
]
},
"DeliveryServiceQualifier": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bc8-e31e-11e6-aae7-27e5e7efbb51"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb7bc3-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"PostalCode",
"MunicipalityName"
]
},
"CountryName": {
"properties": {
"@locale": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bca-e31e-11e6-aae7-27e5e7efbb51",
"sample": "nl"
},
"*body": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bcb-e31e-11e6-aae7-27e5e7efbb51",
"sample": "BELGIUM"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb7bc9-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"*body"
]
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54d5-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"StructuredPostalCodeMunicipality"
]
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54b6-e31e-11e6-aae7-27e5e7efbb51",
"additionalProperties": true,
"required": [
"PostalAddress"
]
},
{
"description": "Addresses can only be submitted either in address block lines (up to 7 lines of text), or in identified address components.\n\nThis branch of the choice describes the address block lines. This is not the prefered method for address recognition, but it is permitted. bpost's algorithms will attempt to parse the submitted lines and identify the different elements so they can be mapped to the standard structure of an address.",
"properties": {
"AddressBlockLines": {
"properties": {
"UnstructuredAddressLine": {
"primaryKey": false,
"additionalItems": true,
"type": "array",
"GUID": "b3cb7bce-e31e-11e6-aae7-27e5e7efbb51",
"items": {
"properties": {
"@locale": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bd0-e31e-11e6-aae7-27e5e7efbb51",
"sample": "nl"
},
"*body": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bd1-e31e-11e6-aae7-27e5e7efbb51",
"sample": "1150 Bruxelles"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb7bcf-e31e-11e6-aae7-27e5e7efbb51",
"arrayItem": true,
"required": [
"*body"
]
}
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb7bcd-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"UnstructuredAddressLine"
]
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb7bcc-e31e-11e6-aae7-27e5e7efbb51",
"additionalProperties": false
}
],
"required": [
"@id"
]
}
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54b1-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"AddressToFormat"
]
},
"CallerIdentification": {
"description": "Information about the caller of the service, in case no authentication mechanism exists. ",
"properties": {
"CallerName": {
"primaryKey": false,
"type": "string",
"GUID": "b3cb7bd6-e31e-11e6-aae7-27e5e7efbb51",
"sample": "ZALANDO"
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb7bd5-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"CallerName"
]
}
},
"primaryKey": false,
"type": "object",
"GUID": "b3cb54b0-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"AddressToFormatList"
]
}
},
"type": "object",
"required": [
"FormatAddressesRequest"
],
"resources": "/ws/ExternalMailingAddressProofingCSREST_v1/address/validateAddresses",
"transaction": "Request"
}2.1.9 Request JSON data
{
"FormatAddressesRequest": {
"AddressToFormatList": {
"AddressToFormat": [
{
"@id": "1",
"MaileeAndAddressee": {
"StructuredAddresseeIndividualIdentification": {
"AddresseeFormOfAddress": "Mr",
"AddresseeGivenName": "Jacques",
"AddresseeSurname": "Martin",
"AddresseeSupplementaryDispatchInfo": "Lorem"
},
"StructuredMaileeIndividualIdentification": {
"MaileeRole": "Lorem",
"MaileeFormOfAddress": "Lorem",
"MaileeGivenName": "Lorem",
"MaileeSurname": "Lorem"
},
"StructuredMaileeOrganizationIdentification": {
"MaileeOrganizationFunction": "Lorem",
"MaileeOrganizationOrganizationalUnit": "Lorem",
"MaileeOrganizationOrganizationalName": "Lorem",
"MaileeOrganizationLegalStatus": "Lorem"
},
"StructuredMailRecipientDispatchingInformation": {
"Wing": {
"WingType": "Lorem",
"WingIndicator": "Lorem"
},
"Stairwell": {
"StairwellType": "Lorem",
"StairwellIndicator": "Lorem"
},
"Floor": {
"FloorType": "Lorem",
"FloorIndicator": "Lorem"
},
"Door": {
"DoorType": "Lorem",
"DoorIndicator": "Lorem"
},
"BuildingConstruction": "Lorem"
}
},
"PostalAddress": {
"StructuredOtherDeliveryInformation": {
"DeliveryServiceType": "Lorem",
"DeliveryServiceIndicator": "Lorem"
},
"StructuredDeliveryPointLocation": {
"StreetName": {
"@locale": "fr",
"*body": "Rue du Vivier"
},
"StreetNumber": "64",
"BoxNumber": "84"
},
"StructuredPostalCodeMunicipality": {
"PostalCode": "1140",
"MunicipalityName": {
"@locale": "nl",
"*body": "Bruxelles"
},
"DeliveryServiceQualifier": "Lorem"
},
"CountryName": {
"@locale": "nl",
"*body": "BELGIUM"
}
},
"AddressLanguage": "nl",
"DispatchingCountryISOCode": "BE",
"DeliveringCountryISOCode": "BE"
}
]
},
"CallerIdentification": {
"CallerName": "ZALANDO"
}
}
}2.2 Document Response
2.2.1 Response Tree Diagram
2.2.2 Response Properties
| Property | Value |
| Document name | Response |
| Id | |
| Description | |
| RESTful API | true |
| Transaction | Response |
| Method | |
| EndPoint | |
| Resources | |
| Media type | application/JSON |
| Additional properties | true |
| Comments |
2.2.3 Response Fields
| Field | Type | Req | Key | Description |
| FormatAddressesResponse | document | true | ||
| FormattedAddressResultList | document | true | ||
| FormattedAddressResult | array | true | ||
| [0] | document | false | ||
| @id | string | true | ||
| Label | document | true | ||
| Line | array | true | ||
| [0] | string | false | ||
| Error | array | false | ||
| [0] | document | false | ||
| ErrorCode | string | true | ||
| ErrorSeverity | string | true | ||
| GeneralError | document | false | ||
| ErrorCode | string | true | ||
| ErrorSeverity | string | true |
2.2.3.1 Field FormatAddressesResponse
2.2.3.1.1 FormatAddressesResponse Tree Diagram
2.2.3.1.2 FormatAddressesResponse Hierarchy
Parent field: Response
Child field(s):
| Field | Type | Req | Key | Description |
| FormattedAddressResultList | document | true | ||
| GeneralError | document | false |
FormatAddressesResponse properties
| Property | Value |
| Name | FormatAddressesResponse |
| Id | |
| Type | document |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min Properties | |
| Max Properties | |
| Additional properties | |
| Comments |
2.2.3.2 Field FormattedAddressResultList
2.2.3.2.1 FormattedAddressResultList Tree Diagram
2.2.3.2.2 FormattedAddressResultList Hierarchy
Parent field: FormatAddressesResponse
Child field(s):
| Field | Type | Req | Key | Description |
| FormattedAddressResult | array | true |
FormattedAddressResultList properties
| Property | Value |
| Name | FormattedAddressResultList |
| Id | |
| Type | document |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min Properties | |
| Max Properties | |
| Additional properties | |
| Comments |
2.2.3.3 Field FormattedAddressResult
2.2.3.3.1 FormattedAddressResult Tree Diagram
2.2.3.3.2 FormattedAddressResult Hierarchy
Parent field: FormattedAddressResultList
Child field(s):
| Field | Type | Req | Key | Description |
| document | false |
FormattedAddressResult properties
| Property | Value |
| Name | FormattedAddressResult |
| Id | |
| Type | array |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min items | 1 |
| Max items | 200 |
| Unique items | |
| Additional items | true |
| Comments |
2.2.3.4 Field
2.2.3.4.1 [0] Tree Diagram
2.2.3.4.2 [0] Hierarchy
Parent field: FormattedAddressResult
Child field(s):
| Field | Type | Req | Key | Description |
| @id | string | true | fk | |
| Label | document | true | ||
| Error | array | false |
[0] properties
| 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 |
2.2.3.5 Field @id
2.2.3.5.1 @id Tree Diagram
2.2.3.6 Field Label
2.2.3.6.1 Label Tree Diagram
2.2.3.6.2 Label Hierarchy
Parent field:
Child field(s):
| Field | Type | Req | Key | Description |
| Line | array | true |
Label properties
| Property | Value |
| Name | Label |
| Id | |
| Type | document |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min Properties | |
| Max Properties | |
| Additional properties | |
| Comments |
2.2.3.7 Field Line
2.2.3.7.1 Line Tree Diagram
2.2.3.7.2 Line Hierarchy
Parent field: Label
Child field(s):
| Field | Type | Req | Key | Description |
| string | false |
Line properties
| Property | Value |
| Name | Line |
| Id | |
| Type | array |
| Description | |
| Dependencies | |
| Required | true |
| Primary key | false |
| Foreign document | |
| Foreign field | |
| Relationship type | |
| Min items | |
| Max items | |
| Unique items | |
| Additional items | true |
| Comments |
2.2.3.8 Field
2.2.3.8.1 [0] Tree Diagram
[0] properties
| 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 |
2.2.3.9 Field Error
2.2.3.9.1 Error Tree Diagram
2.2.3.9.2 Error Hierarchy
Parent field:
Child field(s):
| Field | Type | Req | Key | Description |
| document | false |
Error properties
| 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 |
2.2.3.10 Field
2.2.3.10.1 [0] Tree Diagram
2.2.3.10.2 [0] Hierarchy
Parent field: Error
Child field(s):
| Field | Type | Req | Key | Description |
| ErrorCode | string | true | ||
| ErrorSeverity | string | true |
[0] properties
| 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 |
2.2.3.11 Field ErrorCode
2.2.3.11.1 ErrorCode Tree Diagram
ErrorCode properties
| 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 |
2.2.3.12 Field ErrorSeverity
2.2.3.12.1 ErrorSeverity Tree Diagram
ErrorSeverity properties
| 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 |
2.2.3.13 Field GeneralError
2.2.3.13.1 GeneralError Tree Diagram
2.2.3.13.2 GeneralError Hierarchy
Parent field: FormatAddressesResponse
Child field(s):
| Field | Type | Req | Key | Description |
| ErrorCode | string | true | ||
| ErrorSeverity | string | true |
GeneralError properties
| 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 |
2.2.3.14 Field ErrorCode
2.2.3.14.1 ErrorCode Tree Diagram
ErrorCode properties
| 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 |
2.2.3.15 Field ErrorSeverity
2.2.3.15.1 ErrorSeverity Tree Diagram
ErrorSeverity properties
| 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 |
2.2.7 Response Definitions (TBD)
2.2.8 Response JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Response",
"isRestfulApi": true,
"mediaType": "application/JSON",
"properties": {
"FormatAddressesResponse": {
"properties": {
"FormattedAddressResultList": {
"properties": {
"FormattedAddressResult": {
"primaryKey": false,
"additionalItems": true,
"type": "array",
"GUID": "bbcb3682-e31e-11e6-aae7-27e5e7efbb51",
"items": {
"properties": {
"@id": {
"primaryKey": false,
"type": "string",
"GUID": "bbcb3684-e31e-11e6-aae7-27e5e7efbb51",
"sample": "1"
},
"Label": {
"properties": {
"Line": {
"primaryKey": false,
"additionalItems": true,
"type": "array",
"GUID": "bbcb3687-e31e-11e6-aae7-27e5e7efbb51",
"items": {
"primaryKey": false,
"type": "string",
"GUID": "bbcb3688-e31e-11e6-aae7-27e5e7efbb51",
"arrayItem": true,
"sample": "Mr Jacques Martin Lorem"
}
}
},
"primaryKey": false,
"type": "object",
"GUID": "bbcb3686-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"Line"
]
},
"Error": {
"primaryKey": false,
"additionalItems": true,
"type": "array",
"GUID": "bbcb3689-e31e-11e6-aae7-27e5e7efbb51",
"items": {
"properties": {
"ErrorCode": {
"primaryKey": false,
"type": "string",
"GUID": "bbcb368b-e31e-11e6-aae7-27e5e7efbb51"
},
"ErrorSeverity": {
"primaryKey": false,
"type": "string",
"GUID": "bbcb368c-e31e-11e6-aae7-27e5e7efbb51",
"enum": [
"warning",
"error"
]
}
},
"primaryKey": false,
"type": "object",
"GUID": "bbcb368a-e31e-11e6-aae7-27e5e7efbb51",
"arrayItem": true,
"additionalProperties": true,
"required": [
"ErrorCode",
"ErrorSeverity"
]
},
"uniqueItems": false
}
},
"primaryKey": false,
"type": "object",
"GUID": "bbcb3683-e31e-11e6-aae7-27e5e7efbb51",
"arrayItem": true,
"required": [
"@id",
"Label"
]
},
"maxItems": 200,
"minItems": 1
}
},
"primaryKey": false,
"type": "object",
"GUID": "bbcb3681-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"FormattedAddressResult"
]
},
"GeneralError": {
"properties": {
"ErrorCode": {
"primaryKey": false,
"type": "string",
"GUID": "bbcb368e-e31e-11e6-aae7-27e5e7efbb51"
},
"ErrorSeverity": {
"primaryKey": false,
"type": "string",
"GUID": "bbcb368f-e31e-11e6-aae7-27e5e7efbb51"
}
},
"primaryKey": false,
"type": "object",
"GUID": "bbcb368d-e31e-11e6-aae7-27e5e7efbb51",
"additionalProperties": true,
"required": [
"ErrorCode",
"ErrorSeverity"
]
}
},
"primaryKey": false,
"type": "object",
"GUID": "bbcb3680-e31e-11e6-aae7-27e5e7efbb51",
"required": [
"FormattedAddressResultList"
]
}
},
"type": "object",
"additionalProperties": true,
"required": [
"FormatAddressesResponse"
],
"transaction": "Response"
}2.2.9 Response JSON data
{
"FormatAddressesResponse": {
"FormattedAddressResultList": {
"FormattedAddressResult": [
{
"@id": "1",
"Label": {
"Line": [
"Mr Jacques Martin Lorem"
]
},
"Error": [
{
"ErrorCode": "Lorem",
"ErrorSeverity": "error"
}
]
}
]
},
"GeneralError": {
"ErrorCode": "Lorem",
"ErrorSeverity": "Lorem"
}
}
}3. Relationships
3.1 Relationship AddressID
3.1.1 AddressID Diagram
| Parent Table | Parent field |
| Request | FormatAddressesRequest.AddressToFormatList.AddressToFormat.[0].@id |
| Child Table | Child field |
| Response | FormatAddressesResponse.FormattedAddressResultList.FormattedAddressResult.[0].@id |