Versions Compared

Key

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

...

Field
Description
Example
Data typeSize
Count
uuid

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

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

UUID (String)361
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

String4 | 61
status

Describes the current status of the unit.

Processing statesResult statesError states

QUEUED

COMPLETED

 

REJECTED_BUSY

INPROGRESS

 

 

FAILED
 

COMPLETED_RESENT

 

INVALID_UUID
  EXCEEDED_MAX_PROCESSING_TIME

Terminal statuses are all result states and error states.
They have the nextAction field set to STOP, which means that the client should stop sending requests to the service with that UUID.

See more detailed descriptions of the states below.

INPROGRESS

String6 - 281
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 should also ensure reasonable min, max and default values for the delay on their end.

120Integer 1
productProduct name for the unit.

AFM

String101
customerSystemName of the customer system for the unit.

AFT

String51
batchIdClient-side identifier for the unit (may be empty). String-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 SubmitAddressCheckV2.
If it is REPEAT there will be zero  address coverage items.

 --0 - 10'000

...