Expédition avec convention
Obtenir les manifestes – Module SOAP
Résumé
| Nom : | Obtenir les manifestes |
|---|---|
| Raison pour utiliser le service : | Pour récupérer les manifestes associés à une plage de dates donnée |
| Données d'entrée : | Dates de « début » et de « fin » |
| Données de sortie : | Liste de manifestes |
| Exemple d'erreur : | Plage de dates invalide |
| Demande de service précédente habituelle : | Aucune |
| Prochaine demande de service habituelle : | Obtenir le manifeste, Obtenir les détails du manifeste ou Obtenir les envois |
| Historique des versions : |
Obtenir les manifestes – Résumé du service
Détails sur la demande
| WSDL : | manifest.wsdl |
|---|---|
| Point final (Conception) : | https://ct.soa-gw.canadapost.ca/rs/soap/manifest/v8 |
| Point final (Production) : | https://soa-gw.canadapost.ca/rs/soap/manifest/v8 |
| Espace de nommage : | http://www.canadapost.ca/ws/soap/manifest/v8 |
| Opération : | GetManifests |
Corps – SOAP
La présente section décrit les éléments XML d'entrée pour ce service. Pour obtenir la structure hiérarchique, consultez le diagramme XML.
| Obtenir les manifestes – Éléments de la demande | |||
|---|---|---|---|
| Nom de l'élément | Type | Requis/Optionnel | Description |
get-manifests-request |
complexe |
requis |
Élément XML de niveau supérieur de la structure de la réponse. |
mailed-by |
simple |
requis |
(1 à 10 caractères numériques) Il s'agit du numéro de client à 10 chiffres du client « Expédié par ». Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début. |
mobo |
simple |
optionnel |
(1 à 10 caractères numériques) Il s'agit du numéro de client à 10 chiffres du client « Expédié au nom de ». S'il manque cet élément, le numéro du client « Expédié par » s'affichera par défaut. Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début. |
locale |
simple |
optionnel |
Indique votre langue de préférence pour recevoir les messages d'erreur. EN = Anglais Si aucune valeur n'est fournie, la langue par défaut est « Anglais ». |
start |
simple |
requis |
(Chaîne de caractères – 10 lettres/chiffres sous le format Date de début de la plage de dates. |
end |
simple |
optionnel |
(Chaîne de caractères – 10 lettres/chiffres sous le format Date de fin de la plage de dates. Si la date de fin n'est pas précisée, la date actuelle s'affichera par défaut. |
Demande – Diagramme XML
Obtenir les manifestes – Structure de la demande XML
Détails de la réponse
Réponse – Éléments
Le tableau suivant décrit les éléments XML figurant dans la réponse à la demande d'obtention des manifestes. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.
| Obtenir les manifestes – Éléments de la réponse | ||
|---|---|---|
| Nom de l'élément | Type | Description |
get-manifests-response |
Complexe |
Il s'agit de l'élément XML de niveau supérieur de la structure de la réponse. Il affichera les résultats d'une exécution réussie ou la structure d'une erreur. |
manifests |
Complexe |
Structure XML contenant les résultats liés à l'exécution réussie du service en question. |
manifest-id |
Simple |
Occurrence (0 à N fois). Il s'agit d'un numéro d'identification représentant un manifeste précis. Il peut être utilisé pour les demandes de service futures « Obtenir le manifeste », « Obtenir les détails du manifeste » ou « Obtenir les envois ». |
Réponse – Diagramme XML
Obtenir les manifestes – Structure de la réponse XML
Réponse – Réponses d'erreur possibles
La réponse à des conditions d'erreur pour ce service en ligne respecte l'approche standard SOAP liée à la réponse d'erreur, laquelle est utilisée pour tous les services en ligne de Postes Canada. Pour obtenir de plus amples renseignements, consultez les Principes de base liés au module SOAP pour les services en ligne de Postes Canada.
Les messages d'erreur possibles pour ce service sont les suivants :
| Code | Message |
|---|---|
9105 |
Il manque au moins un paramètre. Veuillez ajouter les paramètres requis. |
9116 |
La date de « début » doit être antérieure à la date de « fin » (ou la même que celle-ci). |
Exemples
Exemple de demande XML selon le module SOAP – Obtenir les manifestes
<get-manifests-request>
<mailed-by>1111111</mailed-by>
<start>2011-11-10</start>
</get-manifests-request>
Exemple de réponse XML selon le module SOAP – Obtenir les manifestes
<get-manifests-response>
<manifests>
<manifest-id>347891314723499921</manifest-id>
</manifests>
</get-manifests-response>
