Ramassage

Mettre à jour la demande de ramassage – Module REST

Résumé

Nom : Mettre à jour la demande de ramassage
Raison pour utiliser le service : Pour modifier une demande de ramassage (p. ex. la personne-ressource ou les heures de ramassage).
Données d'entrée : Détails sur la demande de ramassage (les mêmes données que le service Créer une demande de ramassage)
Données de sortie : Indicateur signalant l'exécution réussie du service
Historique des versions :

Notes de mise à jour

Mettre à jour la demande de ramassage – Résumé du service

Mettre à jour la demande de ramassage – Résumé du service

Détails sur la demande

Demande – Structure pour le service « Mettre à jour 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="self" (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)

Content-Type

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

<?xml version="1.0" encoding="utf-8"?>
<pickup-request-details xmlns="http://www.canadapost.ca/ws/pickuprequest”>
xxx
</pickup-request-details>

Demande – Éléments

Le tableau ci-dessous décrit les éléments XML d'entrée pour le service Mettre à jour la demande de ramassage. Pour obtenir la structure hiérarchique des entrées, consultez le diagramme XML.

Mettre à jour la demande de ramassage – Éléments de la demande
Nom de l'élément Type Requis/Facultatif Description

pickup-request-update

Complexe

Requis

Élément XML de niveau supérieur de la structure de la réponse. Toutes les données fournies dans cette mise à jour écraseront les données initiales de la demande de service précédente pour créer une demande de ramassage.

Remarque : Vous ne pouvez pas changer les éléments « pickup-type », « pickup-location » et « payment-info ». Si vous devez changer ces éléments, annulez plutôt votre ramassage et créez-en un nouveau.

business-address-flag

Simple

Requis sous condition

{true}
La valeur « vrai » signifie que le ramassage est à effectuer à l'adresse commerciale précisée dans votre profil Postes Canada. (Afin de vérifier l'adresse que nous avons pour vous dans nos dossiers, vous pouvez ouvrir une session dans votre profil.)
Ne doit pas être proposée si l’element « alternate-address » est fourni.

alternate-address

Complexe

Requis sous condition

Adresse pour un ramassage en tierce partie.
Requise pour ramassages en tierce partie. Ne doit pas être proposée si l'indicateur « business-address-flag » est vrai.
Les ramassages sur demande à une adresse différente ne peuvent être payés que par carte de crédit.

company

Simple

Requis

