Trouver un bureau de poste

Exemples de codes pour trouver un bureau de poste : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir le bureau de poste le plus près – Module SOAP

Résumé

Nom :	Obtenir le bureau de poste le plus près
Raison pour utiliser le service :	Pour récupérer les renseignements sur les bureaux de poste les plus près d'un emplacement donné Pour récupérer une liste de bureaux de poste offrant l'option de livraison directe à un bureau de poste
Données d'entrée :	Longitude et latitude Code postal ou rue, ville et province de l'emplacement privilégié Nombre maximal de bureaux de poste voulus dans la réponse
Données de sortie :	Liste de bureaux de poste les plus près de l'emplacement précisé
Exemples d'erreurs :	Code postal, ville ou province invalide
Historique des versions :	Notes de mise à jour

Détails sur la demande

WSDL:	postoffice.wsdl
Point final (Conception) :	https://ct.soa-gw.canadapost.ca/rs/soap/postoffice
Point final (Production) :	https://soa-gw.canadapost.ca/rs/soap/postoffice
Espace de nommage :	http://www.canadapost.ca/ws/soap/postoffice
Opération :	GetNearestPostOffice

Corps – SOAP

La présente section décrit les éléments XML d'entrée pour ce service. Pour obtenir la structure hiérarchique, consultez le diagramme XML.

Obtenir le bureau de poste le plus près – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
get-nearest-post-office-request	complexe	requis	Élément XML de niveau supérieur de la structure de la réponse
locale	simple	optionnel	Indique votre langue de préférence pour recevoir les messages d'erreur. EN = Anglais FR = Français Si aucune valeur n'est fournie, la langue par défaut est « Anglais ».
maximum	simple	optionnel	Indique le nombre maximal de bureaux de poste pour afficher la réponse. Le nombre maximal permis est de 50. La valeur par défaut est de 10. Dans les emplacements éloignés, un nombre de bureaux de poste moins élevé que celui demandé peut s'afficher.
search-data	complexe	requis	Structure contenant les éléments de recherche du bureau de poste le plus près.
d2po	simple	optionnel	true \| false La mention « true » indique que vous voulez une liste de bureaux de poste acceptant la livraison de colis assortis de l'option « Livrer au bureau de poste ». Utilisez cette option lorsque vous voulez qu'un colis soit livré directement à un bureau de poste plutôt qu'à l'adresse d'un destinataire. La mention « false » indique que vous voulez que tous les bureaux de poste soient inclus dans la liste. Cet élément doit être « false » lorsque vous cherchez des bureaux de poste où déposer des colis. S'il manque le paramètre de « d2po », la mention « false » s’affiche par défaut. Nota : Si vous n'utilisez pas les services Web pour créer des étiquettes d'expédition, lisez les exigences obligatoires pour la mise en œuvre de l'option « Livrer au bureau de poste ».
BFLF	simple	facultatif	true \| false True indique que la personne cherche une liste des bureaux de poste qui acceptent la livraison de colis sans étiquette ni emballage. False indique que la personne veut que tous les bureaux de poste soient inclus dans la liste, pas seulement ceux qui offrent les retours sans étiquette ni emballage. Si le paramètre de requête est manquant, il est établi par défaut sur « false ».
tonight	simple	facultatif	true \| false Identique au paramètre REST équivalent.
longitude	simple	optionnel	Si vous utilisez les données de longitude et de latitude pour définir l'emplacement, la longitude et la latitude doivent toutes deux être indiquées et tous les autres champs de recherche (postalCode, province, city et streetName) doivent être omis. (Si l'un de ces champs de recherche est présent, le système n'en tiendra pas compte.) Le format compte 10 caractères. [-]3.5 C'est-à-dire, trois chiffres avant la décimale et cinq chiffres après la décimale. Exemple : -101.32354
latitude	simple	optionnel	Si vous utilisez les données de longitude et de latitude pour définir l'emplacement, la longitude et la latitude doivent toutes deux être indiquées et tous les autres champs de recherche (postalCode, province, city, et streetName) doivent être omis. (Si l'un de ces champs de recherche est présent, le système n'en tiendra pas compte.) Le format compte 10 caractères. [-]3.5 C'est-à-dire, trois chiffres avant la décimale et cinq chiffres après la décimale. Exemple : 55.32354
Les champs de recherche suivants ne doivent être utilisés que si les paramètres de longitude et de latitude ne sont pas présents.
postal-code	simple	optionnel	Le format du code postal à six caractères est valide. Exemple : A9A9A9. Nota : Les codes postaux comptant sept caractères (avec une espace intégrée) sont également acceptés. Exemple : A9A 9A9 Le code postal prime si des critères de recherche multiples sont fournis. Si le code postal et d'autres éléments sont précisés, le code postal sera utilisé par l'algorithme de recherche et les autres éléments seront ignorés. Tout ce qui n'est pas un code postal valide entraînera une erreur. (Par exemple, si le champ du code postal est vide, une erreur s'affichera.)
city	simple	optionnel	Si le code postal n'est pas précisé, la province et la ville doivent être fournies pour obtenir des renseignements pertinents. Pour les municipalités plus importantes, une recherche par province et par ville peut afficher un sous-ensemble de bureaux de poste disponibles, mais il n'est pas garanti lesquels se trouveront dans le sous-ensemble. Ainsi, pour les municipalités plus importantes, saisissez à la fois la province, la ville et la rue, ou, si vous voulez obtenir de meilleurs résultats, saisissez plutôt la latitude et la longitude ou le code postal.
province	simple	optionnel	(Code à deux caractères pour les provinces canadiennes – ISO 3166-2) Si le code postal n'est pas précisé, la province et la ville doivent être fournies. Nota : Pour obtenir des renseignements pertinents, le nom de la ville doit être fourni avec celui de la province. Pour les plus grandes municipalités, la province, la ville et la rue peuvent être requises.
street-name	simple	optionnel	Cet élément correspond au nom de rue seulement – sans le numéro de maison ou d'appartement (une recherche avec le numéro de maison ou d'appartement n'aura pas de succès). Le nom de la rue peut être un nom à plusieurs volets ayant des espaces intégrées. Si la ville et la province sont précisées, le fait de fournir ce paramètre réduira la liste à un endroit plus précis dans la ville indiquée. Pour les plus grandes municipalités, la liste peut ne pas s'afficher si le nom de la rue n'est pas fourni en plus de celui de la ville et de la province.

