Envois retournés

Exemples de codes pour les envois retournés : Java (.zip) | PHP (.zip) | C# (.zip)

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

Résumé

Nom :	Obtenir le modèle générique pour les envois retournés
Raison pour utiliser le service :	Pour récupérer les renseignements liés à un modèle générique créé précédemment pour les envois retournés. Le service « Obtenir le modèle générique pour les envois retournés » n'est habituellement pas utilisé pendant les opérations normales, mais il pourrait être utile pour la récupération de données d'une communication ou d'une autre erreur. Nota : Tout modèle épuisé (p. ex. tous ses artefacts ont été récupérés) sera supprimé et ne sera pas accessible pour ce service.
Données d'entrée :	Numéro d'identification du modèle
Données de sortie :	Les résultats du service « Obtenir le modèle générique pour les envois retournés » sont identiques à ceux du service « Créer un modèle générique pour les envois retournés ».
Typical Next Call:	Récupérer le prochain artefact générique pour les envois retournés.
Historique des versions :	Notes de mise à jour

Obtenir 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 :	GetOpenReturnTemplate

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 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
get-open-return-template-request	compleex	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

Obtenir 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 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.

Obtenir le modèle générique pour les envois retournés – Élément de la réponse
Nom de l'élément	Type	Description
get-open-return-template-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.
open-return	complexe	Cette structure contient les résultats liés à l'exécution réussie du service.
artifacts-remaining	simple	Il s'agit du nombre d'artefacts restants qui peuvent être utilisés. Il est habituellement défini en fonction du nombre d'étiquettes dans la demande.
template-id	simple	Numéro d'identification correspondant au modèle qui vient tout juste d'être créé.

Réponse – Diagramme XML

Obtenir 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.

Les messages d'erreur possibles pour ce service sont les suivants :

Code de statut HTTP	Erreur d'application	Message
500	S.O.	Les détails liés à l’erreur de validation du schéma sont fournis.

Exemples

Exemple de demande XML selon le module SOAP – Obtenir le modèle générique pour les envois retournés


  

		<get-open-return-template-request>
	
		<mailed-by>1111111</mailed-by>

		<locale>EN</locale>

		<template-id>349641323786705649</template-id>

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

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


  

		<get-open-return-template-response>
	
		<open-return-info>
	
		<artifacts-remaining>10</artifacts-remaining>

		<template-id>349641323786705649</template-id>

	
		</open-return-info>

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

Ouvrir unesession

Ressources