Expédition sous contrat
Obtenir les informations sur la clé publique de l'expédition – SOAP
Résumé
Nom : | Obtenir les informations sur la clé publique de l'expédition |
---|---|
Raison d'appeler : | Pour récupérer les détails de la clé publique, notamment la date d'expiration, le code QR, l'URL publique (URL non authentifiée) |
Saisir : |
REST : appelle le lien renvoyé par un appel précédent. |
Sortir : |
La clé publique comprenant la date d'expiration, le code QR, l'URL publique (URL non authentifiée) |
Exemples d'erreurs : | 404 - Pas trouvé |
Typical Prior Call: | Créer Expedition Obtenir l'expédition |
Prochain appel typique : | N/A |
Historique des versions : | Notes de version |
Détails de l'appel
WSDL: | shipment.wsdl |
---|---|
Point final (développement) : | https://ct.soa-gw.canadapost.ca/rs/soap/shipment/v8 |
Espace de noms : | http://www.canadapost.ca/ws/soap/shipment/v8 |
Opération : | GetShipmentPublicKeyInfo |
SOAP CORPS
Cette section décrit les éléments d'entrée XML de ce service.
Obtenir les informations sur la clé publique de l'expédition – Détails de la réponse | |||
---|---|---|---|
Nom de l'élément | Taper | Requis / Optionnel | Description |
get-shipment-public-key-info-request |
Complexe |
Requis |
Il s'agit de la structure XML globale des informations d'entrée de la requête. |
mailed-by |
Simple |
Requis |
(numérique de 1 à 10 chiffres) Le numéro de client à 10 chiffres du client envoyé par la poste. Si le nombre fourni comporte moins de 10 chiffres, le système ajoutera des zéros non significatifs. |
mobo |
Simple |
Optionnel |
(numérique de 1 à 10 chiffres) Le numéro de client à 10 chiffres du client envoyé par la poste au nom du client. Si cet élément est manquant, il sera par défaut le numéro de client envoyé par la poste. Si le nombre fourni comporte moins de 10 chiffres, le système ajoutera des zéros non significatifs. Lorsque l'option Envoyé par la poste n'est pas égale à Envoyé par, la combinaison Envoyé par / MoBo doit avoir été configurée dans le système avant de pouvoir être utilisée, afin d'éviter la fraude. |
locale |
Simple |
Optionnel |
Indique votre préférence linguistique pour recevoir les messages d'erreur. EN = Anglais FR = Français Si aucune valeur n’est fournie, la langue par défaut est l'anglais. |
shipment-id |
Simple |
Requis |
(Chaîne alphanumérique – jusqu'à 32 lettres/chiffres) Un numéro d'identification représentant l'envoi existant pour lequel des renseignements sont demandés. Remarque : Récupérez l'identifiant d'expédition fourni par les appels précédents à Créer un envoi ou Obtenir des envois. La sortie de ces services inclura un élément shipment-id. |
Demande – Diagramme XML
Détails de la réponse
Réponse – Éléments
Le tableau suivant décrit les éléments XML dans la réponse à Get Shipment Public Key Info.
Get Shipment Public Key Info - Détails de la réponse | ||
---|---|---|
Nom de l'élément | Taper | Description |
get-public-key-info response |
Complexe |
L'élément XML de niveau supérieur pour la réponse. Il contiendra soit les résultats d'une réussite, soit la structure du message d'erreur. |
shipment-public-key-info |
Complexe |
La structure XML contenant les résultats d'une réalisation réussie du service. |
expiry-date |
Simple |
Pareil que dans le REST response. |
url |
Simple |
Pareil que dans le REST response. |
qr-code |
Simple |
Pareil que dans le REST response. |
Response – XML Diagram
Réponse – Réponses aux erreurs possibles
Aucune erreur n'est attendue lors de l'invocation de ce lien, mais vous recevrez une erreur 404 si vous invoquez Get Shipment Public Key Info plus de 90 jours après la fourniture du lien.
Exemples
Exemple de demande XML SOAP – Obtenir des informations sur la clé publique de l'expédition
<v8:get-public-key-info-request>
<mailed-by>1234567</mailed-by>
<shipment-id>123456789012345678</shipment-id>
</v8:get-public-key-info-request>
Exemple de réponse XML SOAP – Obtenir des informations sur la clé publique de l'expédition
<tns:get-public-key-info-response>
<shipment-public-key-info>
<expiry-date>2024-01-22T23:59:59-05:00</expiry-date>
<url>https://canadapost-postescanada.ca/printlabel-imprimeretiquette?key-cle=7d8157cdba084043bdbd4b85a51d5fc9</url>
<qr-code>/9j/4AA...</qr-code>
</shipment-public-key-info>
</tns:get-public-key-info-response>