AddressComplete Interactive Find (v2.10)
Module SOAP et langage WSDL
Connexion HTTP standard
http://ws1.postescanada-canadapost.ca/AddressComplete/Interactive/Find/v2.10/wsdlnew.ws
Connexion https:// sécurisée
https://ws1.postescanada-canadapost.ca/AddressComplete/Interactive/Find/v2.10/wsdlnew.ws
Exemples de codes et points finaux REST
Choisissez un code d'exemple de langue ci-dessous.Sélectionnez un point final pour voir un exemple.
Mise en pratique
Saisissez vos valeurs dans le formulaire ci-dessous pour essayer le service vous-même. Nous avons saisi quelques exemples de valeurs pour vous aider à passer à l'action.
| Nom | Valeur | Type | Défaut | Description |
|---|---|---|---|---|
*Obligatoire
Paramètres
Chaque demande faite au service Web nécessite les paramètres suivants. Vous pouvez créer autant de clés que vous voulez, dont chacune peut être signalée individuellement et peut avoir des paramètres de sécurité précis.
| Nom | Type | Description | Défaut | Exemple |
|---|---|---|---|---|
| Key * | Chaîne | La clé servant à authentifier le service. | AA11-AA11-AA11-AA11 | |
| SearchTerm * | Chaîne | The search term to find. If the LastId is provided, the SearchTerm searches within the results from the LastId. | 2701 ri | |
| LastId | Chaîne | The Id from a previous Find or FindByPosition. | ||
| SearchFor | Chaîne | Filtre les résultats de la recherche. | Everything | Everything |
| Country | Chaîne | Le nom ou le code ISO à deux ou à trois caractères propre au pays visé par la recherche. La plupart des noms de pays seront reconnus, mais l'utilisation du code de pays ISO est recommandée pour plus de précision. | CAN | CAN |
| LanguagePreference | Chaîne | L'identificateur de la langue de choix à deux ou à quatre caractères (p. ex. en, en-gb, en-us). | en | EN |
| MaxSuggestions | Entier relatif | The maximum number of autocomplete suggestions to return. | 7 | 7 |
| MaxResults | Entier relatif | The maximum number of retrievable address results to return. | 100 | 7 |
Champs
La réponse du service Web est fournie sous forme d'un tableau contenant les éléments ci-dessous. Si aucun élément n'est trouvé, il n'y aura pas de réponse (bien que tous les points finaux précisent les colonnes). Si une erreur se produit, ce sera plutôt un tableau d'erreur qui s'affichera. (voir les erreurs de réponse et les erreurs générales ci-dessous)
| Nom | Type | Description | Valeurs | Exemple |
|---|---|---|---|---|
| Id | Chaîne | Le numéro d'identification à utiliser comme LastId pour l'élément Find. |
|
CAN|PR|X247361852|E|0|0 |
| Text | Chaîne | L'élément trouvé. |
|
2701 Riverside Dr, Ottawa, ON |
| Highlight | Chaîne | La plage de numéros indiquant les caractères à mettre en évidence dans la réponse en texte (dont les positions de début et de fin ont une valeur de zéro). |
|
0-2,6-4 |
| Cursor | Entier relatif | Une position dont la valeur est zéro dans la réponse en texte indique la position suggérée du curseur si cet élément est sélectionné. La réponse A-1 indique qu'il n'y a aucune suggestion disponible. |
|
0 |
| Description | Chaîne | Les renseignements décrivant l'article trouvé, surtout s'il s'agit d'un conteneur. |
|
102 Streets |
| Next | Chaîne | La prochaine étape du procédé de recherche. |
|
Retrieve |
Erreurs de réponse
Vous trouverez ci-dessous les erreurs propres à ce service Web (suivies des erreurs générales). S'il se produit une erreur, un tableau d'erreur comme celui-ci (mais qui contient une seule rangée) s'affichera. (les développeurs devraient mettre à l'essai un tableau avec les quatre colonnes suivantes : « Erreur », « Description », « Cause » et « Résolution »)
| Erreur | Description | Cause | Résolution |
|---|---|---|---|
| 1001 | SearchTerm or LastId Required | The SearchTerm or LastId parameters were not supplied. | Check they were supplied and try again. |
| 1002 | SearchFor or LastId Invalid | The SearchFor or LastId parameter was not recognised. | Vérifiez les documents pour des options valides. |
| 1003 | Country Invalid | Le paramètre Country n'a pas été reconnu. Vérifiez l'orthographe et, en cas de doute, utilisez un code de pays ISO à deux ou à trois chiffres. | Fournissez un code de pays ISO à deux ou à trois caractères valide ou utilisez un service Web pour convertir le nom du pays à un code ISO. |
| 1004 | LanguagePreference Invalid | Le paramètre LanguagePreference n'a pas été reconnu. | Veuillez vérifier les éléments saisis et réessayer. |
| 1005 | No response | The query didn't respond fast enough, it may be too complex. | Please check what you entered and try again with something more specific. |
Erreurs générales
Ces erreurs sont des erreurs de service générales et peuvent provenir d'un service Web quelconque. Veuillez noter que toutes les erreurs générales sont inférieures à 100 tandis que les erreurs propres au service commencent à 1 000.
| Erreur | Description | Cause | Résolution |
|---|---|---|---|
| -1 | Cause d'erreur non connue | La cause de l'erreur n'est pas connue, mais les détails ont été transmis à notre personnel de soutien qui mènera une enquête. | Ces problèmes sont normalement de courte durée et souvent réglés quand on réessaye après quelques minutes. |
| 2 | Clé non trouvée | La clé servant à accéder au service n'a pas été trouvée. | Veuillez vérifier s'il s'agit de la bonne clé. Elle devrait être inscrite dans cet ordre AA11-AA11-AA11-AA11. |
| 3 | Les crédits du compte sont épuisés. | Les crédits dans votre compte sont soit épuisés, soit insuffisants pour cette demande. | Veuillez vérifier le solde de votre compte et configurer une recharge, au besoin. |
| 4 | Demande non autorisée à partir de cette adresse IP | La demande n'a pas été autorisée en raison de l'adresse IP. | Vérifiez tout d'abord les paramètres de sécurité de la clé. S'il ne semble y avoir aucune anomalie, veuillez communiquer avec le service de soutien, car il se peut que l'adresse IP figure sur notre liste noire. |
| 5 | Demande non autorisée à partir de cette URL | La demande n'a pas été autorisée en raison de l'URL. | Vérifiez tout d'abord les paramètres de sécurité de la clé. S'il ne semble y avoir aucune anomalie, veuillez communiquer avec le service de soutien, car il se peut que l'URL figure sur notre liste noire. |
| 6 | Service Web pas disponible avec cette clé | Le service Web demandé n'est pas autorisé avec cette clé. | Vérifiez tout d'abord les paramètres de sécurité de la clé. Vous pouvez avoir une clé qui limite l'accès à certains services Web seulement. |
| 7 | Service Web non offert dans votre plan | Le service Web demandé n'est pas offert dans votre plan de paiement en ce moment. | Certains services ne sont offerts que dans certaines régions en raison de restrictions imposées pour les licences. Veuillez communiquer avec nous pour obtenir plus de renseignements. |
| 8 | Limite quotidienne de la clé dépassée | La limite quotidienne de la clé a été dépassée. | Modifiez la limite quotidienne de la clé. Vérifiez tout d'abord les détails de l'utilisation pour voir si vous vous êtes servis de la clé de façon habituelle. |
| 9 | Your account has been suspended | Your account has been suspended. This can be for a number of reasons including non-payment of an invoice. | Please contact us in order to resolve this issue. |
| 10 | Limiteur de surtension déclenché | Il y a eu traitement d'un nombre anormalement élevé de demandes pour votre compte et donc le limiteur de surtension a été activé. | Vous pouvez désactiver le limiteur de surtension à tout moment, mais il n'est pas recommandé de le faire à moins que vous lanciez de nombreuses demandes. |
| 11 | Licence valide non disponible | La demande exige une licence valide, mais aucune n'a été trouvée. | Veuillez vérifier votre historique des achats. Il se peut que vous ayez une licence désormais invalide ou qui ne convient pas au service demandé. |
| 12 | Clé de gestion requise | Afin d'accéder à ce service Web, vous avez besoin d'une clé de gestion. L'option de gestion peut être activée sur n'importe quelle clé, mais nous vous avisons d'utiliser les clés de gestion avec soin. | Ouvrez une session sur le site Web et créez une nouvelle clé de gestion ou modifiez une clé existante. |
| 13 | Dépassement de la limite liée aux démonstrations | La limite quotidienne imposée pour les démonstrations pour ce service ou ce compte a été dépassée. | La limite sera réinitialisée ce soir à minuit. Si vous souhaitez augmenter la limite, veuillez communiquer avec nous. |
| 14 | Dépassement de la limite de service gratuit | Vous avez utilisé trop de services Web gratuits. | Nos services Web sont conçus pour fonctionner en plusieurs étapes. Le premier est habituellement un service de Recherche suivi d'un service de Récupération. Cette erreur s'affichera si vous recourez à trop de services de Recherche sans recourir à un nombre correspondant de services de Récupération. Pour obtenir plus de renseignements, veuillez communiquer avec nous. |
| 15 | Mauvais type de clé | Le type de clé ne vous permet pas d'accéder à ce service Web. | Cette erreur se produit habituellement lorsque vous êtes titulaire d'une licence d'utilisateur ou de serveur et que le service Web n'est accessible qu'au moyen d'une clé transactionnelle. Veuillez utiliser une autre clé et réessayer. |
| 16 | Clé expirée | La clé est expirée. | Veuillez vérifier si vous utilisez la bonne clé. Il est possible qu'on ait émis une nouvelle clé si vous l'avez récemment renouvelée. Veuillez communiquer avec nous si vous avez des questions. |
| 17 | Individual User exceeded Lookup Limit | An Individual User has exceeded their daily lookup limit on the key and that user will be prevented from using your service until tomorrow (GMT) | Check the usage details. If required, increase the Lookup Limit per Individual User or add the specific Individual User's IP to the Limiter Exclusions |
| 18 | Missing or invalid parameters | A required parameter was not supplied of the value of a parameter cannnot be converted into the right type. | Check the parameters passed and their values against the specification for this service. |
| 19 | Invalid JSON object | The JSON object sent in your request is invalid. | Please ensure your JSON object is syntactically correct and try again. |
| 20 | Endpoint not available | The web service you are calling is not available on this endpoint | Refer to our documentation pages to ensure you are calling a valid endpoint for the web service you are requesting. |
| 21 | Sandbox Mode is not available on this endpoint | The License key used has Sandbox Mode enabled, but the testing functionality is not available on this endpoint. | Disable the Sandbox Mode on the License key. |
| 22 | HTTPS requests only | As of 3rd September 2018 all new accounts must use HTTPS. | Ensure you consume all of our APIs over HTTPS and not HTTP. |
| 23 | Agreement Not Signed | There are agreements associated with service which are not signed. | Please go to your account and check your agreements. |