Repérage

Exemples de codes de repérage : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir les détails de repérage – Module SOAP

Résumé

Nom :	Obtenir les détails de repérage
Raison pour utiliser le service :	Connaître toutes les activités de repérage pour un seul colis
Données d'entrée :	NIP/Numéro de CAL
Données de sortie :	Renseignements de base sur les colis, dates, emplacement et statut pour chaque événement et renseignements sommaires sur les colis.
Exemples d'erreurs :	Aucun historique pour le NIP
Demandes de service précédentes possibles :	Obtenir un résumé du repérage
Prochaines demandes de service possibles :	Obtenir l'image de la signature et 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 :	GetTrackingDetails

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 les détails de repérage – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
get-tracking-detail-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 sous condition	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) Lorsque vous exécutez une demande avec le NIP, ce numéro est obligatoire et il s'agit du seul paramètre nécessaire.
dnc	simple	requis sous condition	Numéro de la carte Avis de livraison (CAL) : Il s'agit du numéro figurant sur la carte laissée par le personnel de livraison lorsqu'il n'y a personne à la maison pour recevoir la livraison. (15 caractères numériques) Lorsque vous exécutez une demande avec le numéro de CAL, ce numéro est obligatoire et il s'agit du seul paramètre nécessaire.

Demande – Diagramme XML

Obtenir les détails de repérage – 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 des détails de repérage. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir les détails de repérage – Éléments de réponse
Nom de l'élément	Type	Description
get-tracking-detail-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.
pin-detail	complexe	Structure XML contenant les résultats liés à l'exécution réussie du service en question.
pin	simple	NIP pouvant être utilisé pour les autres demandes de repérage.
active-exists	simple	Vrai \| Faux La mention « Vrai » signifie que les données de suivi figurent dans la base de données actives.
archive-exists	simple	Vrai \| Faux La mention « Vrai » signifie que les données de suivi figurent dans la base de données archivées.
changed-expected-date	simple	aaaa-mm-jj Il s'agit de la nouvelle date de livraison prévue.
destination-postal-id	simple	Il s'agit des trois premiers caractères du code postal de destination pour les colis qui doivent être livrés au Canada. Pour les colis du régime international, il s'agit de l'identificateur postal du pays de destination (p. ex. le code ZIP pour les colis à destination des É.-U.) ou de l'identificateur du pays de destination.
expected-delivery-date	simple	Il s'agit de la date à laquelle l'article doit arriver à l'adresse de destination pour les adresses au Canada. Si l'article a été expédié à destination ou en provenance de l'étranger, cette date peut ne pas être indiquée.
changed-expected-delivery-reason	simple	Description du texte pour la raison du changement de la date de livraison prévue.
mailed-by-customer-number	simple	Numéro de client de l'expéditeur.
mailed-on-behalf-of-customer-number	simple	Numéro du client « Expédié au nom de » (le cas échéant).
original-pin	simple	Si un colis est retourné et que le colis initial a été créé avec une étiquette Service de retour prévu, ce champ contiendra le NIP initial lorsque le NIP de retour est demandé.
service-name	simple	Il s'agit du nom du service de Postes Canada dans la langue précisée par la demande. (Le nom du service sera indiqué par défaut en anglais si la langue n'est pas précisée.) Pour les colis d'arrivée du régime international, le champ relatif au type du service est vide ou il contient le nom du service fourni par l'expéditeur d'origine, le cas échéant.
service-name-2	simple	Il s'agit du nom du service de Postes Canada dans l'autre langue officielle du Canada. Pour les colis d'arrivée du régime international, le champ relatif au nom du service est vide ou il contient le nom du service fourni par l'expéditeur d'origine.
customer-ref-1	simple	Il s'agit de la valeur fournie par l'expéditeur (référence du client 1) lorsque l'envoi a d'abord été créé auprès de Postes Canada. L'ensemble de caractères en français est appuyé par cette interface.
customer-ref-2	simple	Il s'agit de la valeur fournie par l'expéditeur (référence du client 2) lorsque l'envoi a d'abord été créé par Postes Canada. Il faut éviter d'utiliser des caractères spéciaux en saisissant les numéros de référence des clients.
return-pin	simple	Si un colis est envoyé avec une étiquette Service de retour prévu, ce champ contiendra le NIP de retour lorsque le NIP initial est demandé.
signature-image-exists	simple	Vrai \| Faux Vrai : Le service « Obtenir l'image de la signature » affichera l'image de la signature. Faux : Il n'est pas nécessaire de sélectionner le service « Obtenir l'image de la signature » puisque le système indiquera qu'aucune image n'est trouvée.
suppress-signature	simple	Vrai \| Faux Indique si le destinataire du colis a demandé de supprimer l'image de sa signature recueillie par Postes Canada pour les colis du régime intérieur afin qu'elle ne puisse pas être visualisée par d'autres.
delivery-options	complexe	Série d'options de livraison demandées pour ce colis.
delivery-option	simple	La chaîne représente l'option de livraison.
delivery-option-description	simple	Description de l'option de livraison.
cod-remit-info	complexe	Renseignements associant un colis CR à une activité de suivi du paiement ou vice versa.
pin	simple	Dans ce cas, il s'agit du NIP d'un paiement CR ou du colis initial selon la valeur du type.
type	simple	Valeur de COD_PIN ou de REMIT_PIN. Il indique le NIP correspondant à la valeur susmentionnée.
significant-events	complexe	Liste d'activités associées au colis.
occurrence	complexe	L'élément parent est un ensemble de renseignements importants sur un événement.
event-identifier	simple	Identificateur de l'activité utilisé pour définir les types d'activités.
event-date	simple	aaaa-mm-jj – Date de l'activité de suivi.
event-time	simple	hh:mm:ss – Heure de l'activité de suivi.
event-time-zone	simple	Fuseau horaire associé à l'activité. Il pourrait ne pas être défini pour les activités de suivi à l'échelle internationale.
event-description	simple	Brève description de l'activité.
signatory-name	simple	Si l'activité présentée est une activité de saisie de la signature, le texte de ce champ correspondra au nom du signataire.
event-site	simple	Renseignements sur l'emplacement fournis par le préposé au service de colis.
event-province	simple	Pour les activités du régime intérieur, il contient la province où l'activité a eu lieu.
event-retail-location-id	simple	Contient le numéro d'identification du bureau lorsqu'un colis est retenu ou qu'il a été retenu.
event-retail-name	simple	Nom du comptoir postal où le colis est retenu.

