Ramassage
Annuler une demande de ramassage – Module SOAP
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 : |
Annuler une demande de ramassage – Résumé du service
Détails sur la demande
| WSDL : | shipment.wsdl |
|---|---|
| Point final (Conception) : | https://ct.soa-gw.postescanada.ca/enab/soap/pickuprequest |
| Point final (Production) : | https://soa-gw.postescanada.ca/enab/soap/pickuprequest |
| Espace de nommage : | http://www.postescanada.ca/ws/soap/serviceinfo |
| Opération : | CancelPickupRequest |
La présente section décrit les éléments XML d'entrée pour annuler une demande de ramassage. Pour obtenir la structure hiérarchique, consultez le diagramme XML.
| Annuler une demande de ramassage – Éléments de la demande | |||
|---|---|---|---|
| Nom de l'élément | Type | Requis/Facultatif | Description |
cancel-pickup-request-request |
Complexe |
Requis |
Élément XML de niveau supérieur de la structure de la réponse. |
customer-number |
Simple |
Requis |
(1 à 10 caractères numériques) |
locale |
Simple |
Facultatif |
Votre langue de préférence pour recevoir les messages d'erreur. |
platform-id |
Simple |
Facultatif |
Numéro de client de la plateforme. S'applique seulement aux plateformes de cybercommerce. |
request-id |
Simple |
Requis |
(35 caractères alphanumériques) |
Demande – Diagramme XML
Annuler une demande de ramassage – Structure de la demande XML
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.
| Annuler une demande de ramassage – Éléments de la réponse | ||
|---|---|---|
| Nom de l’élément | Type | Description |
cancel-pickup-request-response |
Complexe |
Structure XML globale. |
cancel-pickup-success |
Simple |
Vrai | Faux |
Réponse – Diagramme XML
Annuler une demande de ramassage – Structure de la réponse XML
Réponses d'erreur possibles
La réponse à des conditions d'erreur pour ce service en ligne respecte l'approche standard SOAP liée à la réponse d'erreur, laquelle est utilisée pour tous les services en ligne de Postes Canada. Pour obtenir plus de renseignements, consultez les Principes de base liés au module SOAP pour les services en ligne de Postes Canada.
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. |
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. |
Consultez également la section Messages d'erreur et stratégies d'atténuation.
Exemples
Exemple de demande XML selon le module SOAP – Annuler une demande de ramassage
<cancel-pickup-request-request>
<customer-number>1234567</customer-number>
<locale>EN</locale>
<request-id>0074698052</request-id>
</cancel-pickup-request-request>
Exemple de réponse XML selon le module SOAP – Annuler une demande de ramassage
<cancel-pickup-request-response>
<cancel-pickup-success>True</cancel-pickup-success>
</cancel-pickup-request-response>
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.
