Expédition

Obtenir l'artefact – Module SOAP

Résumé

Nom :	Obtenir l'artefact
Raison pour utiliser le service :	Pour récupérer une étiquette d'expédition, une étiquette du Service de retour ou un document requis aux fins de ramassage ou de dépôt de l'envoi (manifeste). Nota : Pour les étiquettes, vous pouvez présenter une deuxième demande de service « Obtenir l'artefact » si l'étiquette initiale a été détruite, mais la même étiquette assortie du code à barres initial est produite chaque fois. Vous ne pouvez pas utiliser des copies sur des colis différents.
Données d'entrée :	artifact-id; page index; locale (optionnel)
Données de sortie :	Document PDF ou ZPL II
Exemples d'erreurs :	Numéro d'identification invalide pour l'artefact
Demande de service précédente habituelle :	Créer l'envoi, Obtenir l'envoi, Obtenir le manifeste, ou Créer un retour autorisé
Prochaine demande de service habituelle :	Obtenir le tarif de l'envoi, Obtenir les détails du manifeste
Historique des versions :	Notes de mise à jour

Obtenir l'artefact – Résumé du service

Détails sur la demande

WSDL :	shipment.wsdl
Point final (Conception) :	https://ct.soa-gw.canadapost.ca/rs/soap/artifact
Point final (Production) :	https://soa-gw.canadapost.ca/rs/soap/artifact
Espace de nommage :	http://www.canadapost.ca/ws/soap/artifact
Opération :	GetArtifact

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 l'artefact – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
get-artifact-request	complexe	requis	Élément XML de niveau supérieur de la structure de la réponse
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 ».
artifact-id	simple	requis	(Chaîne de caractères numériques – Jusqu'à 18 chiffres) Il s'agit du numéro d'identification unique de l'artefact (étiquette ou manifeste) généré dans le cadre d'une demande de service précédente. Vous pouvez seulement récupérer les artefacts pour les envois, les manifestes ou les envois retournés que vous avez créés.
page-index	simple	optionnel	Cet élément n'est pas requis ou doit être à zéro pour récupérer les documents PDF.

Demande – Diagramme XML

Obtenir l'artefact – 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 artefact. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir l'artefact – Éléments de la réponse
Nom de l'élément	Type	Description
get-artifact-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.
artifact-data	complexe	Structure XML contenant les résultats liés à l'exécution réussie du service en question.
image	simple	Image de l'étiquette ou du manifeste. 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	Fichier image de type MIME (après l'encodage en base64) : Image/pdf image/zpl

Réponse – Diagramme XML

Obtenir l'artefact – Structure de la réponse XML

Réponse – Réponses d'erreur possibles

Vous apercevrez une erreur 404 si vous utilisez le service Obtenir l'artefact plus de 90 jours après la création du numéro d'identification de l'artefact (élément « artifact-id »). Si vous utilisez le service Obtenir l'artefact pour récupérer une étiquette de retour autorisée, vous avez seulement cinq jours civils à récupérer cette étiquette une fois qu'elle est créée.

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 l'artefact


  

		<get-artifact-request>
	
		<locale>EN</locale>

		<artifact-id>10238</artifact-id>

		<page-index>0</page-index>

	
		</get-artifact-request>

Exemple de réponse XML selon le module SOAP – Obtenir l'artefact


  

		<get-artifact-response>
	
		<artifact-data>
	
		<image>JVBERi0xLj(Etc... base 64 Encoded PDF)</image>

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

	
		</artifact-data>

	
		</get-artifact-response>

Ouvrir unesession

Ressources