QASearch defines a search requestThe child elements are as follows:Country : The country data set to useEngine : The search engine to use, and any engine specific configuration settingsLayout : The layout to use when creating a formatted address (required by verification engine only)Search : The actual search stringQABulkSearch defines a bulk search requestNote that the bulk search will only use the verification engine.The child elements are as follows:Country : The country data set to useEngine : Only verification engine specific configuration settings are honoured.Layout : The layout to use when creating a formatted address (required by verification engine only)BulkSearch : Element containing the actual search strings within multiple:DataIDType defines a data identifier, a 3 charater codeEngineType specifies the engine to use for a search, and any engine optionsThe various attributes are as follows:Flatten : Whether or not to flatten the picklist returned by the searchIntensity : How hard the search engine will search to get a matchPromptSet : The prompt set to apply to the search stringThreshold : The typedown threshold (typedown engine only)Timeout : The time out period in millisecondsThe available enginesThe picklist threshold - the maximum size of the picklistThe available searching intensity levelsThe server searching timeout - how long before a search is aborted (milliseconds)The available prompt setsQASearchResult describes the results of a searchThe child elements are as follows:QAPicklist : The picklist produced by the search
QAAddress : A formatted address produced by the search.
Note that only the verification engine will ever produce a formatted address.
Other engines will only ever produce a picklist.
The VerifyLevel attribute specifies the level to which the verification engine has
verified the input address. It can be ignored when using all other engines.
QABulkSearchResult describes the results of a bulk searchThe child elements are as follows:BulkAddress : one element for each search string from the original searchQABulkSearchItemType describes a bulk search result itemThe child elements are as follows:Address : a formatted address itemInputAddress : the original address as inputThe attributes are as follows:
VerifyLevel : The VerifyLevel attribute specifies the level to which the verification engine has
verified the input address.
The possible verification levelsQARefine defines a refinement requestThe child elements are as follows:Moniker : The Search Point Moniker to refineRefinement : The refinement textQAConfig : The server side configuration file and section to useThe attributes are as follows:Threshold : The picklist threshold (i.e. the maximum size of the picklist)Timeout : The timeout period in millisecondsPicklist describes a returned picklistQAPicklistType describes a picklistThe child elements are as follows:FullPicklistMoniker : The Search Point Moniker that describes the entire picklistPicklistEntry : The actual picklist entriesPrompt : The prompt to display to the user, indicating what information they should enter nextTotal : The total number of available resultsThe attributes are as follows:AutoFormatSafe : It is suggested that you immediately format the first picklist itemAutoFormatPastClose : There is only one exact match, so you may want immediately to format the first picklist itemAutoStepInSafe : It is suggested that you immediately step-in to the first picklist itemAutoStepInPastClose : There is only one exact match, so you may want immediately to step-in to the first picklist itemLargePotential : Potentially, there are too many results to displayMaxMatches : The number of results exceeded the maximum allowedMoreOtherMatches : There are additional matches that can be displayedOverThreshold : There are more picklist items than the threshold valueTimeout : The search/refinement timed outPicklistEntryType describes an entry in a picklistThe child elements are as follows:Moniker : The Search Point Moniker that represents this picklist entryPartialAddress : The full details of the address captured so farPicklist : The picklist text to displayPostcode : The postcode to displayScore : The percentage score assigned to the matchThe attributes are as follows:FullAddress : This picklist entry is a full deliverable addressMultiples : This entry represents multiple address linesCanStep : This entry can be stepped intoAliasMatch : This match is an aliasPostcodeRecoded : This entry has a recoded postcodeCrossBorderMatch : This entry represents a nearby area, outside the strict initial boundaries of the searchDummyPOBox : This entry is the dummy PO Box entryName : This entry is a Names resultInformation : This entry is an informational promptWarnInformation : This entry is a warning informational promptIncompleteAddr : This entry is the dummy item (for premise-less countries)UnresolvableRange : This entry is a static range item that cannot be expandedPhantomPrimaryPoint : This entry is a Phantom Primary Point (AUS only)QAGetAddress defines a request for a formatted addressThe child elements are as follows:Layout : The layout to useMoniker : The Search Point Moniker of the picklist entry to formatQAAddressType describes a formatted addressThe child elements are as follows:AddressLine : The individual lines of the addressThe attributes are as follows:Overflow : There are not enough address lines configured to display the whole addressTruncated : Truncation has occurred on one or more address linesAddressLineType describes one line of a formatted addressThe child elements are as follows:Label : The name of any address element fixed to this lineLine : The formatted address lineDataplusGroup: Dataplus groups associated with this lineThe attributes are as follows:LineContent : The type of data on this lineOverflow : Some address elements were lost from this lineTruncated : Truncation occurred on this lineQAData describes all of the data sets that are availableDataSet : details of a data setQADataSet describes a data setChild elements are as follows:ID : Three letter data set IDName : Full name of data setQAGetData is an empty element for the GetData messageQAGetLicenseInfo is an empty element for the GetLicenseInfo messageQAGetSystemInfo is an empty element for the GetSystemInfo messageQAGetDataMapDetail describes a request for data map detail informationQADataMapDetail contains details of all datasets in a given data mapQALicenceInfo describes all of the licence information for each data setChild elements are as follows:WarningLevel : Warning level for the set of licensed dataLicensedSet : Details of a licensed data setQALicensedSet describes a licensed data setChild elements are as follows:ID : Data set IDDescription : Full description of data setCopyright : Copyright informationVersion : Version of the dataBaseCountry : Data ID of the country to which this data set is an extensionStatus : A string describing the state of the dataServer : The name of the server where the data set is being usedWarningLevel : The warning level for the data setDaysLeft : The number of days before the data set is unusableDataDaysLeft : The number of days before the data expiresLicenceDaysLeft : The number of days before the licence expiresQASystemInfo describes the current state of the systemQAGetExampleAddresses defines a request for the example addresses for a given data setChild elements are as follows:Country : The country data set to get example addresses forLayout : The layout to use to format the example addressesQAExampleAddresses describes all of the example addresses for a data setQAExampleAddress describes an example addressChild elements are as follows:Address : The formatted example addressComment : A comment describing the addressQAGetLayouts defines a request for a list of all the available layoutsChild elements are as follows:Country : The country data set to get layouts forQALayouts describes all the available layouts for a data setQALayout describes a layoutChild elements are as follows:Name : The name of the layoutComment : A comment describing the layoutQAGetPromptSet defines a request for details of a prompt setChild elements are as follows:Country : The country data setPromptSet : The prompt set to get details ofQAPromptSet describes a prompt setChild element:Line : Describes one line of the prompt setPromptLine describes a line of a prompt setChild elements are as follows:Prompt : The prompt to display to the userSuggestedInputLength : The suggested length of the input bufferExample : An example of possible inputQACanSearch returns a boolean specifying whether a search is possible for aspecific country, engine and layoutChild elements are as follows:Country : The country data setEngine : The search engine to use, and any engine specific configuration settingsLayout : The layout with which to format the addressQASearchOK is the response from a CanSearch operation.Child elements are as follows:IsOk : Boolean stating whether searching is availableErrorCode : The QAS error code returnedErrorMesage : A textual description of the errorErrorDetail : Detailed error history