Envois retournés

Supprimer le modèle générique pour les envois retournés – Module SOAP

Résumé

Nom :	Supprimer le modèle générique pour les envois retournés
Raison pour utiliser le service :	Pour supprimer un modèle générique existant pour les envois retournés
Données d'entrée :	Numéro d'identification du modèle
Données de sortie :	Aucune
Prochaine demande de service habituelle :	Créer un modèle générique pour les envois retournés
Historique des versions :	Notes de mise à jour

Supprimer 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 :	DeleteOpenReturnTemplate

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.

Supprimer le modèle générique pour les envois retournés – Élément de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
delete-open-return-template-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 nom de ». 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 FR = Français 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

Supprimer 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 de suppression d'un modèle générique pour les envois retournés. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Supprimer le modèle générique pour les envois retournés – Élément de la réponse
Nom de l'élément	Type	Description
delete-open-return-template-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.
delete-template-success	simple	{vrai, faux} Il s'agit d'un simple indicateur signalant l'exécution réussie du service « Supprimer le modèle générique pour les envois retournés ».

Réponse – Diagramme XML

Supprimer le modèle générique 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 – Supprimer le modèle générique pour les envois retournés

<delete-open-return-template-request>

<mailed-by>1111111</mailed-by>
<locale>EN</locale>
<template-id>349641323786705649</template-id>

</delete-open-return-template-request>

Exemple de réponse XML selon le module SOAP – Supprimer le modèle générique pour les envois retournés

<delete-open-return-template-response>

<delete-template-success>true</delete-template-success>

</delete-open-return-template-response>