Trouver un bureau de poste
Obtenir les détails d'un bureau de poste – Module REST
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 : | Lien fourni pour le service « Obtenir le bureau de poste le plus près » lorsque rel=detail |
| Données de sortie : | Renseignements détaillés sur un bureau de poste précis (p. ex. heures d'ouverture) |
| Demande de service précédente habituelle : | Obtenir le bureau de poste le plus près |
| Historique des versions : |
Détails sur la demande
Demande – Structure pour le service « Obtenir les détails d'un bureau de poste »
Point final
Il faut utiliser le lien associé au service « Obtenir le bureau de poste le plus près » lorsque rel=detail (voir la section Points finaux fournis)
En-têtes HTTP
Variable des en-têtes HTTP |
Valeur |
|---|---|
Accept |
application/vnd.cpc.postoffice+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur) |
Authorization |
Basic {Encodage base64 du code d'usager:mot de passe} |
Accept-language |
en-CA ou fr-CA |
Corps du message
Aucun
Demande – Éléments
Les données d'entrée XML ne sont pas nécessaires pour le service « Obtenir les détails d'un bureau de poste ».
Détails de la réponse
Réponse – Éléments
Les éléments XML suivants sont affichés dans la réponse. Pour obtenir un aperçu complet de la structure, consultez le diagramme.
| Obtenir les détails d'un bureau de poste – Éléments de la réponse | ||
|---|---|---|
| Nom de l'élément | Type | Description |
post-office-detail |
complexe |
Élément XML de niveau supérieur pour la structure de réponse. Il correspond aux renseignements sur un seul bureau de poste. |
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
|
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 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 |
Réponse – Diagramme XML
Réponse – Réponses d'erreur possibles
Pour obtenir les réponses d'erreur possibles, consultez les sections Codes de statut HTTP et Messages d'erreur et stratégies d'atténuation.
Exemples
Exemple de demande XML selon le module REST – Obtenir les détails d'un bureau de poste
Il n'y a pas de XML lié à cette demande REST. Utilisez le lien fourni dans une demande préalable ou consultez les fichiers du projet soapUI pour obtenir des exemples de demande.
Exemple de réponse XML selon le module REST – Obtenir les détails d'un bureau de poste
<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>
