Repérage

Obtenir l'image de la signature – Module SOAP

Résumé

Nom :	Obtenir l'image de la signature
Raison de l'appel :	Pour récupérer l'image de la signature fournie pour un colis précis
Données d'entrée :	NIP
Données de sortie :	Image JPG codée en chaîne d'octets
Exemples d'erreurs :	NIP introuvable, signature non disponible
Demandes de service précédentes habituelles :	Obtenir un résumé du repérage, Obtenir les détails de repérage
Prochaine demande de service possible :	Obtenir le certificat de confirmation de livraison
Historique des versions :	Notes de mise à jour

Détails sur la demande

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

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'image de la signature – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
get-signature-image-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 saisie, la langue par défaut est l'anglais.
pin	simple	requis	Le numéro d'identification du produit (NIP) est attribué par Postes Canada au cours de la création de l'étiquette d'expédition et utilisé aux fins de repérage. (12, 13 ou 16 caractères)

Demande – Diagramme XML

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

Obtenir l'image de la signature – Éléments de réponse
Nom de l'élément	Type	Description
get-signature-image-response	complexe	Il s'agit de l'élément XML de niveau supérieur pour les données de la réponse. Il affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur.
filename	simple	Représente le nom du fichier image.
image	simple	Contenu du fichier codé en base 64.
mime-type	simple	Représente le fichier de type MIME (type/sous-type).

Réponse – Diagramme XML

Obtenir l'image de la signature – 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	Description
004	Aucun historique pour le NIP
002	NIP en double
003	Aucune image de la signature n'est disponible

Exemples

Exemple de demande XML selon le module SOAP – Obtenir l'image de la signature

<get-signature-image-request>

<locale>EN</locale>
<pin>1371134583769923</pin>

</get-signature-image-request>

Exemple de réponse XML selon le module SOAP – Obtenir l'image de la signature

<get-signature-image-response>

<signature-image>

<filename>1111111583769923.jpg</filename>
<image>/9j/4AAQSkZJRgAB(etc... base 64 encoded PDF)</image>
<mime-type>image/jpg</mime-type>

</signature-image>

</get-signature-image-response>