Ramassage

Obtenir les détails sur la demande de ramassage – Module REST

Résumé

Nom :	Obtenir les détails sur la demande de ramassage
Raison pour utiliser le service :	Pour récupérer tous les détails disponibles sur une demande de ramassage particulière.
Données d'entrée :	Il faut utiliser le lien associé à une demande de service précédente lorsque rel="details".
Données de sortie :	Détails de la demande de ramassage.
Demande de service précédente habituelle :	Créer une demande de ramassage ou récupérer des demandes de ramassage.
Prochaine demande de service habituelle :	S.O.
Historique des versions :	Notes de mise à jour

Obtenir les détails sur la demande de ramassage – Résumé du service

Détails sur la demande

Demande – Structure pour le service « Obtenir les détails sur la demande de ramassage »

Point final

Il faut utiliser le lien associé à une demande de service précédente pour créer une demande de ramassage ou récupérer une demande de ramassage lorsque rel="details" (voir Points finaux fournis)

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accept	application/vnd.cpc.pickuprequest+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

Demande – Éléments

Les données d'entrée XML ne sont pas nécessaires pour le service « Obtenir les détails sur la demande de ramassage ».

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.

Obtenir les détails sur la demande de ramassage – Éléments de la réponse
Nom de l'élément	Type	Description
pickup-request-detailed-info	Complexe	Il s'agit de l'élémentXML de niveau supérieur contenant les détails sur la demande de ramassage.
pickup-request-header	Complexe	Renseignements de base sur la demande.
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	Le 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.
pickup-request-details	Complexe	Renseignements détaillés à propos de la demande.
pickup-location	Complexe	Structure contenant l'adresse du lieu de ramassage.
business-address-flag	Simple	La valeur « vrai » signifie que le ramassage est à effectuer à votre adresse commerciale. La valeur « faux » indique que le ramassage est à effectuer à un lieu de tierce partie.
altnerate-address	Complexe	Structure contenant les détails sur l'adresse pour le ramassage à effectuer à un lieu de tierce partie.
company	Simple	Raison sociale de l'organisation qui demande le ramassage.
address-line-1	Simple	Adresse municipale du lieu de ramassage.
city	Simple	Ville du lieu de ramassage.
province	Simple	Province du lieu de ramassage.
postal-code	Simple	Code postal du lieu de ramassage au format «A9A9A9».
contact-info	Complexe	Structure contenant la personne-ressource à qui adresser les questions ou demandes.
contact-name	Simple	Nom de la personne-ressource pour le ramassage.
email	Simple	Adresse électronique à laquelle envoyer les mises à jour de l'état de votre demande de ramassage. Remarque : Si vous disposez depuis longtemps d'une convention de ramassage à horaire fixe, cet élément pouvait auparavant avoir été optionnel. Il est désormais requis, et vous devrez le fournir si vous mettez à jour votre demande de ramassage.
contact-phone	Simple	Numéro de téléphone de la personne-ressource pour le ramassage.
telephone-ext	Simple	Numéro du poste téléphonique.
receive-email-updates-flag	Simple	La valeur «vrai» indique que vous voulez recevoir de mises à jour de l'état de votre demande.
location-details	Complexe	Structure contenant les caractéristiques du lieu physique où le ramassage doit avoir lieu.
five-ton-flag	Simple	La valeur «vrai» indique qu'un camion de cinq tonnes est requis.
loading-dock-flag	Simple	La valeur «vrai» indique qu'il y a un quai de chargement au lieu de ramassage.
pickup-instructions	Simple	Instructions à l'intention du conducteur (p.ex. utiliser la porte arrière ou la porte latérale, apporter une plate-forme à roues).
items-characteristics	Complexe	Structure pour déterminer qu'un traitement spécial est nécessaire pour les articles à ramasser. Applicable uniquement aux ramassages sur demande.
priority-flag	Simple	Indique si des articles prioritaires peuvent être disponibles pour le ramassage.
returns-flag	Simple	Indique si des articles renvoyés peuvent être disponibles pour le ramassage.
heavy-item-flag	Simple	Indique si certains articles à ramasser peuvent peser plus de 23kg (50lb).
pickup-volume	Simple	Pour un ramassage sur demande, le nombre prévu d'articles à ramasser.
pickup-times	Complexe	Structure contenant la date et la période à laquelle le ramassage doit avoir lieu.
on-demand-pickup-time	Complexe	Structure contenant les détails d'une demande de ramassage sur demande.
date	Simple	Date à laquelle vous souhaitez votre ramassage sur demande.
preferred-time	Simple	Heure préférée du ramassage sur demande.
closing-time	Simple	Heure limite du ramassage sur demande.
scheduled-pickup-times		Option non utilisée. Demandez un ramassage à horaire fixe à l’aide de notre outil en ligne.

Réponse – Diagramme XML

Obtenir les détails sur la demande de ramassage – Structure de la réponse XML

Voir l'image en taille réelle

Réponses d'erreur possibles

Aucune erreur n'est prévue pour l'utilisation de ce lien, mais vous apercevrez une erreur 404 si vous utilisez le service Obtenir les détails sur la demande de ramassage plus de 90 jours après que le lien a été fourni.

Code	Description
11005	Le numéro de client est invalide. Veuillez corriger ou contacter Postes Canada pour plus de détails.
11012	Numéro de demande introuvable. Veuillez vérifier.

Exemples

Exemple de demande XML selon le module REST – Obtenir les détails sur la demande de ramassage


  	GET  https://ENV/enab/1234567/pickuprequest/1212121212/details 

    Accept:  application/vnd.cpc.pickuprequest+xml

	Authorization: Basic s7HD7gwsennesc==

Exemple de réponse XML selon le module REST – Obtenir les détails sur la demande de ramassage


  <pickup-request-detailed-info> 

    <pickup-request-header> 

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

    <request-status>assigned</request-status> 

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

    </pickup-request-header> 

    <pickup-request-details> 

    <pickup-type>OnDemand</pickup-type> 

    <pickup-location> 

    <company>Jim Duggan</company> 

    <address-line-1>2271 Herring Cove</address-line-1> 

    <city>Halifax</city><province>NS</province> 

    <postal-code>B3L2C2</postal-code> 

    </pickup-location> 

    <contact-info> 

    <contact-name>Joe Hattie</contact-name> 

    <email>tester@gmail.ca</email> 

    <contact-phone>9025551212</contact-phone> 

    <telephone-ext>2123</telephone-ext> 

    <opt-out-email-updates-flag>true</opt-out-email-updates-flag> 

    </contact-info> 

    <location-details> 

    <five-ton-flag>false</five-ton-flag> 

    <loading-dock-flag>true</loading-dock-flag> 

    <pickup-instructions>Door at Back</pickup-instructions> 

    </location-details> 

    <items-characteristics> 

    <pww-flag>true</pww-flag> 

    <priority-flag>false</priority-flag> 

    <returns-flag>true</returns-flag> 

    <heavy-item-flag>true</heavy-item-flag> 

    <pickup-volume>50</pickup-volume> 

    <items-characteristics> 

    <pickup-times> 

    <on-demand-pickup-time> 

    <date>2015-01-28</date> 

    <preferred-time>15:00:00</preferred-time> 

    <closing-time>17:00:00</closing-time> 

    </on-demand-pickup-time> 

    </pickup-times> 

    <payment-info> 

    <method-of-payment>Account</method-of-payment> 

    </payment-info> 

    </pickup-request-details>

    </pickup-request-detailed-info>

Ouvrir unesession

Ressources