Expédition avec convention
Obtenir les groupes – Module SOAP
Résumé
| Nom : | Obtenir les groupes |
|---|---|
| Raison pour utiliser le service : | Pour confirmer la liste complète de groupes admissibles à utiliser dans le cadre d'une demande de service « Transmettre les envois » |
| Données d'entrée : | Mailed-by; locale (optionnel) |
| Données de sortie : | Liste de numéros d'identification pour les groupes |
| Exemple d'erreur : | Client « Expédié au nom de » invalide |
| Prochaine demande de service habituelle : | Transmettre les envois ou Obtenir les envois |
| Historique des versions : |
Obtenir les groupes – Résumé du service
Détails sur la demande
| WSDL : | shipment.wsdl |
|---|---|
| Point final (Conception) : | https://ct.soa-gw.canadapost.ca/rs/soap/shipment/v8 |
| Point final (Production) : | https://soa-gw.canadapost.ca/rs/soap/shipment/v8 |
| Espace de nommage : | http://www.canadapost.ca/ws/soap/shipment/v8 |
| Opération : | GetGroups |
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 groupes – Éléments de la demande | |||
|---|---|---|---|
| Nom de l'élément | Type | Requis/Optionnel | Description |
get-groups-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 ». |
Demande – Diagramme XML
Obtenir les groupes – 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 groupes. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.
| Obtenir les groupes – Éléments de la réponse | ||
|---|---|---|
| Nom de l'élément | Type | Description |
get-groups-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. |
groups |
Complexe |
Structure XML contenant les résultats liés à l'exécution réussie du service en question. |
group-id |
Simple |
Occurrence (0 à N fois). Il s'agit du nom du groupe précisé par le système dans une demande de service précédente pour créer l'envoi. Les groupes peuvent ne contenir aucun envoi en raison d'une demande de service précédente pour transmettre les envois puisqu'ils peuvent persister jusqu'à 24 heures lorsqu'ils sont vides. Limites du rendement
Limites du système
|
Réponse – Diagramme XML
Obtenir les groupes – Structure de la réponse XM
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.
Exemples
Exemple de demande XML selon le module SOAP – Obtenir les groupes
<get-groups-request>
<mailed-by>1111111</mailed-by>
<locale>EN</locale>
</get-groups-request>
Exemple de réponse XML selon le module SOAP – Obtenir les groupes
<get-groups-response>
<groups>
<group-id>123456</group-id>
</groups>
</get-groups-response>
