Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

TBD

FetchAddressCheckRequest

TBD

FetchAddressCheckResponse

Field
Description
Example
Count
uuid

Unique identifier for the processing unit, obtained in the response for the SUBMIT action.

388f70cd-3e0c-4be6-a51a-35f32e7e96d9

1
nextAction

Describes what the client should do next:

  • STOP : stop sending more requests for this UUID to the service
  • REPEAT : send a new request with this UUID to get updated information

 

STOP

1
status

Describes the current status of the unit:

  • QUEUED
  • INPROGRESS
  • COMPLETED (terminal)
  • FAILED (terminal)
  • REJECTED-BUSY (terminal)

Terminal statuses will have the next action set to STOP.

 

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.

The client shuld provide reasonable min, max and default values for the delay.

1200 - 1
skipRouteCheckWhether the route check was performed or not for the customer addreses in the unit.false1
requireExactMatchWhether an exact match on a customer address was required to mark it as supported.false1
productProduct name for the unit.

AFM

1
customerSystemName of the customer system for the unit.

AFT

1
batchIdClient-side identifier for the unit (can be empty). 1
addressCoverage

Describes a customer, whether his/her address is supported, and gives transport information if supported.
See detailed description of the addressCoverage entity below.

Whether there are zero or more address coverage items depends on the nextAction field.
If it is STOP there will be as many items as received when the batch was submitted through SubmitAddressCheckV1.
If it is REPEAT there will be zero  address coverage items.

 0 - 10'000