Expédition avec convention
Obtenir les groupes – Module REST
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 : | Numéros des clients « Expédié par » et « Expédié au nom de » |
Données de sortie : | Liste de numéros d'identification de groupe afin d'obtenir des liens pour les envois dans chaque groupe |
Exemple d'erreur : | 404 – Introuvable si le client « Expédié au nom de » est inexact |
Prochaine demande de service habituelle : | Transmettre les envois ou Obtenir les envois |
Historique des versions : |
Détails sur la demande
Structure de la demande pour obtenir les groupes
Point final
GET https://XX/rs/{Client « Expédié par »}/{Client « Expédié au nom de »}/group |
|
---|---|
Remplacez... | Par... |
XX (développement) |
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 »} |
le numéro de client « Expédié au nom de » ou indiquez de nouveau votre numéro de client |
En-têtes HTTP
Variable des en-têtes HTTP |
Valeur |
---|---|
Accept |
application/vnd.cpc.shipment-v8+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 ou fr-CA |
Corps du message
Aucun
Éléments de la demande
Les données d'entrée XML ne sont pas nécessaires pour le service Obtenir les groupes.
Détails de la réponse
Réponse – Éléments
Le tableau suivant décrit les données XML dans la réponse.
Pour obtenir un aperçu détaillé de la hiérarchie de la réponse, consultez la section Réponse – Diagramme XML.
Obtenir les groupes – Aperçu détaillé des éléments de réponse | ||
---|---|---|
Nom de l'élément | Type | Description |
groups |
Complexe |
Niveau supérieur de la structure de la réponse |
group |
Complexe |
Fait partie des groupes. Occurrence (0 à N fois) Cet élément représente un seul groupe d'expédition dans le domaine du client « Expédié au nom de ». |
group-id |
Simple |
(Chaîne de caractères – Jusqu'à 32 caractères) Fait partie du group. 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
|
link |
Complexe |
Fait partie du group. Pour obtenir une description des attributs des liens, consultez la section Points finaux fournis. Consultez la section Obtenir les envois pour obtenir de plus amples renseignements sur ce lien. L'ID du groupe est automatiquement fourni comme chaîne de requête pour chaque lien. |
Réponse – Diagramme XML
Le diagramme suivant présente la réponse de niveau supérieur pour le service Obtenir les groupes.
Nota: L'attribut « index » de l'élément du lien (dans le diagramme ci-dessus) n'est pas utilisé pour le service Obtenir les groupes.
Réponse – Réponses d'erreur possibles
Cette réponse respectera le format XML décrit dans la section Codes de statut HTTP.
Les messages d'erreur possibles pour ce service sont les suivants :
Code | Message |
---|---|
AA003 |
Le numéro de client figurant dans l'adresse URL ne correspond pas au numéro d'autorisation du service en ligne fourni dans votre demande. |
404 |
Introuvable (c'est-à-dire que le client « Expédié au nom de » précisé est inexact ou qu'il n'a pas de groupe) |
Exemples
Exemple de demande REST – Obtenir les groupes
Présentez une demande pour ce service en utilisant les numéros de client « Expédié par » et « Expédié au nom de ». Dans l'exemple suivant, le numéro de client est « 1234567 » et celui du client « Expédié au nom de » est « 123456789 ».
GET https://XX/rs/1234567/123456789/group
Accept:application/vnd.cpc.shipment-v8+xml
Authorization:Basic 23426ffw34%3fssdf==
Exemple de réponse XML – Obtenir les groupes
<groups>
<group>
<link rel="group" href="https://XX/rs/111111111/222222222/shipment?groupid=123456" media-type="application/vnd.cpc.shipment-v8+xml"></link>
<group-id>123456</group-id>
</group>
</groups>