RequestTagType defines a transaction(s) identifierQASearch defines a search requestThe child elements are as follows:Country : The country dataset 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 stringFormattedAddressInPicklist: Please refer to the associated Pro On Demand web service documentation for information about this feature.RequestTag : String for marking requestLocalisation : Please refer to the associated Pro On Demand web service documentation for information about this feature.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.
VerificationFlags : Please refer to the associated Pro On Demand web service documentation for information about this feature.
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.
The possible verification levelsQARefine defines a refinement requestThe child elements are as follows:Moniker : The Search Point Moniker to refineRefinement : The refinement textLayout : The layout to use when creating a formatted address (used in certain scenarios for formatting picklist text)FormattedAddressInPicklist: Please refer to the associated Pro On Demand web service documentation for information about this feature.The attributes are as follows:Threshold : The picklist threshold (i.e. the maximum size of the picklist)Timeout : The timeout period in millisecondsLocalisation : Please refer to the associated Pro On Demand web service documentation for information about this feature.RequestTag : String for marking requestPicklist 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 matchQAAddress : The Full Address for the monikerThe 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)SubsidiaryData : This entry is from the subsidiary rather than the base datasetExtendedData : This entry is from the base dataset but extended by the subsidiary datasetEnhancedData : This entry is from the base dataset but enhanced by the subsidiary data setQAGetAddress 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 formatLocalisation : Please refer to the associated Pro On Demand web service documentation for information about this feature.RequestTag : String for marking requestQAAddressType 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 linesDPVStatus : DPV Status for the AddressMissingSubPremise: Please refer to the associated Pro On Demand web service documentation for information about this feature.DPVStatusType specifies the DPVStatus for an AddressThe various attributes are as follows:DPVNotConfigured : DPV has not been configured in the LayoutDPVConfigured : DPV has been configured in the LayoutDPVConfirmed : The Address is DPV ConfirmedDPVConfirmedMissingSec : The Address is DPV Confirmed but has Missing or Incorrect secondary informationDPVNotConfirmed : The Address is NOT DPV ConfirmedDPVLocked : DPV Address Detail Retrieval is LockedDPVSeedHit : The Address is a DPV SeedAddressLineType 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 datasets that are availableDataSet : Details of a datasetQADataSet describes a datasetChild elements are as follows:ID : Three letter dataset IDName : Full name of datasetQAGetData defines a data for GetData messageLocalisation : Please refer to the associated Pro On Demand web service documentation for information about this feature.QAGetLicenseInfo defines a data for the GetLicenseInfo messageLocalisation : Please refer to the associated Pro On Demand web service documentation for information about this feature.QAGetSystemInfo a data for the GetSystemInfo messageLocalisation : Please refer to the associated Pro On Demand web service documentation for information about this feature.QAGetDataMapDetail describes a request for data map detail informationLocalisation : Please refer to the associated Pro On Demand web service documentation for information about this feature.QADataMapDetail contains details of all datasets in a given data mapQALicenceInfo describes all of the licence information for each datasetChild elements are as follows:WarningLevel : Warning level for the set of licensed dataLicensedSet : Details of a licensed datasetQALicensedSet describes a licensed datasetChild elements are as follows:ID : Dataset IDDescription : Full description of datasetCopyright : Copyright informationVersion : Version of the dataBaseCountry : Data ID of the country to which this dataset is an extensionStatus : A string describing the state of the dataServer : The name of the server where the dataset is being usedWarningLevel : The warning level for the datasetDaysLeft : The number of days before the dataset is unusableDaysLeft : The number of days before the dataset is unusableLicenceDaysLeft : 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 datasetChild elements are as follows:Country : The country dataset to get example addresses forLayout : The layout to use to format the example addressesLocalisation : Please refer to the associated Pro On Demand web service documentation for information about this feature.RequestTag : String for marking requestQAExampleAddresses describes all of the example addresses for a datasetQAExampleAddress 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 dataset to get layouts forLocalisation : Please refer to the associated Pro On Demand web service documentation for information about this feature.QALayouts describes all the available layouts for a datasetQALayout 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 datasetPromptSet : The prompt set to get details ofLocalisation : Please refer to the associated Pro On Demand web service documentation for information about this feature.QAPromptSet 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 datasetEngine : The search engine to use, and any engine specific configuration settingsLayout : The layout with which to format the addressLocalisation : Please refer to the associated Pro On Demand web service documentation for information about this feature.QASearchOK 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 Please refer to the associated Pro On Demand web service documentation for information about this feature.