Tarification

Exemples de codes de tarification : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir l’option – Module SOAP

Résumé

Nom :	Obtenir l’option
Raison pour utiliser le service :	Pour récupérer les détails d'une option donnée
Données d'entrée :	Code d'option
Données de sortie :	Description de l'option, préalables et conflits
Demande de service précédente habituelle :	Obtenir le service
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 :	GetOption

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 l'option – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
get-option-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 saisie, la langue par défaut est l'anglais.
option-code	simple	requis	Code associé à l'option. Chaîne alphanumérique jusqu'à 10 lettres/chiffres.

Demande – Diagramme XML

Obtenir l'option – 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 d'une option. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir l'option – Éléments de réponse
Nom de l'élément	Type	Description
get-option-request	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.
option	complexe	Structure contenant l'option et ses attributs
option-code	simple	Code d'option dont les attributs sont présentés en détail
option-name	simple	Nom de l'option dans la langue choisie
option-class	simple	FEAT \| DI \| NDI FEAT indique que cette option est une caractéristique du service. DI indique qu'il s'agit d'une directive de livraison. NDI indique qu'il s'agit d'une directive à suivre en cas de livraison infructueuse.
prints-on-label	simple	Vrai \| Faux Indique qu'une preuve de la sélection de cette option est imprimée sur l'étiquette.
qualifier-required	simple	Vrai \| Faux La mention « Vrai » indique que, lorsque cette option est utilisée pour la demande de tarif ou de service Créer l'envoi, un qualificatif s'avère nécessaire pour l'option.
conflicting-options	complexe	Liste de codes ne pouvant pas être sélectionnés en même temps pour cette option.
option-code	simple	Option s'excluant mutuellement avec option précisée dans la demande connexe.
prerequisite-options	complexe	Liste de codes nécessaires pour appuyer cette option.
option-code	simple	Option devant également être sélectionnée lorsque l'option précisée dans la demande connexe est sélectionnée.

Réponse – Diagramme XML

Obtenir l'option – Structure de la réponse 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..

Exemples

Exemple de demande XML selon le module SOAP – Obtenir l'option


  

    <get-option-request>
  
    <locale>EN</locale>

    <option-code>D2PO</option-code>

  
    </get-option-request>

Exemple de réponse XML selon le module SOAP – Obtenir l'option


  

    <get-option-response>
  
    <option>
  
    <option-code>D2PO</option-code>

    <option-name>Deliver to Post Office</option-name>

    <option-class>DI</option-class>

    <prints-on-label>true</prints-on-label>

    <qualifier-required>true</qualifier-required>

    <conflicting-options>
  
    <option-code>HFP</option-code>

    <option-code>DNS</option-code>

    <option-code>COD</option-code>

    <option-code>LAD</option-code>

  
    </conflicting-options>

  
    </option>

  
    </get-option-response>

Ouvrir unesession

Ressources