Envois retournés
Obtenir les modèles génériques pour les envois retournés – Module SOAP
Résumé
| Nom : | Obtenir les modèles génériques pour les envois retournés |
|---|---|
| Raison pour utiliser le service : | Pour récupérer une liste de tous les modèles génériques actifs pour les envois retournés associés à votre application (en fonction des numéros de client « Expédié par » et « Expédié au nom de ») Nota : Puisque votre application devrait assurer la gestion de la liste de modèles génériques actifs pour les envois retournés, une demande n'est pas habituellement présentée pour ce service pendant les opérations normales. Ce service est plutôt utilisé pour récupérer les données d'une communication ou d'une autre erreur. |
| Données d'entrée : | Dates de début et de fin et heures représentant la période au cours de laquelle tous les modèles génériques actifs pour les envois retournés doivent être récupérés |
| Données de sortie : | Liste des numéros d'identification associés à tous les modèles génériques actifs pour les envois retournés dans les délais prescrits |
| Prochaine demande de service habituelle : | Service Obtenir le modèle générique pour les envois retournés permettant d'accéder à des modèles précis figurant sur la liste |
| Historique des versions : | Notes de mise à jour |
Obtenir les modèles génériques 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 : | GetOpenReturnTemplates |
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 modèles génériques pour les envois retournés – Élément de la demande | |||
|---|---|---|---|
| Nom de l'élément | Type | Requis/Optionnel | Description |
get-open-return-templates-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 ». |
from |
simple |
optionnel |
Il s'agit de la date de début de la période pendant laquelle les modèles génériques actifs pour les envois retournés seront récupérés. La date est précisée sous le format « AAAA-MM-JJ ». Toutes les dates sont fonction du fuseau horaire de l'Est. S'il manque la date de début, tous les modèles génériques actifs pour les envois retournés créés avant la date de fin s'affichent. |
to |
simple |
optionnel |
Il s'agit de la date de fin de la période pendant laquelle les modèles génériques actifs pour les envois retournés seront récupérés. La date est précisée sous le format « AAAA-MM-JJ ». Toutes les dates sont fonction du fuseau horaire de l'Est. Si la date de fin est manquante, on suppose qu'il s'agit de la date actuelle. S'il manque les dates de début et de fin, tous les modèles génériques pour les envois retournés s'affichent. |
Demande – Diagramme XML
Obtenir les modèles génériques 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 modèles génériques pour les envois retournés. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.
| Obtenir les modèles génériques pour les envois retournés – Élément de la réponse | ||
|---|---|---|
| Nom de l'élément | Type | Description |
get-open-return-templates-response |
complexe |
Il s'agit du niveau supérieur de la structure XML pour la réponse. Il affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur. |
templates |
complexe |
Structure XML contenant la liste de modèles. |
template-id |
simple |
Occurrence (1 à N fois). Il s'agit d'un numéro d'identification unique pour le modèle. Il peut être utilisé pour présenter les demandes de service suivantes :
|
Réponse – Diagramme XML
Obtenir les modèles génériques pour les envois retournés – 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 les modèles génériques pour les envois retournés
<get-open-return-templates-request>
<mailed-by>1111111</mailed-by>
<locale>EN</locale>
<from>2011-01-04-06:00</from>
<to>2012-02-03+06:00</to>
</get-open-return-templates-request>
Exemple de réponse XML selon le module SOAP – Obtenir les modèles génériques pour les envois retournés
<get-open-return-templates-response>
<templates>
<template-id>349641323786705649</template-id>
</templates>
</get-open-return-templates-response>
