Repérage
Obtenir l'image de la signature – Module REST
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 en particulier. |
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 |
Appels précédents habituels : | Obtenir un résumé du repérage, Obtenir les détails de suivi |
Prochain appel possible : | Obtenir le certificat de confirmation de livraison |
Historique des versions : | Notes de mise à jour |
Détails sur la demande
Structure de la demande pour obtenir l'image de la signature
Point finalGET https://XX/vis/signatureimage/{numéro d'identification du produit} |
|
---|---|
Remplacez... | Par... |
XX (développement) |
ct.soa-gw.canadapost.ca |
XX (production) |
soa-gw.canadapost.ca |
{numéro d'identification du produit} |
le numéro d'identification du produit (NIP) |
Variable des en-têtes HTTP |
Valeur |
---|---|
Accept |
application/vnd.cpc.track-v2+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur) |
Authorization |
Basic {Encodage base64 du code d'usager:mot de passe} |
Accept-language |
en-CA ou fr-CA |
Aucun
Éléments de la demande
Il n'y a pas de données d'entrée autre que le NIP, soit le seul paramètre nécessaire ou permis pour ce service.
Détails de la réponse
Éléments de réponse
Il n'y a pas de données d'entrée autre que le NIP, soit le seul paramètre nécessaire ou permis pour ce service.
Obtenir l'image de la signature – REST – Aperçu détaillé des éléments de réponse | |
---|---|
signature-image | L'élément du niveau supérieur de la structure XML. |
filename |
Représente le nom du fichier du fichier image. |
image |
Contenu codé de 64 bits dans le fichier. |
mime-type |
Représente le type MIME du fichier (type/sous-type). |
Réponses d'erreur possibles
Une demande bien structurée peut recevoir l'une des réponses d'erreur d'application suivantes :
Code | Description |
---|---|
004 |
Aucun historique pour le NIP |
002 |
NIP en double |
003 |
Aucune image de la signature n'est disponible |
Diagramme XML de la réponse
Un seul des messages ou la structure de l'image de la signature s'affichera.
Exemples
Demande à l'option Obtenir l'image de la signature
GET https://XX/vis/signatureimage/7253760000072566
Réponse de l'option Obtenir l'image de la signature
<signature-image>
<filename>1371134583769923.jpg</filename>
<image>/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGB
gcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICI
sIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgND
RgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjI
yMjIyMjIyMjIyMjIyMjIyMjL/wAARCABfAZADASIAAhEBAxEB8
QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAA
AgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBka
</image>
<mime-type>image/jpg</mime-type>
</signature-image>