Envois retournés
Obtenir les détails sur le modèle générique pour les envois retournés – Module SOAP
Résumé
| Nom : | Obtenir les détails sur le modèle générique pour les envois retournés |
|---|---|
| Raison pour utiliser le service : | Pour récupérer une représentation XML de toutes les données initiales associées à un modèle générique existant pour les envois retournés. Les détails liés à l'adresse de destination finale sont inclus. Une demande ne serait habituellement pas présentée pour ce service pendant les opérations normales puisque ce n'est pas nécessaire pour récupérer ou imprimer les étiquettes. Une représentation est fournie pour certaines situations, notamment la récupération de données d'une communication ou d'une autre erreur. |
| Données d'entrée : | Numéro d'identification du modèle |
| Données de sortie : | Détails saisis au moment de la création du modèle générique pour les envois retournés, notamment :
|
| Historique des versions : | Notes de mise à jour |
Obtenir les détails sur le modèle générique pour les envois retournés – Résumé du service
Détails sur la demande
| WSDL: | authreturn.wsdl |
|---|---|
| Point final (Conception) : | https://ct.soa-gw.canadapost.ca/rs/soap/return |
| Point final (Production) : | https://soa-gw.canadapost.ca/rs/soap/return |
| Espace de nommage : | http://www.canadapost.ca/ws/soap/return |
| Opération : | GetOpenReturnTemplateDetails |
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 sur le modèle générique pour les envois retournés – Éléments de la demande | |||
|---|---|---|---|
| Nom de l'élément | Type | Requis/Optionnel | Description |
get-open-return-template-details-request |
complexe |
requis |
Élément de niveau supérieur pour la demande. |
mailed-by |
simple |
requis |
(1 à 10 caractères numériques) Il s'agit du numéro de client à 10 chiffres du client « Expédié par ». Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début. |
mobo |
simple |
optionnel |
(1 à 10 caractères numériques) Il s'agit du numéro de client à 10 chiffres du client « Expédié au S'il manque cet élément, le numéro du client « Expédié par » s'affichera par défaut. Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début. |
locale |
simple |
optionnel |
Indique votre langue de préférence pour recevoir les messages d'erreur. EN = Anglais Si aucune valeur n'est fournie, la langue par défaut est « Anglais ». |
template-id |
simple |
requis |
Identificateur du modèle créé précédemment pour lequel un artefact est récupéré. |
Demande – Diagramme XML
Obtenir les détails sur le modèle générique pour les envois retournés – 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 sur le modèle générique pour les envois retournés. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.
| Obtenir les détails sur le modèle générique pour les envois retournés – Éléments de la réponse | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Nom de l'élément | Type | Description | ||||||||||
get-open-return-template-details-response |
complexe |
Il s'agit de l'élément XML de niveau supérieur de la structure de la réponse. Il affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur. |
||||||||||
template-details |
complexe |
Cette structure contient les détails utilisés pour créer le modèle. |
||||||||||
max-number-of-artifacts |
simple |
Indique le nombre maximal d'artefacts (étiquettes du Service de retour) que vous pouvez générer et récupérer à l'aide de ce modèle. Il doit s'agir d'une valeur numérique se situant entre « 1 » et « 100 000 ». |
||||||||||
artifacts-remaining |
simple |
Indique le nombre actuel d'artefacts restants (étiquettes de retour) pouvant être générés et récupérés à l'aide de ce modèle. |
||||||||||
| service-code | simple |
Le Service de retour convient seulement pour les envois retournés du régime intérieur.
|
||||||||||
receiver |
complexe |
Cette structure contient des données sur la destination correspondant à l'adresse du destinataire figurant sur l'étiquette. Les champs vides seront retirés pendant le formatage des adresses. |
||||||||||
name |
simple |
Nom du destinataire. |
||||||||||
company |
simple |
Entreprise du destinataire. |
||||||||||
domestic-address |
complexe |
Cette structure contient les données d'adressage du destinataire final de l'envoi retourné. Les champs vides seront retirés pendant le formatage des étiquettes. |
||||||||||
address-line-1 |
simple |
Ligne d'adresse 1 du destinataire. |
||||||||||
address-line-2 |
simple |
Ligne d'adresse 2 du destinataire. |
||||||||||
city |
simple |
Ville du destinataire. |
||||||||||
prov |
simple |
Province du destinataire. |
||||||||||
postal-code |
simple |
Code postal du destinataire. |
||||||||||
print-preferences |
complexe |
Cette structure contient les préférences d'impression pour les étiquettes, notamment le format de sortie. |
||||||||||
output-format |
simple |
Les valeurs valides sont les suivantes : |
||||||||||
encoding |
simple |
{PDF} |
||||||||||
show-packing-instructions |
simple |
{vrai, faux} Cet élément indique si les directives d'emballage doivent être inscrites sur l'étiquette. |
||||||||||
settlement-info |
complexe |
Cette structure contient des éléments indiquant comment la livraison sera réglée (payée). |
||||||||||
contract-id |
simple |
Requis pour utiliser le service de retour générique. Seuls les clients commerciaux de Postes Canada titulaires d'une convention établie en fonction du volume peuvent utiliser le service. |
||||||||||
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.
Exemples
Exemple de demande XML selon le module SOAP – Obtenir les détails sur le modèle générique pour les envois retournés
<get-open-return-template-details-request>
<mailed-by>1111111</mailed-by>
<locale>EN</locale>
<template-id>349641323786705649</template-id>
</get-open-return-template-details-request>
Exemple de réponse XML selon le module SOAP – Obtenir les détails sur le modèle générique pour les envois retournés
<get-open-return-template-details-response>
<open-return-details>
<artifacts-remaining>10</artifacts-remaining>
<open-return>
<max-number-of-artifacts>10</max-number-of-artifacts>
<service-code>DOM.EP</service-code>
<receiver>
<domestic-address>
<address-line-1>2701 Return Drive</address-line-1>
<city>Ottawa</city>
<province>ON</province>
<postal-code>K1A0B1</postal-code>
</domestic-address>
</receiver>
<print-preferences>
<output-format>8.5x11</output-format>
<encoding>PDF</encoding>
<show-packing-instructions>false</show-packing-instructions>
</print-preferences>
<settlement-info>
<contract-id>0012345678</contract-id>
</settlement-info>
</open-return>
</open-return-details>
</get-open-return-template-details-response>
