...
Field | Description | Example | Count | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| uuid | Unique identifier for the processing unit, obtained in the response for the SUBMIT (SubmitAddressCheckV1) action. | 388f70cd-3e0c-4be6-a51a-35f32e7e96d9 | 1 | |||||||||||||||
| nextAction | Describes what the client should do next:
| STOP | 1 | |||||||||||||||
| status | Describes the current status of the unit.
Terminal statuses are all result states and error states. See more detailed descriptions of the states below. | INPROGRESS | 1 | |||||||||||||||
| secondsDelay | A hint from the server that may be provided if the server known when the status of the unit is likely to change. Defaults to two minutes. The client shuld provide reasonable min, max and default values for the delay. | 120 | 1 | |||||||||||||||
| product | Product name for the unit. | AFM | 1 | |||||||||||||||
| customerSystem | Name of the customer system for the unit. | AFT | 1 | |||||||||||||||
| batchId | Client-side identifier for the unit (may be empty). | 1 | ||||||||||||||||
| skipRouteCheck | Whether the route check was performed or not for the customer addreses in the unit. | false | 1 | |||||||||||||||
| requireExactMatch | Whether an exact match on a customer address was required to mark it as supported. | false | 1 | |||||||||||||||
| transportDate | The transport date used by the system to obtain the address coverage results. Format is yyyy-mm-dd. | 2015-12-21 | 1 | |||||||||||||||
| deliveryDate | The delivery date used by the system to obtain the address coverage results. Format is yyyy-mm-dd. | 2015-12-21 | 1 | |||||||||||||||
| addressCoverage | Describes a customer, whether his/her address is supported, and gives transport information if supported. Whether there are zero or more address coverage items depends on the nextAction field. | 0 - 10'000 |
...
Field | Description | Example | Count |
|---|---|---|---|
| customerId | Unique identifier for the processing unit, obtained in the response for the SUBMIT (SubmitAddressCheckV1) action. |
| 1 |
| supportedByCarrier | Whether the customer address is covered by carrier. | true | 1 |
| authority | The source system that made the decision about the customer address being supported by carrier or not. | DI | 1 |
| company | Name of the qualifying distribution company. | MANU | 0 - 1 |
| transport | What is this precieslyprecisely? | 8500 | 0 - 1 |
| rotueNo | Route number of the covering route. | 523443 | 0 - 1 |
| routeName | Name of covering route. | Keskusta 201 | 0 - 1 |
| addrSeq | Address sequence defining sorting on the associated route. | 51 | 0 - 1 |
| location | What is this precieslyprecisely? | Patamäenkatu 9 | 0 - 1 |
The field supportedByCarrier determines whether the fields with count 0 - 1 will be present (true) or not.