The AddressCheck service consists of two separate endpoints. The first accepts a batch of customer addresses to check, whereas the second returns the results if processing has completed:
- SubmitAddressCheck
- FetchAddressCheck
Visit the links above to see detailed information about the two endpoints.
The rest of this document describes common aspects for both endpoints.
Concepts and notation
- source : the system that makes the decision on whether the address is supported. The use of a delivererMask may affect which source processes the customer address.
- uuid : a unique identifier returned by the service when a batch of customer addresses are submitted for processing. Is used later in a subsequent request to inform the service which batch is targeted.
- expiry : the results of a processed batch will expire a certain time after the request has been completed. The status of the batch is reported in the service response.
- proxy timeout : describes when the service will cancel outstanding requests to other source systems. All associated customer addresses will be marked as not supported.
- delivererMask : a mechanism to tell the service that an address should be marked as unsupported, or to specify a set of distribution companies that qualify (all others are then disqualified and will not be considered).
Configuration parameters
Describes important configuration parameters affecting use of the service.
Server side
- expiry time : 15 minutes after the request has been processed. (TODO: Agree on / discuss this one)
- job timeout : 45 mintues (TODO: Agree on / discuss this one)
- maximum customer addresses per request : 10'000
Client side
- WS-Security:
- time to live (TTL) : the TTL describes how long the SOAP request is valid, and must be specified due to the security processing.
- username / password : a valid username and password is required to access the service.