Trouver un bureau de poste

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

Obtenir les détails d'un bureau de poste – Module SOAP

Résumé

Nom : Obtenir les détails d'un bureau de poste
Raison pour utiliser le service : Pour récupérer des renseignements supplémentaires sur un bureau de poste précis
Données d'entrée : Numéro d'identification du bureau de poste (office-id)
Données de sortie : Renseignements détaillés sur un bureau de poste précis (p. ex. heures d'ouverture)
Exemples d'erreurs : Numéro d'identification de bureau de poste invalide
Appel précédent habituel : Obtenir le bureau de poste le plus près
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 : GetPostOfficeDetail

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 les détails d'un bureau de poste – Éléments de la demande
Nom de l'élément Type Requis/Optionnel Description

get-post-office-detail-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 ».

office-id

simple

requis

Identificateur du bureau de poste pour lequel l'information est demandée.

Les zéros du début sont importants.

Demande – Diagramme XML

Obtenir les détails d'un bureau de poste – Structure de la demande XML

Obtenir les détails d'un bureau de poste – 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 des détails d'un bureau de poste. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir les détails d'un bureau de poste – Éléments de réponse
Nom de l'élément Type Description

get-post-office-detail-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'un message d'erreur.

post-office

complexe

Cette structure correspond aux renseignements sur le bureau de poste demandé.

address

complexe

Cette structure XML 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.

location

simple

Emplacement de la rue en général ou de la région où se trouve le bureau de poste. On l'utilise pour distinguer divers bureaux de poste qui ont des noms semblables.

name

simple

Nom du bureau de poste concessionnaire agréé, le cas échéant.

office-id

simple

Numéro d'identification unique interne de Postes Canada attribué au 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.

hours-list

complexe

Contient des renseignements concernant les heures d'ouverture du bureau de poste.

Occurrence (1 à 7 fois) : Chaque occurrence représente les heures d'ouverture d'un jour précis de la semaine.

day

simple

Indique quel jour de la semaine est représenté par l'occurrence correspondante de l'élément
« hours-list ».

Le jour « 1 » correspond à dimanche et le jour « 7 », à samedi.

time

simple

Heures d'ouverture et de fermeture du bureau de poste.

Occurrence (1 à 4 fois).

La première occurrence de l'heure correspond à la première heure d'ouverture de la journée.

La deuxième occurrence (s'il y en a une) représente la première heure de fermeture de la journée. (Si aucune donnée n'est précisée, cela indique que le magasin reste ouvert jusqu'à la fin de la journée.)

La troisième occurrence (s'il y en a une) représente la deuxième heure d'ouverture de la journée.

La quatrième occurrence (s'il y en a une) représente la deuxième heure de fermeture de la journée. (Si aucune donnée n'est précisée, cela indique que le magasin reste ouvert jusqu'à la fin de la journée.)

Exemple : S'il y a quatre occurrences d'heure
(09:00, 16:00, 19:00, 23:00), le magasin est ouvert de 9 h à 16 h et de 19 h à 23 h.

Réponse – Diagramme XML

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 Description
e00010 Numéro d'identification du bureau invalide

Exemples

Exemple de demande XML selon le module SOAP – Obtenir les détails d'un bureau de poste

<get-post-office-detail-request>
<locale>EN</locale>
<office-id>102978</office-id>
</get-post-office-detail-request>

Exemple de réponse XML selon le module SOAP – Obtenir les détails d'un bureau de poste

<get-post-office-detail-response>
<post-office-detail>
<address>
<city>GATINEAU</city>
<latitude>45.5856</latitude>
<longitude>-75.4132</longitude>
<postal-code>J8L1N0</postal-code>
<province>QC</province>
<office-address>563 RUE BELANGER</office-address>
</address>
<location>BUCKINGHAM PO</location>
<name>DÉPANNEUR MAUZEROLL</name>
<office-id>0000319376</office-id>
<bilingual-designation>true</bilingual-designation>
<hours-list>
<day>1</day>
<time>08:00</time>
<time>00:00</time>
</hours-list>
<hours-list>
<day>2</day>
<time>08:00</time>
<time>00:00</time>
</hours-list>
<hours-list>
<day>3</day>
<time>08:00</time>
<time>00:00</time>
</hours-list>
<hours-list>
<day>4</day>
<time>08:00</time>
<time>00:00</time>
</hours-list>
<hours-list>
<day>5</day>
<time>08:00</time>
<time>00:00</time>
</hours-list>
<hours-list>
<day>6</day>
<time>08:00</time>
<time>00:00</time>
</hours-list>
<hours-list>
<day>7</day>
<time>08:00</time>
<time>00:00</time>
</hours-list>
</post-office-detail>
</get-post-office-detail-response>