Réponse – Diagramme XML

Obtenir les détails de repérage – Structure de la réponse XML

Voir l'image en taille réelle

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

Exemples

Exemple de demande XML selon le module SOAP – Demande de détails liés aux NIP


  

		<get-tracking-detail-request>
	
		<locale>EN</locale>

		<pin>1371134583769923</pin>

	
		</get-tracking-detail-request>

Exemple de réponse XML selon le module SOAP – Réponse concernant les détails liés aux NIP


  

		<get-tracking-detail-response>
	
		<tracking-detail>
	
		<pin>1111111583769923</pin>

		<active-exists>1</active-exists>

		<archive-exists></archive-exists>

		<changed-expected-date>2011-02-11</changed-expected-date>

		<destination-postal-id>G1K4M7</destination-postal-id>

		<expected-delivery-date>2011-02-01</expected-delivery-date>

		<changed-expected-delivery-reason>Customer addressing error found; attempting to correct</changed-expected-delivery-reason>

		<mailed-by-customer-number>0001111111</mailed-by-customer-number>

		<mailed-on-behalf-of-customer-number>0001111111</mailed-on-behalf-of-customer-number>

		<original-pin></original-pin>

		<service-name>Xpresspost</service-name>

		<service-name-2>Xpresspost</service-name-2>

		<customer-ref-1>555-5555</customer-ref-1>

		<customer-ref-2></customer-ref-2>

		<return-pin></return-pin>

		<signature-image-exists>true</signature-image-exists>

		<suppress-signature>false</suppress-signature>

		<delivery-options>
	
		<item>
	
		<delivery-option></delivery-option>

		<delivery-option-description></delivery-option-description>

	
		</item>

		<item>
	
		<delivery-option>CH_SGN_OPTION</delivery-option>

		<delivery-option-description>Signature Required</delivery-option-description>

	
		</item>

	
		</delivery-options>

		<significant-events>
	
		<occurrence>
	
		<event-identifier>1496</event-identifier>

		<event-date>2011-02-03</event-date>

		<event-time>11:59:59</event-time>

		<event-time-zone>EST</event-time-zone>

		<event-description>Item successfully delivered</event-description>

		<signatory-name></signatory-name>

		<event-site>SAINTE-FOY</event-site>

		<event-province>QC</event-province>

		<event-retail-location-id></event-retail-location-id>

		<event-retail-name></event-retail-name>

	
		</occurrence>

		<occurrence>
	
		<event-identifier>20</event-identifier>

		<event-date>2011-02-03</event-date>

		<event-time>11:59:59</event-time>

		<event-time-zone>EST</event-time-zone>

		<event-description>Signature image recorded for Online viewing</event-description>

		<signatory-name>HETU</signatory-name>

		<event-site>SAINTE-FOY</event-site>

		<event-province>QC</event-province>

		<event-retail-location-id></event-retail-location-id>

		<event-retail-name></event-retail-name>

	
		</occurrence>

		<occurrence>
	
		<event-identifier>0174</event-identifier>

		<event-date>2011-02-03</event-date>

		<event-time>08:27:43</event-time>

		<event-time-zone>EST</event-time-zone>

		<event-description>Item out for delivery</event-description>

		<signatory-name></signatory-name>

		<event-site>SAINTE-FOY</event-site>

		<event-province>QC</event-province>

		<event-retail-location-id></event-retail-location-id>

		<event-retail-name></event-retail-name>

	
		</occurrence>

		<occurrence>
	
		<event-identifier>0100</event-identifier>

		<event-date>2011-02-02</event-date>

		<event-time>14:45:48</event-time>

		<event-time-zone>EST</event-time-zone>

		<event-description>Item processed at postal facility</event-description>

		<signatory-name></signatory-name>

		<event-site>QUEBEC</event-site>

		<event-province>QC</event-province>

		<event-retail-location-id></event-retail-location-id>

		<event-retail-name></event-retail-name>

	
		</occurrence>

		<occurrence>
	
		<event-identifier>0173</event-identifier>

		<event-date>2011-02-02</event-date>

		<event-time>06:19:57</event-time>

		<event-time-zone>EST</event-time-zone>

		<event-description>Customer addressing error found; attempting to correct.
						Possible delay</event-description>

		<signatory-name></signatory-name>

		<event-site>QUEBEC</event-site>

		<event-province>QC</event-province>

		<event-retail-location-id></event-retail-location-id>

		<event-retail-name></event-retail-name>

	
		</occurrence>

		<occurrence>
	
		<event-identifier>1496</event-identifier>

		<event-date>2011-02-01</event-date>

		<event-time>07:59:52</event-time>

		<event-time-zone>EST</event-time-zone>

		<event-description>Item successfully delivered</event-description>

		<signatory-name></signatory-name>

		<event-site>QUEBEC</event-site>

		<event-province>QC</event-province>

		<event-retail-location-id></event-retail-location-id>

		<event-retail-name></event-retail-name>

	
		</occurrence>

		<occurrence>
	
		<event-identifier>20</event-identifier>

		<event-date>2011-02-01</event-date>

		<event-time>07:59:52</event-time>

		<event-time-zone>EST</event-time-zone>

		<event-description>Signature image recorded for Online viewing</event-description>

		<signatory-name>R GREGOIRE</signatory-name>

		<event-site>QUEBEC</event-site>

		<event-province>QC</event-province>

		<event-retail-location-id></event-retail-location-id>

		<event-retail-name></event-retail-name>

	
		</occurrence>

		<occurrence>
	
		<event-identifier>0500</event-identifier>

		<event-date>2011-02-01</event-date>

		<event-time>07:51:23</event-time>

		<event-time-zone>EST</event-time-zone>

		<event-description>Out for delivery</event-description>

		<signatory-name></signatory-name>

		<event-site>QUEBEC</event-site>

		<event-province>QC</event-province>

		<event-retail-location-id></event-retail-location-id>

		<event-retail-name></event-retail-name>

	
		</occurrence>

		<occurrence>
	
		<event-identifier>2300</event-identifier>

		<event-date>2011-01-31</event-date>

		<event-time>17:06:02</event-time>

		<event-time-zone>EST</event-time-zone>

		<event-description>Item picked up by Canada Post</event-description>

		<signatory-name></signatory-name>

		<event-site>MONTREAL</event-site>

		<event-province>QC</event-province>

		<event-retail-location-id></event-retail-location-id>

		<event-retail-name></event-retail-name>

	
		</occurrence>

		<occurrence>
	
		<event-identifier>3000</event-identifier>

		<event-date>2011-01-31</event-date>

		<event-time>14:34:57</event-time>

		<event-time-zone>EST</event-time-zone>

		<event-description>Order information received by Canada Post</event-description>

		<signatory-name></signatory-name>

		<event-site>LACHINE</event-site>

		<event-province>QC</event-province>

		<event-retail-location-id></event-retail-location-id>

		<event-retail-name></event-retail-name>

	
		</occurrence>

	
		</significant-events>

	
		</tracking-detail>

	
		</get-tracking-detail-response>

Ouvrir unesession

Ressources