Ramassage

Annuler une demande de ramassage – Module REST

Résumé

Nom :	Annuler une demande de ramassage
Raison pour utiliser le service :	Pour annuler une demande de ramassage existante Important : Pour modifier une demande de ramassage, assurez-vous d’utiliser le service Web Mettre à jour la demande de ramassage. Si vous annulez par erreur une demande de ramassage sur demande à votre adresse commerciale par défaut, vous ne pourrez pas créer une autre demande dans ce même intervalle de temps.
Données d'entrée :	ID de la demande
Données de sortie :	Indicateur signalant l'exécution réussie du service
Demande de service précédente habituelle :	Récupérer les demandes de ramassage
Historique des versions :	Notes de mise à jour

Annuler une demande de ramassage – Résumé du service

Détails sur la demande

Demande – Structure pour le service « Annuler une demande de ramassage »

Point final

Il faut utiliser le lien associé à une demande de service précédente pour 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)
Authorization	Basic {Encodage base64 du code d'usager:mot de passe}
Accept-language	en-CA ou fr-CA

Corps du message

La saisie de données XML n'est pas nécessaire pour le service « Annuler une demande de ramassage ».

Demande – Diagramme XML

Détails de la réponse

Réponse – Éléments

Le service « Annuler une 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

Vous recevrez un code d'erreur 404 si l'ID de la demande (request-id) n'est pas valide (p. ex. si une demande de ramassage a été annulée).

Code	Description
11004	Le ramassage ne peut être annulé car l’heure est déjà passée.

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

Exemples

Exemple de demande XML selon le module REST – Annuler une demande de ramassage

DELETE https://ENV/enab/001102159/pickuprequest/0074698052
Accept  application/vnd.cpc.pickuprequest+xml
Authorization:Basic s7HD7gwsennesc==

Exemple de réponse XML selon le module REST – Annuler une 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).

Environnement « Bac à sable » (développement) pour la réponse XML

La réponse est figée (statique) dans l'environnement de développement; par conséquent, vous recevrez toujours une réponse réussie si vous utilisez les numéros de demande 00110215 ou 0074698052.