Expédition sans convention

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

Obtenir les envois sans convention – Module SOAP

Résumé

Nom :	Obtenir les envois sans convention
Raison pour utiliser le service :	Pour chercher les envois sans convention créés récemment aux fins de récupération ou de réimpression
Données d'entrée :	Dates et heures de début et de fin ou NIP de repérage
Données de sortie :	Numéros d'identification pour les envois dans la période précisée (date et heure)
Prochaine demande de service habituelle :	Obtenir l'envoi sans convention
Historique des versions :	Notes de mise à jour

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 :	GetNonContractShipments

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 envois sans convention – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
get-non-contract-shipments-request	complexe	requis	Élément XML de niveau supérieur de la structure de la réponse.
mailed-by	simple	requis	(1 à 10 caractères numériques) Il s'agit du numéro de client à 10 chiffres du client « Expédié par ». Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début.
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 fournie, la langue par défaut est « Anglais ».
from	simple	requis sous condition	Date et heure de début de la période pour laquelle les envois sans convention sont recherchés. Il faut utiliser le format XSD (AAAA-MM-JJTHH:MM:SS) pour désigner la date et l'heure lorsque : « AAAA » = Année « MM » = Moi « JJ » = Journée « T » = Début de la section de temps requise « hh » = Heure (format de 24 heures) « mm » = Minute « ss » = Seconde Exemple: 2012-02-30T09:00:00 Toutes les dates et les heures sont fonction du fuseau horaire de l'Est. Si la date ou l'heure n'est pas fournie, la date ou l'heure actuelle s'affiche par défaut. Option s'excluant mutuellement avec l'élément tracking-pin.
to	simple	optionnel	Date et heure de début de la période pour laquelle les envois sans convention sont recherchés. Il faut utiliser le format XSD (AAAA-MM-JJTHH:MM:SS) pour désigner la date et l'heure lorsque : « AAAA » = Année « MM » = Moi « JJ » = Journée « T » = Début de la section de temps requise « hh » = Heure (format de 24 heures) « mm » = Minute « ss » = Seconde Toutes les dates et les heures sont fonction du fuseau horaire de l'Est. Si la date ou l'heure n'est pas fournie, la date ou l'heure actuelle s'affiche par défaut.
tracking-pin	simple	requis sous condition	(Chaîne alphanumérique – 11 à 16 lettres/chiffres) NIP de repérage de l'envoi existant pour lequel les renseignements sont demandés. Option s'excluant mutuellement avec la « date de début ». Remarque : Dans l'environnement (de développement) « Bac à sable », le même NIP de repérage est toujours retourné (123456789012); alors, cette requête ne retournera pas des résultats représentatifs dans cet environnement.

Demande – Diagramme XML

Obtenir les envois sans convention – Structure de la réponse 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 envois sans convention. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Get Non-Contract Shipments – Response Elements
Nom de l'élément	Type	Description
get-non-contract-shipments-response	complexe	Il s'agit de l'élément XML de niveau supérieur de la structure de la réponse. Il affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur.
non-contract-shipments	complexe	Structure XML contenant les résultats liés à l'exécution réussie du service en question.
shipment-id	simple	Série de numéros d'identification pour les envois dans la période précisée (date et heure). Occurrence (0 à N fois).

Réponse – Diagramme XML

Obtenir les envois sans convention – 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 sont les suivants :

Code	Message
9105	Un paramètre requis n'a pas été fourni dans la demande.
9116	La date de début ne peut pas être postérieure à la date de fin.
9196	Only one of from (date) and tracking PIN must be provided.

Exemples

Exemple de demande XML selon le module SOAP – Obtenir les envois sans convention


  

		<get-non-contract-shipments-request>
	
		<mailed-by>1111111</mailed-by>

		<locale>EN</locale>

		<from>2012-01-10T13:06:07</from>

	
		</get-non-contract-shipments-request>

Exemple de réponse XML selon le module SOAP – Obtenir les envois sans convention


  

		<get-non-contract-shipments-response>
	
		<non-contract-shipments>
	
		<shipment-id>406951321983787352</shipment-id>

	
		</non-contract-shipments>

	
		</get-non-contract-shipments-response>

Ouvrir unesession

Ressources