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 : |
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 HTTPVariable 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 |
<?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} |
alternate-address |
Complexe |
Requis sous condition |
Adresse pour un ramassage en tierce partie. |
company |
Simple |
Requis |
(Chaîne de caractères – Jusqu'à 35caractères) |
address-line-1 |
Simple |
Requis |
(Chaîne de caractères – Jusqu'à 35caractères) |
city |
Simple |
Requis |
(Chaîne de caractères – Jusqu'à 35caractères) |
province |
Simple |
Requis |
(2caractères) |
postal-code |
Simple |
Requis |
(6caractères alphanumériques) |
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) |
Simple |
Requis |
(Chaîne de caractères – Jusqu'à 60caractères) |
|
contact-phone |
Simple |
Requis |
(Chaîne de caractères – Jusqu'à 16caractères numériques) |
telephone-ext |
Simple |
Facultatif |
(Jusqu'à 6caractères numériques) |
receive-email-updates-flag |
Simple |
Facultatif |
{vrai, 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} |
loading-dock-flag |
Simple |
Facultatif |
{vrai, faux} |
pickup-instructions |
Simple |
Requis |
(Chaîne de caractères – Jusqu'à 132caractères) |
items-characteristics |
Complexe |
Facultatif |
Structure contenant les détails relatifs aux types d'articles à ramasser. |
priority-flag |
Simple |
Facultatif |
{vrai, faux} |
returns-flag |
Simple |
Facultatif |
{vrai, faux} |
heavy-item-flag |
Simple |
Facultatif |
{vrai, faux} |
pickup-volume |
Simple |
Requis |
(Chaîne de caractères – Jusqu'à 40caractères) |
pickup-times |
Complexe |
Requis |
Structure contenant la date et la période à laquelle le ramassage doit avoir lieu. |
on-demand-pickup-time |
Complexe |
Requis sous condition |
Structure contenant les détails d'une demande de ramassage sur demande. |
date |
Simple |
Requis |
(Format de la date: AAAA-MM-JJ) |
preferred-time |
Simple |
Requis |
(Format de l'heure: HH:MM:SS) |
closing-time |
Simple |
Requis |
(Format de l'heure: HH:MM:SS) |
contract-id |
Simple |
Facultatif |
(Jusqu'à 10caractères numériques) |
method-of-payment |
Simple |
Facultatif |
Dans la version initiale, le système déterminera le mode de paiement :
|
Demande – Diagramme 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).