Programme pour développeurs

Prêt à rejoindre le Programme pour développeurs? Inscrivez-vous GRATUITE

Ressources

Ramassage

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

Obtenir la disponibilité du service de ramassage – Module REST

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

Structure de la demande pour obtenir la disponibilité du service de ramassage

Point final

GET https://XX/ad/pickup/pickupavailability/{code postal}
Remplacez...	Par...
XX (développement)	ct.soa-gw.canadapost.ca
XX (production)	soa-gw.canadapost.ca
{code postal}	le code postal du bureau de poste désiré

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accept	application/vnd.cpc.pickup+xml (Remarque : / à la place de la valeur de l’en-tête affichera un message d’erreur)
Authorization	Basic {Encodage base64 du code d'usager:mot de passe}
Accept-language	en-CA ou fr-CA

Corps du message

Aucun

Éléments de la demande

Le code postal est le seul paramètre requis ou permis pour le service Disponibilité du service de ramassage, tel qu'il est indiqué ci-dessous.

Obtenir la disponibilité du service de ramassage – REST – paramètres de la demande

Nom du
paramètre Type de
paramètre Description/Taille/Format

Obtenir la disponibilité du service de ramassage – REST – paramètres de la demande
Nom du paramètre	Type de paramètre	Description/Taille/Format
{postal code}	Intégré directement au URI	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 Internet. Le {code postal} est intégré au URI comme suit : `XX/ad/pickup/pickupavailability/{code postal}`

{postal code}

Intégré directement
au URI

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 Internet.

Le {code postal} est intégré au URI comme suit :

XX/ad/pickup/pickupavailability/{code postal}

Détails de la réponse

Éléments de réponse

Seuls les types simples d'éléments de réponse sont présentés dans le tableau ci-dessous. Pour les types complexes, se reporter au diagramme.

Obtenir la disponibilité du service de ramassage – REST – Aperçu détaillé des éléments de réponse
Étiquette	Description/Format
pickup-availability	Élément du niveau supérieur de la structure XML du message.
postal-code	Code postal complet Code postal à sept caractères en format de code postal valide (c.-à-d. toutes des majuscules, y compris une espace intégrée). (c'est-à-dire A9A 9A9.)
on-demand-cutoff	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	vrai \| faux Indique si les ramassages sur demande peuvent être demandés pour la région en question.
scheduled-pickups-available	vrai \| faux Indique si le service de ramassage à horaire fixe est offert pour ce code postal.

Réponses d'erreur possibles

Une demande bien structurée peut recevoir l'une des réponses d'erreur d'application suivantes :

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.

Diagramme XML de la réponse

Diagramme XML de la réponse à la demande Obtenir la disponibilité du service de ramassage

Figure 2: Diagram of XML Response to Get Pickup Availability

Exemples

Demande REST


  /cpc/ws/Pickup/getPickupAvailability/{postalcode}/

Réponse XML


  
  

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

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

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

		<prority-world-cutoff>14:00</prority-world-cutoff>

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

	
		</pickup-availability>

Exemple de réponse d'erreur


  
  
 <return>

    <error-list>

     <status-message>

       <code>No_Record_Found</code>

        <message></message>

      
    
    </error-list>

    </get-pickup-availability-response>

Ouvrir unesession