Tarification
Découvrir les services – Module SOAP
Résumé
Nom : | Découvrir les services |
---|---|
Raison pour utiliser le service : | Pour découvrir la liste de services postaux pouvant être utilisés pour un pays de destination, un client, une convention ou un code postal d'origine ou de destination donnés. |
Données d'entrée : | Pays du destinataire |
Données de sortie : | Description de l'option, préalables et conflits |
Historique des versions : | Notes de mise à jour |
Détails sur la demande
WSDL: | rating.wsdl |
---|---|
Point final (Conception) : | https://ct.soa-gw.canadapost.ca/rs/soap/rating/v4 |
Point final (Production) : | https://soa-gw.canadapost.ca/rs/soap/rating/v4 |
Espace de nommage : | http://www.canadapost.ca/ws/soap/ship/rate/v4 |
Opération : | DiscoverServices |
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.
Découvrez les services – Éléments de la demande | |||
---|---|---|---|
Nom de l'élément | Type | Requis/Optionnel | Description |
discover-services-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 Si aucune valeur n'est saisie, la langue par défaut est l'anglais. |
destination-country-code |
simple |
optionnel |
Le code de pays à deux caractères représente le pays de destination pour lequel la demande de services disponibles a été effectuée. |
customer-number | simple | optionnel | (De un à dix caractères numériques) |
contract-id | simple | optionnel | (De un à dix caractères numériques) |
Demande – Diagramme 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 de découvrir les services. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.
Découvrir les services – Éléments de la réponse | ||
---|---|---|
Nom de l'élément | Type | Description |
discover-services-response |
complexe |
Niveau supérieur de l'élément XML pour la réponse. Ce niveau affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur. |
services |
complexe |
Contient la liste des services d'expédition qui peut être utilisée pour les paramètres précisés. |
service |
complexe |
Contient les renseignements sur un seul service d'expédition de Postes Canada. |
service-code |
simple |
Code utilisé pour présenter une demande de service. |
service-name |
simple |
Nom complet du service d'expédition dans la langue que vous avez demandée |
Réponse – Diagramme XML
Réponse – Réponses d'erreur possibles
Code | Description |
---|---|
2550 |
Le numéro de convention n'est pas valide. |
7266 | Le code postal doit respecter le format «A9A» ou «A9A9A9». |
8534 | Un pays de destination valide doit être indiqué. |
9194 | L'élément «origin-postal-code» doit également être fourni lorsque l'élément «destination-postal-code» est fourni. |
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..
Exemples
Exemple de demande XML selon le module SOAP – Découvrir les services
<discover-services-request>
<locale>EN</locale>
<destination-country-code>GB</destination-country-code>
</discover-services-request>
Exemple de réponse XML selon le module SOAP – Découvrir les services
<discover-services-response>
<services>
<service>
<service-code>INT.XP</service-code>
<service-name>Xpresspost International</service-name>
</service>
<service>
<service-code>INT.SP.SURF</service-code>
<service-name>Small Packet International Surface</service-name>
</service>
<service>
<service-code>INT.SP.AIR</service-code>
<service-name>Small Packet International Air</service-name>
</service>
</services>
</discover-services-response>