Demande – Diagramme XML

Obtenir le bureau de poste le plus près – Structure de la demande XML

Détails de la réponse

Réponse – Éléments

Le tableau suivant décrit les éléments XML figurant dans la réponse à la demande d'obtention du bureau de poste le plus près. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir le bureau de poste le plus près – Éléments de réponse
Nom de l'élément	Type	Description
get-nearest-post-office-response	complexe	Niveau supérieur de la structure XML pour la réponse. Il affichera les résultats d'une exécution réussie ou la structure d'une erreur.
post-office-list	complexe	Contient la liste de bureaux de poste.
post-office	complexe	Occurrence (1 à N fois). Correspond aux renseignements sur un seul bureau de poste.
address	complexe	Correspond aux renseignements sur l'adresse du bureau de poste.
city	simple	Municipalité dans laquelle se trouve le bureau de poste.
latitude	simple	Latitude du bureau de poste.
longitude	simple	Longitude du bureau de poste.
postal-code	simple	Code postal du bureau de poste.
province	simple	Province dans laquelle le bureau de poste est situé.
office-address	simple	Numéro et nom de rue pour un bureau de poste.
distance	simple	Distance (en km) entre le bureau de poste et l'endroit précisé dans la requête.
location	simple	Emplacement d'un bureau de poste. On l'utilise pour distinguer divers bureaux de poste qui ont des noms semblables.
name	simple	Nom attribué au bureau de poste.
office-id	simple	Numéro d'identification unique interne de Postes Canada attribué au bureau de poste. Ce numéro est nécessaire pour utiliser le service Web « Obtenir les détails d'un bureau de poste ». Nota : Les zéros du début sont importants et doivent être inclus.
bilingual-designation	simple	Vrai \| Faux La mention « Vrai » indique que le bureau de poste fournit des services bilingues (français et anglais). La mention « Faux » indique qu'il n'y a aucune désignation quant à la prestation de services bilingues. Elle n'indique pas une langue de service précise.

Réponse – Diagramme XML

Obtenir le bureau de poste le plus près – Structure de la réponse XML

Voir l'image en taille réelle

Réponse – Réponses d'erreur possibles

La réponse à des conditions d'erreur pour ce service en ligne respecte l'approche standard SOAP liée à la réponse d'erreur, laquelle est utilisée pour tous les services en ligne de Postes Canada. Pour obtenir de plus amples renseignements, consultez les Principes de base liés au module SOAP pour les services en ligne de Postes Canada.

Les messages d'erreur possibles pour ce service sont les suivants :

Code	Message
E00010	Bureaux de poste non trouvés

Exemples

Exemple de demande XML selon le module SOAP – Obtenir le bureau de poste le plus près


  

		<get-nearest-post-office-request>
	
		<locale>EN</locale>

		<maximum>2</maximum>

		<search-data>
	
		<d2po>true</d2po>

		<longitude>-79.3496</longitude>

		<latitude>43.7054</latitude>

	
		</search-data>

	
		</get-nearest-post-office-request>

Exemple de réponse XML selon le module SOAP – Obtenir le bureau de poste le plus près


  

		<get-nearest-post-office-response>
	
		<post-office-list>
	
		<post-office>
	
		<address>
	
		<city>OTTAWA</city>

		<latitude>45.3545</latitude>

		<longitude>-75.8061</longitude>

		<postal-code>K2B7K0</postal-code>

		<province>ON</province>

		<office-address>3080 CARLING AVE</office-address>

	
		</address>

		<distance>0.65</distance>

		<location>CRYSTAL BEACH PO</location>

		<name>SHOPPERS DRUG MART # 1387</name>

		<office-id>0000102978</office-id>

		<bilingual-designation>true</bilingual-designation>

	
		</post-office>

		<post-office>
	
		<address>
	
		<city>OTTAWA</city>

		<latitude>45.3284</latitude>

		<longitude>-75.8196</longitude>

		<postal-code>K2H8Z0</postal-code>

		<province>ON</province>

		<office-address>3659 RICHMOND RD</office-address>

	
		</address>

		<distance>1.94</distance>

		<location>NEPEAN H PO</location>

		<name>NEPEAN H PO</name>

		<office-id>0000313386</office-id>

		<bilingual-designation>true</bilingual-designation>

	
		</post-office>

	
		</post-office-list>

	
		</get-nearest-post-office-response>

Ouvrir unesession

Ressources