Expédition avec convention
Obtenir l'information sur les clients « Expédié au nom de » – Module REST
Résumé
| Nom : | Obtenir l'information sur les clients « Expédié au nom de » |
|---|---|
| Raison pour utiliser le service : | Pour récupérer les détails liés aux payeurs autorisés, aux modes de paiement et aux autres renseignements sur les clients « Expédié au nom de » afin de déterminer le numéro de client pertinent |
| Données d'entrée : | Numéro de client « Expédié au nom de » pour lequel l'information est demandée |
| Données de sortie : | Numéros de convention, payeurs autorisés et modes de paiement permis |
| Exemples d'erreurs : | Numéro de client invalide |
| Demandes de service précédentes possibles : | |
| Prochaines demandes de service possibles : | |
| Historique des versions : |
Le service Obtenir l'information sur les clients « Expédié au nom de » fournit des renseignements sur un client « Expédié au nom de ».
Détails sur la demand
Structure de la demande pour obtenir l'information sur les clients « Expédié au nom de »
Point final
GET https://XX/rs/customer/{Client « Expédié par »}/behalfof/{Client « Expédié au nom de »} |
|
|---|---|
| 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.customer+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur) |
Authorization |
Basic {Encodage base64 du code d'usager:mot de passe} |
Accept-language |
en-CA ou fr-CA |
Corps du message
Aucun
Détails de la réponse
Réponse – Éléments
| Obtenir l'information sur les clients « Expédié au nom de » – REST – Examen détaillé des éléments de réponse | ||
|---|---|---|
| Nom de l'élément | Type | Description |
behalf-of-customer |
Complexe |
Structure d'ensemble pour la réponse en format XML |
customer-number |
Simple |
Il s'agit du numéro de client. Fait partie du behalf-of-customer. (10 caractères numériques) |
contracts |
Complexe |
Structure renfermant les conventions dont le client est titulaire et celles utilisées par le client « Expédié au nom de » précisé dans le premier type de demande qui sont toujours valides (c'est-à-dire qu'il n'y aura aucune convention invalide ou expirée dans cette liste). Fait partie de behalf-of-customer. |
contract-id |
Simple |
Numéro de contrat (également appelé numéro de convention) (10 caractères numériques) Fait partie de behalf-of-customer. |
authorized-payers |
Complexe |
Il s'agit de la structure contenant les payeurs autorisés et les modes de paiement pouvant être utilisés par chacun de ces payeurs. Ces payeurs peuvent servir de payeurs pour le numéro de client précisé dans cette réponse. Fait partie de behalf-of-customer. Nota : Si un payeur n'a aucun mode de paiement, il ne peut pas effectuer l'expédition en ce moment. |
payer |
Complexe |
Fait partie des authorized-payers. |
payer-number |
Simple |
Il s'agit du numéro de client du payeur. Fait partie de « payer ». (10 caractères numériques) |
methods-of-payment |
Complexe |
Structure contenant les modes de paiement pouvant être utilisés par ce payeur. Fait partie de payer. |
method-of-payment |
Simple |
Il peut contenir :
Fait partie des methods-of-payment. {Chaîne de 10 caractères} |
Diagramme de la réponse XML – REST
Messages d'erreur possibles
Aucun message d'erreur n'est prévu pour l'utilisation de ce lien fourni dans la demande pour obtenir l'information sur les clients. Si le lien est créé manuellement, l'erreur suivante pourrait s'afficher.
| Code | Message |
|---|---|
9152 |
Le numéro du client fourni n'a pas le bon format. |
Exemples
Exemple de réponse XML
<contracts>
<contract-id>12345679</contract-id>
<authorized-payers>
<methods-of-payment>
<method-of-payment>creditCard</method-of-payment>
