Envois retournés
Supprimer le modèle générique pour les envois retournés – Module REST
Résumé
Nom : | Supprimer le modèle générique pour les envois retournés |
---|---|
Raison pour utiliser le service : | Pour supprimer un modèle générique existant pour les envois retournés |
Données d'entrée : | Aucune. Le point final « href » est un lien direct permettant de présenter une demande de service pour un modèle précis. |
Données de sortie : | Aucune |
Prochaine demande de service habituelle : | Créer un modèle générique pour les envois retournés |
Historique des versions : | Notes de mise à jour |
Détails sur la demande
Demande – Structure pour le service « Supprimer le modèle générique pour les envois retournés »
Point final
Il faut utiliser le lien associé à une demande de service précédente afin de créer un modèle générique pour les envois retournés ou d'obtenir le modèle générique pour les envois retournés lorsque la valeur de l'attribut « rel » est « self ».
En-têtes HTTP
Variable des en-têtes HTTP |
Valeur |
---|---|
Accept |
application/vnd.cpc.openreturn+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur) |
Content-Type |
application/vnd.cpc.openreturn+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur) |
Authorization |
Basic {Encodage en base64 du code d'usager : mot de passe} |
Accept-language |
en-CA or fr-CA |
Corps du message
Aucun
Demande – Éléments
Les données d'entrée XML ne sont pas nécessaires pour le service « Supprimer le modèle générique pour les envois retournés ».
Détails de la réponse
Le service « Supprimer le modèle générique pour les envois retournés » n'affiche pas les données XML.
Réponse – Réponses d'erreur possibles
Dans le cas d'une erreur d'application, une réponse d'erreur (code de statut HTTP de niveau 400) sera générée et le corps du message XML aura une structure du message d'erreur plutôt qu'une réponse de réussite. Pour obtenir de plus amples renseignements, veuillez consulter la section Codes de statut HTTP.
Les messages d'erreur possibles pour ce service sont les suivants :
Code de statut HTTP | Erreur d'application | Message |
---|---|---|
500 | S.O. | Les détails liés à l’erreur de validation du schéma sont fournis. |
412 | 9999 |
Exemples
Exemple de demande XML selon le module REST – Supprimer le modèle générique pour les envois retournés
DELETE https://XX/PROVIDED LINK
Accept:application/vnd.cpc.openreturn+xml
Authorization:Basic s7HD7gwsennesc==
Nota : Le lien vers le point final HTTP ne doit pas être intégré. Il est fourni à titre de donnée de sortie pour le service « Créer un modèle générique pour les envois retournés » ou « Obtenir le modèle générique pour les envois retournés ».
Exemple de réponse XML selon le module REST – Supprimer le modèle générique pour les envois retournés
Le service « Supprimer le modèle générique pour les envois retournés » 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).