Expédition sans contrat

Exemples de codes pour l'expédition avec convention : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir des informations sur la clé publique des envois sans contrat – SOAP

Résumé

Nom :	Obtenir des informations sur la clé publique des envois sans contrat
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. SOAP : invoquez l'opération pour obtenir les informations sur la clé publique.
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é
Appel préalable typique :	Créer un envoi sans contrat Obtenez une expédition sans contrat
Prochain appel typique :	N/A
Historique des versions :	Notes de version

Détails sur la demande

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

SOAP Corps

Cette section décrit les éléments d'entrée XML de ce service.

Obtenir des informations sur la clé publique des envois sans contrat – Éléments de demande
Nom de l'élément	Type	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	(1-10 chiffre numérique) 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.
locale	Simple	Optionnel	Indique votre préférence linguistique pour recevoir des 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

N/A

Détails de la réponse

Response – Elements

Le tableau suivant décrit les éléments XML dans la réponse pour ce service.

Obtenir des informations sur la clé publique des envois sans contrat – Éléments de demande
Nom de l'élément	Type	Description
get-non-contract-shipment-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.
non-contract-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.

Réponse – Diagramme XML

N/A

Réponse – Réponses aux erreurs possibles

Aucune erreur n'est attendue pour l'appel de ce lien, mais vous recevrez une erreur 404 si vous appelez Obtenir des informations de clé publique d'expédition non contractuelle plus de 90 jours après la fourniture du lien.

Examples

Exemple de requête XML SOAP


  
    

        POST https://soa-gw.canadapost.ca/rs/soap/ncshipment/v4

		<v4:get-non-contract-shipment-public-key-info-request>
		
          <mailed-by>9935250</mailed-by>

          <shipment-id>362741689769145988</shipment-id>

		
		</v4:get-non-contract-shipment-public-key-info-request>

Exemple de réponse XML SOAP


    	
	

      <tns:get-non-contract-shipment-public-key-info-response>
        
          <non-contract-shipment-public-key-info>
            
              <expiry-date>2023-08-18T23:59:59-04:00</expiry-date>

              <url>https://canadapost-postescanada.ca/printlabel-imprimeretiquette?key-cle=dad634626de14af5812803bfcf4633ea</url>

            
         </non-contract-shipment-public-key-info>
        
      </tns:get-non-contract-shipment-public-key-info-response>

Ouvrir unesession

Ressources