...
Depending on the current state, the service may return the results or a status indicating what is happening or what happened with the request.
FetchAddressCheckRequest
| 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 |
FetchAddressCheckResponse
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 |
State descriptions
Note that all statues except QUEUED and INPROGRESS are terminal. If the client receives a terminal response, new further requests should be sent to the service for the given UUID.
...
This terminal result state means that the batch has been processed and that the partial results are included in the response. Partial means that one or more processing units (authorities, or source systems, ) were unavailable and/or timed out. This means that the items associated with that unit all have supportedByCarrier unconditionally set to false.
...
This can take place as long as the batch hasn't expired. If the batch has expired, the service will return INVALID_UUID.
REJECTED_BUSY
This terminal error state means that the system is overloaded, and that the processing queue is full. Try again later.
...
This terminal error state means that the system spent too much time to process the batch. This may be caused by high load on the system. Try again later, or split the batch into smaller batches.
AddressCoverage
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 authority / source system that made the decision about the customer address being supported by carrier or not. The value NOT_PROCESSED indicates that the item for some reason wasn't processed by any authority (due to an error state). These will have supportedByCarrier unconditially set to false. | DI | 1 |
| company | Name of the qualifying distribution company. | MANU | 0 - 1 |
| terminal | Terminal name, if any. | MALAP | 0 -1 |
| transport | Main car number. | 8500 Some name | 0 - 1 |
| subTransport | Sub car name, if any. | Some name. | 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 |
| deliveryPointId | Numeric identifier for the delivery point found for the customer address. Typically fed back into the source system to speed up subsequent processes, for instance parcel creation. | 6734687 | 0 - 1 |
| location |
| Name / address of the pick-up point. | Patamäenkatu 9 | 0 - 1 | |
| locationDirections | Directions associated with the pick-up point. | Free text. | 0 -1 |
The field supportedByCarrier determines whether the fields with count 0 - 1 will be present (true) or not, except for when skipRouteCheck has been set to true. In that case, there will be no route information even though supportedByCarrier may be true but deliveryPointId may be set to aid troubleshooting.
Files
| View file | ||||
|---|---|---|---|---|
|
| View file | ||||
|---|---|---|---|---|
|