API

 

Overview

 
The API will permit developers to integrate a postal sort into their application. It will permit the developer to
 
  • Launch a sort specifying an existing xml project definition file* to define the sort criteria.
  • Allow the calling application to monitor sort progress with live sort progress details. Progress is provided via a callback delegate supplied as a parameter when invoking the RunSort method.
  • Receive a result code that indicates success or failure once the sort has completed.
 
The XML project definition file must conform to the Product Definition specification.  The SwiftSort user interface can be used to create such a definition file. The API works very much like the command line application its advantage is that it permits SwiftSort to be tightly integrated into your application. Where tight integration is not necessary the command line application will be quicker to get up and running.