Ramassage

Récupérer les demandes de ramassage – Module SOAP

Résumé

Nom :	Récupérer les demandes de ramassage
Raison pour utiliser le service :	Pour récupérer les liens vers les demandes de ramassage ouvertes.
Données d'entrée :	Les données d'entrée XML ne sont pas nécessaires pour ce service.
Données de sortie :	ID, statut et date de toutes les demandes de ramassage ouvertes.
Historique des versions :	Notes de mise à jour

Récupérer les demandes de ramassage – Résumé du service

Détails sur la demande

WSDL :	shipment.wsdl
Point final (Conception) :	https://ct.soa-gw.postescanada.ca /enab/soap/pickup
Point final (Production) :	https://soa-gw.postescanada.ca /enab/soap/pickup
Espace de nommage :	http://www.canadapost.ca/ws/pickuprequest
Opération :	GetPickupRequests

Corps – SOAP

La présente section décrit les éléments XML d'entrée pour récupérer les demandes de ramassage. Pour obtenir la structure hiérarchique, consultez le diagramme XML.

Récupérer les demandes de ramassage – Éléments de la demande
Nom de l'élément	Type	Requis/Facultatif	Description
get-pickup-requests-request	Complexe	Requis	Élément XML de niveau supérieur de la structure de la réponse.
customer-number	Simple	Requis	(1 à 10 caractères numériques) Votre numéro de client. Si le numéro fourni compte moins de dix chiffres, le système ajoutera des zéros au début.
locale	Simple	Facultatif	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.
platform-id	Simple	Facultatif	Numéro de client de la plateforme. S'applique seulement aux plateformes de cybercommerce.

Demande – Diagramme XML

Récupérer les demandes de ramassage – Structure de la demande XML

Détails de la réponse

Réponse – Éléments

Le tableau ci-dessous décrit les champs XML dans la réponse. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Récupérer les demandes de ramassage – Éléments de la réponse
Nom de l'élément	Type	Description
get-pickup-requests-response	Complexe	Structure XML contenant les renseignements sur la demande de ramassage. Il affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur.
pickup-requests	Complexe	La structure d'une exécution réussie s'affiche.
pickup-request	Complexe	Le niveau supérieur de la structure pour chaque demande de ramassage. Un suivi sera assuré pour toutes les demandes ouvertes/actives et l’historique récent (jusqu’à 20 demandes).
pickup-request-header	Complexe	Structure contenant les renseignements de base sur la demande de ramassage.
request-id	Simple	Numéro d'identification de la demande de ramassage.
request-status	Simple	Statut de la demande. Les valeurs possibles sont les suivantes : New (Nouveau) Pending (en attente) Cancelled (annulée) Active (active) Missed Pickup (ramassage manquée)
pickup-type	Simple	Type de ramassage demandé: OnDemand (sur demande) .
request-date	Simple	Date à laquelle la demande de ramassage a été créée.
next-pickup-date	Simple	Date pour laquelle une demande de ramassage est demandée.

Réponse – Diagramme XML

Récupérer les demandes de ramassage – Structure de la réponse XML

Voir l'image en taille réelle

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 plus de renseignements, consultez les Principes de base liés au module SOAP pour les services en ligne de Postes Canada.

Le code de retour HTTP 404 (introuvable) s'affiche si aucune demande de ramassage n'a été trouvée.

Code	Description
11005	Le numéro de client est invalide. Veuillez corriger ou contacter Postes Canada pour plus de détails.

Consultez également la section Messages d'erreur et stratégies d'atténuation.

Exemples

Exemple de demande XML selon le module SOAP – Récupérer les demandes de ramassage


  	<get-pickup-requests-request>

  	<customer-number>1234567</customer-number>

  	<locale>EN</locale>

	</get-pickup-requests-request>

Exemple de réponse XML selon le module SOAP – Récupérer les demandes de ramassage


  	<get-pickup-requests-response> 

    <pickup-request-header> 

    <request-id>1212121212</request-id> 

    <request-status>pending</request-status> 

    <request-date>20140909</request-date> 

    </pickup-request-header>

    </get-pickup-requests-response>

Environnement « Bac à sable » (développement) pour la réponse XML – Récupérer les demandes de ramassage

La réponse est figée (statique) dans l'environnement de développement; par conséquent, vous recevrez toujours la réponse ci-dessous, peu importe les données dans votre demande.


  	<get-pickup-requests-response> 

      <pickup-request-info> 

      <pickup-request-header> 

      <request-id>1212121212</request-id> 

      <request-status>Picked Up</request-status> 

      <request-date>20150101</request-date> 

      </pickup-request-header> 

      </pickup-request-info> 

      <pickup-request-info> 

      <pickup-request-header> 

      <request-id>12345678</request-id> 

      <request-status>active</request-status> 

      <request-date>20150101</request-date> 

      <next-pickup-date>20150601</next-pickup-date> 

      </pickup-request-header> 

      </pickup-request-info>

      </get-pickup-requests-response>

Ouvrir unesession

Ressources