Imprimer

Envois retournés

Exemples de codes pour les envois retournés : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir les modèles génériques pour les envois retournés – Module REST

Résumé

Nom : Obtenir les modèles génériques pour les envois retourné
Raison pour utiliser le service :

Pour récupérer une liste de tous les modèles génériques actifs pour les envois retournés associés à votre application (en fonction des numéros de client « Expédié par » et « Expédié au nom de »)

Nota : Puisque votre application devrait assurer la gestion de la liste de modèles génériques actifs pour les envois retournés, une demande n'est pas habituellement présentée pour ce service pendant les opérations normales. Ce service est plutôt utilisé pour récupérer les données d'une communication ou d'une autre erreur.
Données d'entrée :

Il n'y a aucune donnée d'entrée XML pour ce service.
Toutefois, les numéros de client « Expédié par » et « Expédié au nom de » sont requis, et ils doivent être intégrés au point final « href » de ce service. Votre application doit effectuer cette tâche en utilisant ce service. Pour obtenir de plus amples renseignements, veuillez consulter la section Détails sur la demande.
Données de sortie : Liste de liens vers les modèles génériques actifs pour les envois retournés associés au client « Expédié par » ou « Expédié au nom de »
Prochaine demande de service habituelle : Service Obtenir le modèle générique pour les envois retournés permettant d'accéder à des modèles précis figurant sur la liste
Historique des versions : Notes de mise à jour
Obtenir les modèles génériques pour les envois retournés – Résumé du service

Obtenir les modèles génériques pour les envois retournés – Résumé du service

Détails sur la demande

Demande – Structure pour le service « Obtenir les modèles génériques pour les envois retournés »

Point final

GET https://XX/rs/{Client « Expédié par »}/{Client « Expédié au nom de »}/openreturn?from=YYYYMMDD&to=YYYYMMDD
Remplacez... Par...

XX (Conception)

ct.soa-gw.canadapost.ca

XX (Production)

soa-gw.canadapost.ca

{Client « Expédié par »}

Votre numéro de client

{Client « Expédié au nom de »}

Numéro du client « Expédié au nom de » (ou répétez votre numéro de client)

AAAAMMJJ

Dates de début et de fin (année, mois, jour)
Nota : S'il manque la date de début, tous les modèles génériques actifs pour les envois retournés créés avant la date de fin s'affichent. Si la date de fin est manquante, on suppose qu'il s'agit de la date actuelle. S'il manque les deux dates, tous les modèles génériques pour les envois retournés s'affichent.

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 les modèles génériques pour les envois retournés ».

Détails de la réponse

Réponse – Éléments

Le tableau suivant décrit les champs XML dans la réponse. Pour obtenir un aperçu détaillé de la hiérarchie de la réponse, consultez le diagramme XML.

Nom de l'élément Type Description

templates

Complexe

Il s'agit de l'élément XML de niveau supérieur pour la réponse.
Cette structure contient une série d'éléments propres aux envois retournés.

link

Complexe

La structure du lien contient un lien vers chacun des modèles actifs.
Exemple : <link
href="https://XX/rs/123456/24680/openreturn/3434343434
rel="template"
media-type="application/vnd.cpc.openreturn"/>

Chaque lien compte les trois attributs suivants :

  1. href. String. Il s'agit du point final pouvant être utilisé pour présenter une demande de service à l'aide du code HTTP GET pour récupérer de l'information.

  1. rel. String. . Il désigne l'objectif du lien et le type de renseignements qui y seront récupérés. Dans ce cas, tous les liens auront « rel="template" ».

  1. media-type. L'attribut lié au type de média désigne le format du fichier graphique (PDF).

Réponse – Diagramme XML

Le diagramme suivant présente la structure XML de la réponse pour le service « Obtenir les modèles génériques pour les envois retournés ».

Obtenir les modèles génériques pour les envois retournés – Structure de la réponse XML

Obtenir les modèles génériques pour les envois retournés – Structure de la réponse 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 – Obtenir les modèles génériques pour les envois retournés

GET https://XX/rs/12345678/3434343434343/openreturn/
from=20110623&to=20110719
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 ».

Exemple de réponse XML selon le module REST – Obtenir les modèles génériques pour les envois retournés

<templates>
<linkrel="template"href="https://ct.soa-gw.canadapost.ca/rs/0007023211/0007023211/openreturn/349641323786705649"media-type="application/vnd.cpc.openreturn+xml"></link>
</templates>