FetchAddressCheckV2
- Cato LΓΈkseth
- Former user (Deleted)
- Former user (Deleted)
Fetches the results for the specified address check request.
Depending on the current state, the service may return the results or a status indicating what is happening or what happened with the request.
Can be accessed with a GET against this end point: https://ws.di.no/ws/json/addressCheck/v-2/fetch/{uuid} where {uuid} is the uuid that you got from the submit.
There is also a V3 of the fetch that can be access on https://ws.di.no/ws/json/addressCheck/v-3/fetch/{uuid} In V3 the sortkey field have slightly different content.
Any fields included in the response that are not described in the documentation, are not guaranteed to be stable. They may disappear without notice.
FetchAddressCheckRequest
| Field | Description | Example | Data type | Size | Count |
|---|---|---|---|---|---|
| uuid | Unique identifier for the processing unit, obtained in the response for the SUBMIT (SubmitAddressCheckV2) action. | 388f70cd-3e0c-4be6-a51a-35f32e7e96d9 | UUID (String) | 36 | 1 |
FetchAddressCheckResponse
Field | Description | Example | Data type | Size | Count | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| uuid | Unique identifier for the processing unit, obtained in the response for the SUBMIT (SubmitAddressCheckV2) action. | 388f70cd-3e0c-4be6-a51a-35f32e7e96d9 | UUID (String) | 36 | 1 | |||||||||||||||
| nextAction | Describes what the client should do next:
| STOP | String | 4 | 6 | 1 | |||||||||||||||
| resultStatus | 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 | String | 6 - 28 | 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 should also ensure reasonable min, max and default values for the delay on their end. | 120 | Integer | 1 | ||||||||||||||||
| product | Product name for the unit. | AFM | String | 10 | 1 | |||||||||||||||
| customerSystem | Name of the customer system for the unit. | AFT | String | 5 | 1 | |||||||||||||||
| batchId | Client-side identifier for the unit (may be empty). | String | - | 1 | ||||||||||||||||
| skipRouteCheck | ||||||||||||||||||||
| requireExactMatch | ||||||||||||||||||||
| 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.
QUEUED
This processing states means that the batch has been received by service, and it is waiting to be processed.
INPROGRESS
This processing states means that the batch has been received by the service and is currently being processed.
COMPLETED
This terminal result state means that the batch has been processed and that the results are included in the response.
COMPLETED_RESENT
This terminal result state means that the batch has been processed, that the results have been sent already at least once. The results are included in the response. The previous result state was COMPLETED.
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.
FAILED
This terminal error state means that an error casued the batch processing to fail. Try the request again, check your input data, and if the error persists, contact DI.
INVALID_UUID
This terminal error state means that the system has no knowledge about the UUID in the request.
EXCEEDED_MAX_PROCESSING_TIME
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 | Data type | Size | Count |
|---|---|---|---|---|---|
| referenceId | Customer identifier. Must be unique within the customerSystem. | String | 37 | 1 | |
| date | Estimated distribution date by carrier. | 2016-06-01 | Date (YYYY-MM-DD) | 10 | 1 |
| supportedByCarrier | Whether the customer address is covered by carrier. | true | Boolean | 4 | 5 | 1 |
| geoLocation | Describes the geographical area. Current values are 1, 2 and 3. | 1 | Integer | 1 | 0 - 1 |
| authority | Who produced this information | ||||
| company | Name of the qualifying distribution company. | SDØ | String | <= 5 | 0 - 1 |
| routeNr | Route number of the covering route. | 21618 | String | 10 | 0 - 1 |
| routeName | |||||
| addrSeq | Address sequence defining sorting on the associated route. | 51 | Integer | 3 | 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 | Integer | - | 0 - 1 |
| transport | Main car number. | 8500 | Integer | - | 0 - 1 |
| subTransport | Sub car name, if any. | Some name. | String | - | 0 - 1 |
| location | Name / address of the pick-up point. | Rostedsgate 8 | varchar | 60 | 0 - 1 |
| locationDirections | Directions associated with the pick-up point. | Free text. | varchar | 60 | 0 - 1 |
| sortKey | Key that can be used to sort the addresses in the sequence they should be packaged. Key will contain several geographical parts and sorting terms:
"%05d%05d%05d%05d%05d%05d%07d%05d" In the V3 version the string consists of these fields:
"%05d%010d%010d%010d%05d" In the V5 version the string consists of these fields:
"%05d%010d%010d%010d%05d" | 003001234500123401230001212345671234512345 | Integer | 42 | 0 - 1 |
| linkedAddress | - | - | ? | ||
| transportDescription | A string that describes the transport information, on the format: XXXX-yy/ZZZZ-øø-grenbil1 x025117x500 XXXX - Main car number on the pre transport transport ZZZZ - Main car number grenbil1 - Name of subcar x025117 - x + Routenumber | XXXX-yy/ZZZZ-øø-grenbil1 x025117x500 | String | 36 | 0 - 1 |
In version `v4` of the fetch endpoint, the following data is added to the `v3` version if such information exists:
Field | Description | Example | Data type | Size | Count |
|---|---|---|---|---|---|
| handoverLocationId | Customer-specific id associated with the handover location. | 123456 | String | 0 - 1 | |
| handoverLocationCity | The city of the handover location. | OSLO | String | 0 - 1 | |
| handoverLocationZipCode | The zip code of the handover location. | 383 | Integer | 1 - 5 | 0 - 1 |
| handoverLocationStreetName | The street name of the handover location. | My Street | String | 0 - 1 | |
| handoverLocationStreetNumber | The street number of the handover location. | 61 | Integer | 0 - 1 | |
| handoverLocationDescription | A free-text description of the handover location. | String | 0 - 1 |
linkedAddress
Field | Description | Example | Data type | Size | Count |
|---|---|---|---|---|---|
| countryCode | The country of the address. | NO | String | 2 | 1 |
| postalName | City / place of the address. | Oslo | String | <= 30 | 1 |
| zipCode | Zip code of the address. | 2500, 186 (leading zeros are stripped, this is postal code "0186" in Norway) | Integer | 5 | 1 |
| address | Customer address. This can include street, house number, entrance and appartment number. | Christian Krohgs gate 54 | String | <= 60 | 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.
%05d%010d%010d%010d%05d