Envois retournés

Récupérer le prochain artefact générique pour les envois retournés – Module REST

Résumé

Nom :	Récupérer le prochain artefact générique pour les envois retournés
Raison pour utiliser le service :	Pour récupérer le prochain artefact (étiquette) disponible associé au modèle générique 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 :	Document PDF ou ZPL II
Prochaine demande de service habituelle :	Répétition du procédé pour récupérer une autre étiquette
Historique des versions :	Notes de mise à jour

Récupérer le prochain artefact générique pour les envois retournés – Résumé du service

Détails sur la demande

Demande – Structure pour le service « Récupérer le prochain artefact 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 « nextArtifact ».

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accept	application/pdf ou appllication/zpl (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

Nota : Une demande de service est présentée avec POST pour cadrer avec l'approche REST en utilisant la valeur POST lorsque les résultats sont différents d'une demande à l'autre (p. ex. chaque fois qu'une demande est présentée, un différent artefact sera retourné).

Demande – Éléments

Les données d'entrée XML ne sont pas nécessaires pour le service « Récupérer le prochain artefact générique pour les envois
retournés ».

Détails de la réponse

Le service « Récupérer le prochain artefact générique pour les envois retournés » n'affiche pas les éléments de données XML. Il affiche plutôt les commandes ZPL II ou les données binaires du fichier PDF.

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 – Récupérer le prochain artefact générique pour les envois retournés

POST https://XX/PROVIDED LINK
Accept:application/pdf
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 « Obtenir les modèles génériques pour les envois retournés ».

Exemple de réponse XML selon le module REST – Récupérer le prochain artefact générique pour les envois retournés

Le service « Récupérer le prochain artefact générique pour les envois retournés » n'affiche pas les éléments de données XML. Il affiche une réponse HTTP des commandes de programmation ZPL II ou une représentation binaire du fichier PDF.