Ramassage

Exemples de codes pour ramassage : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir la disponibilité du service de ramassage – Module SOAP

Résumé

Nom :	Obtenir la disponibilité du service de ramassage
Raison pour utiliser le service :	Pour récupérer des renseignements sur la disponibilité du service de ramassage et les heures limites disponibles en fonction du lieu de ramassage
Données d'entrée :	Code postal
Données de sortie :	Vrai ou faux pour la disponibilité du service de ramassage et les heures limites
Exemples d'erreurs :	Code postal invalide
Historique des versions :	Notes de mise à jour

Détails sur la demande

WSDL:	pickup.wsdl
Point final (Conception) :	https://ct.soa-gw.canadapost.ca/ad/soap/pickup/availability
Point final (Production) :	https://soa-gw.canadapost.ca/ad/soap/pickup/availability
Espace de nommage :	http://www.canadapost.ca/ws/soap/pickup/availability
Opération :	GetPickupAvailability

Corps – SOAP

Obtenir la disponibilité du service de ramassage – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
get-pickup-availability-request	complexe	requis	Élément XML de niveau supérieur de la structure de la réponse
postal-code	simple	requis	Code postal complet Code postal à six caractères en format de code postal valide (c.-à-d. A9A9A9) Nota : Si vous voulez utiliser des codes postaux avec une espace intégrée (p. ex. A9A 9A9), vous devez convertir ces espaces en %20 dans votre code avant de transférer la valeur au service en ligne.
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.

Demande – Diagramme XML

Obtenir la disponibilité du service de ramassage – 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 de la disponibilité du service de ramassage. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir la disponibilité du service de ramassage – Éléments de la réponse
Nom de l'élément	Type	Description
get-pickup-availability-response	complexe	Niveau supérieur de l'élément XML pour la réponse. Ce niveau affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur.
postal-code	simple	Code postal complet Code postal à sept caractères en format de code postal valide (c.-à-d. toutes les majuscules, y compris une espace intégrée)
on-demand-cutoff	simple	Heure nn h nn (horloge de 24 h) exprimée selon l'heure locale du code postal précisé. Indique l'heure la plus tardive à laquelle un ramassage peut être demandé pour le jour même pour les colis. Sera vide si « on-demand-tour » est faux.
on-demand-tour	simple	Vrai \| Faux Indique si les ramassages sur demande peuvent être demandés pour la région en question.
scheduled-pickups-available	simple	Vrai \| Faux Indique si le service de ramassage à horaire fixe est offert pour ce code postal.

Réponse – Diagramme XML

Obtenir la disponibilité du service de ramassage – 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 pour ce service sont les suivants :

Code	Message
No_PostalCode_Provided	S'affiche si aucun code postal n'est fourni dans la demande.
Invalid_PostalCode_format	S'affiche lorsque le code postal fourni ne réussit pas la vérification du format de base. (Nota : La vérification du format de base confirme seulement qu'il y a un nombre valide de caractères.)
No_Record_Found	S'affiche lorsque le système n'est pas en mesure de trouver des renseignements sur le code postal fourni. La cause la plus probable de cette erreur est qu'un code postal invalide a été fourni.

Code

Message

No_PostalCode_Provided

S'affiche si aucun code postal n'est fourni dans la demande.

Invalid_PostalCode_format

S'affiche lorsque le code postal fourni ne réussit pas la vérification du format de base.

(Nota : La vérification du format de base confirme seulement qu'il y a un nombre valide de caractères.)

No_Record_Found

S'affiche lorsque le système n'est pas en mesure de trouver des renseignements sur le code postal fourni. La cause la plus probable de cette erreur est qu'un code postal invalide a été fourni.

Exemples

Exemple de demande XML selon le module SOAP – Obtenir la disponibilité du service de ramassage


  

    <get-pickup-availability-request>
  
    <locale>EN</locale>

    <postal-code>K2B8J6</postal-code>

  
    </get-pickup-availability-request>

Exemple de réponse XML selon le module SOAP – Obtenir la disponibilité du service de ramassage


  

    <get-pickup-availability-response>
  
    <pickup-availability>
  
    <postal-code>K2B 8J6</postal-code>

    <on-demand-cutoff>16:00</on-demand-cutoff>

    <on-demand-tour>true</on-demand-tour>

    <scheduled-pickups-available>true</scheduled-pickups-available>

  
    </pickup-availability>

  
    </get-pickup-availability-response>

Ouvrir unesession

Ressources