Obtenir de l'information sur le service

Exemples de codes pour obtenir de l'information sur le service : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir de l'information sur le service – Module SOAP

Résumé

Nom : Obtenir de l'information sur le service
Raison pour utiliser le service : Pour vous permettre d'extraire et d'afficher des messages d'information pour les clients de votre plate-forme de cybercommerce en vue de les informer des interruptions à venir des services Web de Postes Canada.
Données d'entrée : locale
Données de sortie :
  • Type de message (toujours « SO », pour interruption planifiée)
  • Texte du message
  • Dates et heures de début et de fin de l'interruption planifiée
Historique des versions : Notes de mise à jour

Détails sur la demande de service

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

Corps – SOAP

Obtenir de l'information sur le service – Éléments de la demande
Nom de l'élément Type Requis/Facultatif Description

get-service-info-request

Complexe

Requis

Élément XML de niveau supérieur de la structure de la réponse

locale

Simple

Facultatif

Indique votre langue de préférence pour recevoir les messages d'erreur

EN = Anglais
FR = Français

Si aucune valeur n'est saisie, la langue par défaut est l'anglais.

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 d'information sur le service. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir de l'information sur le service – Éléments de réponse
Nom de l'élément Type Description

info-messages

Complexe

La structure d'ensemble pour la réponse en format XML

info-message

Complexe

Comprend les détails d'un message précis

message-type

Simple

Type de message Toujours « SO » (interruption planifiée)

message-text

Simple

Texte du message dans la langue indiquée dans l'en-tête

from-datetime

Simple

Date et heure de début de l'interruption en format dateHeure (2013-06-07T21:00:00-05:00)

Nota : Le message sera envoyé à l'avance aux fins d'avertissement précoce.

to-datetime

Simple

La date et l'heure de fin prévues pour l'interruption planifiée en format dateHeure (2013-06-08T03:00:00-05:00)

Nota : Le message continuera d'être renvoyé après l'envoi initial au cas où l'interruption s'étendrait au-delà du moment de fin prévu.

Réponse – Réponses d'erreur possibles

Une demande bien structurée peut recevoir les réponses d'erreur suivantes :

S'il n'existe aucun message en attente (p. ex. s'il n'existe aucun message ou si nous ne respectons pas la date et l'heure d'envoi d'un message aux utilisateurs), le code d'erreur HTTP 200 (OK) s'affiche avec une réponse vide, p. ex. <info-messages></info-messages>.

Si la demande est dépourvue d'une composante ou comprend une composante invalide, ou si une validation échoue, un code d'erreur HTTP de 400 (mauvaise requête) sera envoyé en indiquant l'une des erreurs suivantes dans le corps de la réponse XML.

Code Message

9182

Le type de message est invalide.

Réponse – Diagramme XML

Obtenir de l'information sur le service – Structure de la réponse XML
Obtenir de l'information sur le service – Structure de la réponse XML

Exemples

Exemple de demande XML selon le module SOAP – Obtenir de l'information sur le service

<get-service-info-request>
<locale>FR</locale>
</get-service-info-request>

Exemple de réponse XML selon le module SOAP – Obtenir de l'information sur le service

<info-messages xmlns="http://www.canadapost.ca/ws/shipment/v2">

<info-message>
<message-type>SO</message-type>
<message-text>Veuillez noter que nous effectuerons un entretien planifié du samedi 12 octobre, à 21 h, au dimanche 13 octobre, à 16 h (HAE). Durant ce temps, les services Web de Postes Canada ne seront pas accessibles.</message-text>
<from-datetime>2013-10-12T21:00:00-05:00</from-datetime>
<to-datetime>2013-10-13T04:00:00-05:00</to-datetime>
</info-message>
</info-messages>