(Chaîne de caractères – Jusqu'à 35caractères)
Raison sociale de l'organisation qui demande le ramassage.
Requise pour ramassages en tierce partie.(Indicateur d'adresse commerciale = faux). Ne doit pas être proposée si l'indicateur d'adresse commerciale = vrai.

address-line-1

Simple

Requis

(Chaîne de caractères – Jusqu'à 35caractères)
Adresse municipale du lieu de ramassage.
Requise pour ramassages en tierce partie.(Indicateur d'adresse commerciale = faux). Ne doit pas être proposée si l'indicateur d'adresse commerciale = vrai.

city

Simple

Requis

(Chaîne de caractères – Jusqu'à 35caractères)
Ville du lieu de ramassage.
Requise pour ramassages en tierce partie.(Indicateur d'adresse commerciale = faux). Ne doit pas être proposée si l'indicateur d'adresse commerciale = vrai.

province

Simple

Requis

(2caractères)
Province du lieu de ramassage.
Code de province standard à 2caractères pour les provinces au Canada.
Requise pour ramassages en tierce partie.(Indicateur d'adresse commerciale = faux). Ne doit pas être proposée si l'indicateur d'adresse commerciale = vrai.

postal-code

Simple

Requis

(6caractères alphanumériques)
Code postal du lieu de ramassage au format «A9A9A9».
Requise pour ramassages en tierce partie.(Indicateur d'adresse commerciale = faux). Ne doit pas être proposée si l'indicateur d'adresse commerciale = vrai.

contact-info

Complexe

Requis

Structure contenant la personne-ressource à qui adresser les questions ou les demandes.

contact-name

Simple

Requis

(Chaîne de caractères – Jusqu'à 45caractères)
Nom de la personne-ressource désignée pour le ramassage.

email

Simple

Requis

(Chaîne de caractères – Jusqu'à 60caractères)
Il doit s'agir d'une adresse électronique valide.
Le format est le suivant: (['_A-Za-z0-9\-\+]+)(\.['_A-Za-z0-9\-\+]+)*@([A-Za-z0-9\-]+)(\.[A-Za-z0-9\-]+)*(\.[A-Za-z]{2,5}).
Adresse électronique à laquelle envoyer les mises à jour de l'état de votre demande de ramassage.

contact-phone

Simple

Requis

(Chaîne de caractères – Jusqu'à 16caractères numériques)
Numéro de téléphone de la personne-ressource désignée pour le ramassage.
Format 999-999-9999

telephone-ext

Simple

Facultatif

(Jusqu'à 6caractères numériques)
Numéro du poste téléphonique.

receive-email-updates-flag

Simple

Facultatif

{vrai, faux}
La valeur «vrai» indique que vous voulez recevoir de mises à jour de l'état de votre demande.
La valeur par défaut est «faux».

location-details

Complexe

Requis

Structure contenant les caractéristiques du lieu physique où le ramassage doit avoir lieu.

five-ton-flag

Simple

Facultatif

{vrai, faux}
La valeur «vrai» indique qu'un camion de cinq tonnes est requis.
S'applique seulement aux demandes de ramassage sur demande.
La valeur par défaut est «faux».

loading-dock-flag

Simple

Facultatif

{vrai, faux}
La valeur «vrai» indique qu'il y a un quai de chargement au lieu de ramassage.
La valeur par défaut est «faux».

pickup-instructions

Simple

Requis

(Chaîne de caractères – Jusqu'à 132caractères)
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

Facultatif

Structure contenant les détails relatifs aux types d'articles à ramasser.
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

Facultatif

{vrai, faux}
Indique si des articles prioritaires peuvent être disponibles pour le ramassage.
La valeur par défaut est «faux».

returns-flag

Simple

Facultatif

{vrai, faux}
Indique si des articles renvoyés peuvent être disponibles pour le ramassage.
La valeur par défaut est «faux».

heavy-item-flag

Simple

Facultatif

{vrai, faux}
Indique si certains articles à ramasser peuvent peser plus de 23kg (50lb).
La valeur par défaut est «faux».

pickup-volume

Simple

Requis

(Chaîne de caractères – Jusqu'à 40caractères)
Pour un ramassage sur demande, il s'agit du nombre prévu d'articles à ramasser. Pour les ramassages à horaire fixe, il s'agit du nombre moyen prévu d'articles à ramasser.

pickup-times

Complexe

Requis

Structure contenant la date et la période à laquelle le ramassage doit avoir lieu.
Seulement une des structures fils doit être fournie («on-demand-pickup-time» ou «scheduled-pickup-times»).

on-demand-pickup-time

Complexe

Requis sous condition

Structure contenant les détails d'une demande de ramassage sur demande.
À remplir uniquement pour une demande de ramassage sur demande.

date

Simple

Requis

(Format de la date: AAAA-MM-JJ)
Date à laquelle vous souhaitez votre ramassage sur demande. La date doit se situer dans les cinq jours suivants, à moins que vous ne disposiez d'une convention du service de colis, auquel cas la limite peut être reportée à 30 jours.

 preferred-time

Simple

Requis

(Format de l'heure: HH:MM:SS)
Heure préférée du ramassage sur demande. La date doit se situer dans les cinq jours suivants, à moins que vous ne disposiez d'une convention du service de colis, auquel cas la limite peut être reportée à 30 jours.

closing-time

Simple

Requis

(Format de l'heure: HH:MM:SS)
Heure limite pour le ramassage sur demande. La date doit se situer dans les cinq jours suivants, à moins que vous ne disposiez d'une convention du service de colis, auquel cas la limite peut être reportée à 30 jours.

contract-id

Simple

Facultatif

(Jusqu'à 10caractères numériques)
Votre numéro de convention du service de colis, s'il y a lieu.

method-of-payment

Simple

Facultatif

Dans la version initiale, le système déterminera le mode de paiement :

  • Si vous ne disposez pas d'une convention du service de colis, des frais seront imputés sur la carte de crédit par défaut enregistrée dans votre profil en ligne (ou la demande sera rejetée si vous ne disposez pas d'une carte de crédit par défaut dans votre dossier).
  • Si vous disposez d'une convention du service de colis et que vous demandez un ramassage à votre adresse principale (sur demande), celui-ci sera facturé à votre compte (à moins que ce dernier ne soit bloqué, auquel cas, la carte de crédit par défaut enregistrée dans votre profil en ligne sera utilisée; ou bien la demande sera rejetée si vous ne disposez pas d'une carte de crédit par défaut dans votre dossier).
  • Si vous disposez d'une convention du service de colis, ou disposez de l'autorité d'utiliser une convention du service de colis, et que vous demandez un ramassage à une adresse différente (c.-à-d un ramassage en tierce partie), celui-ci sera imputé sur la carte de crédit par défaut enregistrée dans votre profil en ligne.

Demande – Diagramme XML

Mettre à jour la demande de ramassage – Structure de la demande XML
Mettre à jour la demande de ramassage – Structure de la demande XML

Détails de la réponse

Réponse – Éléments

Le service Mettre à jour la demande de ramassage n'affiche pas les éléments de données XML, mais le code de réponse HTTP « 204 » indiquera que l'opération a été effectuée avec succès. Un code de réponse HTTP de niveau 400 indique une erreur.

Réponses d'erreur possibles

En plus des codes d'erreur ci-dessous, vous pourriez recevoir un code d'erreur 404 si l'ID de la demande (request-id) n'est pas valide ou si la demande de ramassage a été annulée.

Code Description

11000

Ladresse est incomplète (manque le numéro dunité, par exemple).

11001

Le numéro de convention est invalide ou nexiste pas. Vous devez utiliser une convention pour colis.

11002

Il y a déjà une demande de ramassage en dedans dune heure de celle-ci.

11003

Le ramassage ne peut être effectué à la date requise (elle est dans le passé, invalide ou nest pas un jour ouvrable).

11005

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

11009

Le ramassage nest pas disponible au code postal spécifié.

11010

Vous devez avoir une carte de crédit en filière lorsque vous utilisez cette méthode de paiement.

11011

Vous devez détenir une convention de colis pour demander des ramassages à heure fixe.

11012

Numéro de demande introuvable. Veuillez vérifier.

11015

Lheure de ramassage préférée na pas été fournie. Veuillez corriger votre demande.

11016

Votre heure de fermeture ne peut être avant votre heure de ramassage préférée.

11111

Erreur de système. Veuillez essayer plus tard ou contactez la ligne dassistance de la SCP.

Voir aussi les sections Codes de statut HTTP et Messages d'erreur et stratégies d'atténuation.

Exemples

Exemple de demande XML selon le module REST – Mettre à jour la demande de ramassage

PUT https://ENV/enab/001102159/pickuprequest/0074698052
Accept  application/vnd.cpc.pickuprequest+xml
Authorization:Basic s7HD7gwsennesc==
<pickup-request-update>
  <contact-info>
    <contact-name>Jane Doe</contact-name>
    <email>john.doe@canadapost.ca</email>
    <contact-phone>800-555-1212</contact-phone>
    <receive-email-updates-flag>true</receive-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>
    <heavy-item-flag>true</heavy-item-flag>
  </items-characteristics>
  <pickup-volume>50</pickup-volume>
  <pickup-times>
    <on-demand-pickup-time>
      <date>2015-01-28</date>
      <preferred-time>15:00</preferred-time>
      <closing-time>17:00</closing-time>
    </on-demand-pickup-time>
  </pickup-times>
</pickup-request-update>

Exemple de réponse XML selon le module REST – Mettre à jour la demande de ramassage

Le service n'affiche pas les éléments XML (sauf si une erreur se produit; dans un tel cas, une réponse d'erreur standard est fournie).