Envois retournés
Obtenir les détails sur le modèle générique pour les envois retournés – Module REST
Résumé
| Nom : | Obtenir les détails sur le modèle générique pour les envois retournés |
|---|---|
| Raison pour utiliser le service : | Pour récupérer une représentation XML de toutes les données initiales associées à un modèle générique existant pour les envois retournés. Les détails liés à l'adresse de destination finale sont inclus. Une demande ne serait habituellement pas présentée pour ce service pendant les opérations normales puisque ce n'est pas nécessaire pour récupérer ou imprimer les étiquettes. Une représentation est fournie pour certaines situations, notamment la récupération de données d'une communication ou d'une autre erreur. |
| Données d'entrée : | Aucune. Le point final « href » est un lien direct permettant de présenter une demande de service propre à un modèle générique précis pour les envois retournés. |
| Données de sortie : | Détails saisis au moment de la création du modèle générique pour les envois retournés, notamment :
|
| Historique des versions : | Notes de mise à jour |
Obtenir les détails sur 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 les détails sur 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 « details ».
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 détails sur le modèle générique pour les envois retournés ».
Détails de la réponse
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.
| Obtenir les détails sur le modèle générique pour les envois retournés – Éléments de la réponse | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Nom de l'élément | Type | Description | ||||||||||
template-details |
Simple |
Niveau supérieur de la structure XML pour la réponse. |
||||||||||
max-number-of-artifacts |
Simple |
Indique le nombre maximal d'artefacts (étiquettes du Service de retour) que vous pouvez générer et récupérer à l'aide de ce modèle. Il doit s'agir d'une valeur numérique se situant entre « 1 » et |
||||||||||
artifacts-remaining |
Simple |
Indique le nombre actuel d'artefacts restants (étiquettes de retour) pouvant être générés et récupérés à l'aide de ce modèle. |
||||||||||
service-code |
Simple |
Le Service de retour convient seulement pour les envois retournés du régime intérieur.
|
||||||||||
receiver |
Complexe |
Cette structure contient des données sur la destination finale. Ces données correspondent à l'adresse du destinataire figurant sur l'étiquette. Les champs vides seront retirés pendant le formatage des adresses. |
||||||||||
name |
Simple |
Nom du destinataire. |
||||||||||
company |
Simple |
Entreprise du destinataire. |
||||||||||
domestic-address |
Complexe |
Cette structure contient les données d'adressage du destinataire final de l'envoi retourné. |
||||||||||
address-line-1 |
Simple |
Ligne d'adresse 1 du destinataire. |
||||||||||
address-line-2 |
Simple |
Ligne d'adresse 2 du destinataire. |
||||||||||
city |
Simple |
Ville du destinataire. |
||||||||||
prov |
Simple |
Province du destinataire. |
||||||||||
postal-code |
Simple |
Code postal du destinataire. |
||||||||||
print-preferences |
Complexe |
Cette structure contient les préférences d'impression pour les étiquettes, notamment le format de sortie. |
||||||||||
output-format |
Simple |
Les valeurs valides sont les suivantes : |
||||||||||
encoding |
Simple |
{PDF} |
||||||||||
show-packing-instructions |
Simple |
{Vrai ou faux} |
||||||||||
settlement-info |
Complexe |
Cette structure contient des éléments indiquant comment la livraison sera réglée (payée). |
||||||||||
contract-id |
Simple |
Requis pour utiliser le service de retour générique. Seuls les clients commerciaux de Postes Canada titulaires d'une convention établie en fonction du volume peuvent utiliser le service. |
||||||||||
Réponse – Diagramme XML
Le diagramme suivant présente la structure XML de la réponse pour le service « Obtenir les détails sur le 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 les détails sur le modèle générique pour les envois retournés
GET 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 – Obtenir les détails sur le modèle générique pour les envois retournés
<open-return-details>
<artifacts-remaining>10</artifacts-remaining>
<open-return>
<max-number-of-artifacts>10</max-number-of-artifacts>
<service-code>DOM.EP</service-code>
<receiver>
<domestic-address>
<address-line-1>23 jardin private</address-line-1>
<city>Ottawa</city>
<province>ON</province>
<postal-code>K1K4T3</postal-code>
</domestic-address>
</receiver>
<print-preferences>
<output-format>8.5x11</output-format>
<encoding>PDF</encoding>
<show-packing-instructions>false</show-packing-instructions>
</print-preferences>
<settlement-info>
<contract-id>0012345678</contract-id>
</settlement-info>
</open-return>
</open-return-details>
