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 |
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 |
Field | Type | Req | Key | Description |
AddressToFormatList | document | true | ||
CallerIdentification | document | false | Information about the caller of the service, in case no authentication mechanism exists. |
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 |
Field | Type | Req | Key | Description |
AddressToFormat | array | true |
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 |
Field | Type | Req | Key | Description |
document | false |
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 |
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. |
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 | @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 |
[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. |
Property | Value |
Choice | oneOf |
Field | Type | Req | Key | Description |
MaileeAndAddressee | document | false | ||
PostalAddress | document | true |
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 |
Field | Type | Req | Key | Description |
StructuredAddresseeIndividualIdentification | document | false | ||
StructuredMaileeIndividualIdentification | document | false | ||
StructuredMaileeOrganizationIdentification | document | false | ||
StructuredMailRecipientDispatchingInformation | document | false |
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 |
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 |
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 | |
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 |
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 | |
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 |
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 | |
Comments |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
StructuredOtherDeliveryInformation | document | false | ||
StructuredDeliveryPointLocation | document | false | ||
StructuredPostalCodeMunicipality | document | true | ||
CountryName | document | false |
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 |
Field | Type | Req | Key | Description |
DeliveryServiceType | string | false | ||
DeliveryServiceIndicator | string | false |
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 |
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 |
StreetName | document | false | ||
StreetNumber | string | false | ||
BoxNumber | string | false |
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 |
Field | Type | Req | Key | Description |
@locale | string | false | ||
*body | string | true |
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 |
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 |
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 |
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 |
PostalCode | string | true | Municipality postal code | |
MunicipalityName | document | true | ||
DeliveryServiceQualifier | string | false |
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 | 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 |
Field | Type | Req | Key | Description |
@locale | string | false | ||
*body | string | true |
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 |
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 |
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 |
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 |
Field | Type | Req | Key | Description |
@locale | string | false | ||
*body | string | true |
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 |
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 |
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 |
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 | false |
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 |
document | false |
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 |
Field | Type | Req | Key | Description |
@locale | string | false | ||
*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 | @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 |
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 | 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 | 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 |
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 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" }
{ "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" } } }
Property | Value |
Document name | Response |
Id | |
Description | |
RESTful API | true |
Transaction | Response |
Method | |
EndPoint | |
Resources | |
Media type | application/JSON |
Additional properties | true |
Comments |
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 |
Field | Type | Req | Key | Description |
FormattedAddressResultList | document | true | ||
GeneralError | document | false |
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 |
Field | Type | Req | Key | Description |
FormattedAddressResult | array | true |
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 |
Field | Type | Req | Key | Description |
document | false |
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 |
Field | Type | Req | Key | Description |
@id | string | true | fk | |
Label | document | true | ||
Error | array | 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 |
Line | array | true |
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 |
Field | Type | Req | Key | Description |
string | false |
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 |
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 |
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 |
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 | 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 |
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", "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" }
{ "FormatAddressesResponse": { "FormattedAddressResultList": { "FormattedAddressResult": [ { "@id": "1", "Label": { "Line": [ "Mr Jacques Martin Lorem" ] }, "Error": [ { "ErrorCode": "Lorem", "ErrorSeverity": "error" } ] } ] }, "GeneralError": { "ErrorCode": "Lorem", "ErrorSeverity": "Lorem" } } }
Parent Table | Parent field |
Request | FormatAddressesRequest.AddressToFormatList.AddressToFormat.[0].@id |
Child Table | Child field |
Response | FormatAddressesResponse.FormattedAddressResultList.FormattedAddressResult.[0].@id |