Envois retournés
Obtenir le modèle générique pour les envois retournés – Module REST
Résumé
| Nom : | Obtenir le modèle générique pour les envois retournés |
|---|---|
| Raison pour utiliser le service : | Pour récupérer les liens et les autres renseignements liés à un modèle générique créé précédemment pour les envois retournés. Le service « Obtenir le modèle générique pour les envois retournés » n'est habituellement pas utilisé pendant les opérations normales, mais il pourrait être utile pour la récupération de données d'une communication ou d'une autre erreur. Nota : Tout modèle épuisé (p. ex. tous ses artefacts ont été récupérés) sera supprimé et ne sera pas accessible pour ce service. |
| 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 : | Les résultats du service « Obtenir le modèle générique pour les envois retournés » sont identiques à ceux du service « Créer un modèle générique pour les envois retournés ». Ils comprennent le nombre d'artefacts restants, les liens vers le modèle en question et le service « Récupérer le prochain artefact générique pour les envois retournés » correspondant. |
| Prochaine demande de service habituelle : | Récupérer le prochain artefact générique pour les envois retournés |
| Historique des versions : | Notes de mise à jour |
Obtenir le modèle générique pour les envois retournés – Résumé du service
Détails sur la demande
Demande – Structure pour le service « Obtenir 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 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 « Obtenir le modèle générique pour les envois retournés ».
Détails de la réponse
La réponse du service « Obtenir le modèle générique pour les envois retournés » est identique à celle du service « Créer un modèle générique pour les envois retournés ». Pour obtenir les éléments de la réponse et le diagramme XML, veuillez consulter la section Créer un modèle générique pour les envois retournés.
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 – Obtenir le modèle générique pour les envois retournés
l n'y a pas de XML lié à cette demande REST. Utilisez le lien fourni dans une demande préalable ou consultez les fichiers du projet soapUI pour obtenir des exemples de demande.
Exemple de réponse XML selon le module REST – Obtenir le modèle générique pour les envois retournés
<open-return-info>
<artifacts-remaining>10</artifacts-remaining>
<links>
<linkrel="self"href="https://ct.soa-gw.canadapost.ca/rs/0007023211/0007023211/openreturn/349641323786705649"media-type="application/vnd.cpc.openreturn+xml"></link>
<linkrel="details"href="https://ct.soa-gw.canadapost.ca/rs/0007023211/0007023211/openreturn/349641323786705649/details"media-type="application/vnd.cpc.openreturn+xml"></link>
<linkrel="nextArtifact"href="https://ct.soa-gw.canadapost.ca/rs/0007023211/0007023211/openreturn/349641323786705649/artifact"media-type="application/pdf"></link>
</links>
</open-return-info>
