We have prepared a glossary of important terms you will surely come accross working with our documentation
💡 Proposal (response.result.proposal)
Proposed solution by Foxentry how you should process the response in your form or application. Basically this parameter should tell you exactly what you need to do with the response. These are the values it may contain:
| Name | Description |
|---|---|
| valid | Data in query is valid and you should process this accordingly in your app. |
| validWithSuggestion | Data in query is valid but there might be a more suitable result. You should show the user message that goes "Did you mean X?" |
| invalid | Data in query is invalid. |
| invalidWithPartialCorrection | Data in query is invalid but can be partially corrected. The end result after the correction is invalid. Usually this status takes place with format/syntax corrections. For example e-mail "[email protected]" is corrected to "[email protected]", but the e-mail itself does not exist so the end result is still invalid. |
| invalidWithCorrection | Data in query is invalid but can be corrected to valid state. Based on this information you should correct the value automatically in your app and show a valid icon afterwards. |
| invalidWithSuggestion | Data in query is invalid but the validator is not 100% sure it should be corrected automatically. Therefore a suggestion is offered. You should mark the data as invalid in your app and show the user a message that goes "Did you mean X?" |
| invalidWithCorrectionWithSuggestion | Data in query is invalid and can be corrected automatically but there are several suitable options. Therefore you should offer the user a suggestion if they meant this or that. |
| unknown | Request could not be processed or it took too long. You should not show any validation status on your end. |
Additional valid proposals such as validWithCorrection might be encountered, but these are rather uncommon. All of them indicate, that although the initial value is valid, a more suitable version is available.
💡 Client (request.client)
Additional information about your user (from whom you've obtained the data sent in query) in order to specify the results in response. Used mainly in web forms when you need more relevant search/autocomplete results. There are several options you can include such as IP address, country code or exact location using GPS.
💡 Result, resultCorrected, suggestions
These are the main parts of the response you should keep attention to based on the proposal. ResultCorrected contains corrected version of the query. Suggestions contain one or more alternatives to the sent query.
💡 Datascope
Datascope is the scope of data returned in response. You can usually choose between 2 or 3 datascopes (basic, extended, full). Basic datascope is set as default. The higher datascopes are priced differently.