Envois retournés

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

Récupérer le prochain artefact générique pour les envois retournés – Module SOAP

Résumé

Nom :	Récupérer le prochain artefact générique pour les envois retournés
Raison pour utiliser le service :	Pour récupérer le prochain artefact (étiquette) disponible associé au modèle générique pour les envois retournés
Données d'entrée :	Numéro d'identification du modèle
Données de sortie :	Document PDF ou ZPL II
Prochaine demande de service habituelle :	Répétition du procédé pour récupérer une autre étiquette
Historique des versions :	Notes de mise à jour

Récupérer le prochain artefact 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 :	RetrieveNextOpenReturnArtifact

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.

Récupérer le prochain artefact générique pour les envois retournés – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
retrieve-next-open-return-artifact-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

Récupérer le prochain artefact 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 récupération du prochain artefact générique pour les envois retournés. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Récupérer le prochain artefact générique pour les envois retournés – Éléments de la réponse
Nom de l'élément	Type	Description
retrieve-next-open-return-artifact-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.
artifact-data	complexe	Structure XML contenant les résultats liés à l'exécution réussie du service en question.
image	simple	Il s'agit de l'image de l'étiquette. Les données fournies sont un encodage base64 de l'image réelle. Pour les documents PDF, le fichier codé contient des données binaires.
mime-type	simple	Représente le fichier image de type MIME (après l'encodage en base64). La valeur sera la suivante : image/pdf ou image/zpl

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.

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 – Récupérer le prochain artefact générique pour les envois retournés


  

		<retrieve-next-open-return-artifact-request>
	
		<mailed-by>1111111</mailed-by>

		<locale>EN</locale>

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

	
		</retrieve-next-open-return-artifact-request>

Exemple de réponse XML selon le module SOAP – Récupérer le prochain artefact générique pour les envois retournés


  

		<retrieve-next-open-return-artifact-response>
	
		<artifact-data>
	
		<image>JVBERi0x(Etc... base 64 encoded PDF)</image>

		<mime-type>application/pdf</mime-type>

	
		</artifact-data>

	
		</retrieve-next-open-return-artifact-response>

Ouvrir unesession

Ressources