Documentation des services génériques

Détail d'un client

Version Standard
 Sommaire

1. Objet 3
2. Traitement 4
2.1. Préambules 4
2.1.1. Composition des en-têtes des flux de requête et de réponse 4
2.1.2. Détail de la structure du flux 4
2.2. getCustomerDetail – Détail d'un client 5
2.2.1. Composition du flux XML de requête 7
2.2.2. Composition du flux XML de réponse 8
 Version Standard Confidentiel Amplitude
Services génériques

1. Objet

Cette évolution a pour but de mettre en place des services génériques permettant à Amplitude d’échanger avec d’autres logiciels ; accessibles depuis
l’extérieur, ces services génériques constitueront un échange de flux XML avec le logiciel externe.

3/12
 Version Standard Confidentiel Amplitude
Services génériques

2. Traitement

2.1. Préambules

2.1.1. Composition des en-têtes des flux de requête et de réponse

Les flux XML de requête adopteront tous un en-tête commun de type "requestHeader" ; le détail de ces flux est décrit dans le document transverse
"Composition des en-têtes des flux de requête et de réponse".

Les flux XML de réponse adopteront tous un en-tête commun de type "responseHeader" et un élément de type "responseStatus" ; le détail de ces flux
est décrit dans le document transverse "Composition des en-têtes des flux de requête et de réponse".

2.1.2. Détail de la structure du flux

 Le niveau des champs du message, allant de + (1 plus) à ++++++++++ (10 plus) sont équivalents à des sous-titres hiérarchiques (de 1 à 10).
 Le format correspond à la caractéristique et à la longueur de l’élément traité. Une balise "Composite" correspond à une balise structurante, et l’attribut
"CHOICE" indique qu’un et un seul des éléments de la balise composite doit être renseigné.
 La colonne "Description" décrit le type ou l’élément de la balise.
 La colonne "Commentaires/Contrôles" contient des informations supplémentaires sur le type ou l’élément, ainsi que les contrôles et valeurs par défaut
appliqués à chacune des balises du flux de requête. Lorsque des valeurs par défaut sont précisées, elles doivent être paramétrées via le programme
dédié aux valeurs par défaut.
 La colonne "Multiple" indique qu’une balise peut apparaître plusieurs fois dans le flux.

4/12
 Version Standard Confidentiel Amplitude
Services génériques

2.2. getCustomerDetail – Détail d'un client

Programme Amplitude : cbwcliclid

Service générique : getCustomerDetail

Liste des tables Amplitude accédées :

 Table principale :
 bkcli : Table des clients
 Tables secondaires :
 bkadcli : Table des adresses des clients
 bkemacli : Table des adresses email des clients
 bkicli : Table des informations complémentaires des clients
 bkprocli : Table des profils clients
 bktelcli : Table des numéros de téléphone des clients
 bkgrp : Table des groupes de clients
 bksgrp : Table des sous-groupes de clients
 bkmetier : Table des métiers
 bksmetier : Table des sous-métiers

Liste des documentations des services associés :

 [SMG][DOC] Détail des attributs libres d'un client

 [SMG][DOC] Détail de l'adresse d'un client
 [SMG][DOC] Liste des numéros de téléphone d'un client
 [SMG][DOC] Liste des adresses email d'un client
 [SMG][DOC] Profil actif d'un client

5/12
Version Standard Confidentiel Amplitude
Services génériques

Ce service permet de restituer le détail d’un client ainsi que :

 le détail de ses adresses,

 le détail de ses attributs libres,
 le détail de son profil actif,
 la liste de ses numéros de téléphone,
 la liste de ses adresses email.

Remarque : pour plus d’informations sur ces services complémentaires, se référer aux documentations associées.

La description complète du flux de requête peut être trouvée dans la partie 2.2.1 du présent document.

La description complète du flux de réponse (pour la partie détail du client) peut être trouvée dans la partie 2.2.2 du présent document.

6/12
Version Standard Confidentiel Amplitude
Services génériques

2.2.1. Composition du flux XML de requête

Niveau Nom de la balise Format Obligatoire Multiple Description Commentaires/Contrôles

requestHeader Type "requestHeader" Oui Non En-tête du flux L'en-tête est décrit dans le
requête document transverse
"Composition des en-têtes des
flux de requête et de réponse".

getCustomerDetailRequ Composite Oui Non Requête détail d’un

est client

+ customerIdentifier Type "customerIdentifier" Oui Non Identifiant du Le type "customerIdentifier" est

client décrit dans la documentation
transverse "Documentation des
types transverses".

7/12
Version Standard Confidentiel Amplitude
Services génériques

2.2.2. Composition du flux XML de réponse

Niveau Nom de la balise Format Obligatoire Multiple Description Commentaires/Contrôles

responseHeader Type "responseHeader" Oui Non En-tête de réponse L’en-tête est décrit dans le
document transverse
"Composition des en-têtes des
flux de requête et de réponse".

responseStatus Type "responseStatus" Oui Non Statut de la Le statut est décrit dans le
réponse document transverse
"Composition des en-têtes des
flux de requête et de réponse".

getCustomerDetailResp Composite Oui Non Réponse détail

onse d’un client

+ customerCode CHARMAX15 Non Non Code client

+ customerType Type "customerType" Non Non Type de client Le type "customerType" est décrit
dans la documentation transverse
"Documentation des types
transverses".

+ language Type "language" Non Non Code langue Le type "language" est décrit dans
la documentation transverse
"Documentation des types
transverses".

8/12
Version Standard Confidentiel Amplitude
Services génériques

Niveau Nom de la balise Format Obligatoire Multiple Description Commentaires/Contrôles

+ titleCode Type "titleCode" Non Non Code intitulé Le type "titleCode" est décrit dans
la documentation transverse
"Documentation des types
transverses".

+ lastName CHARMAX36 Non Non Nom

+ nameToReturn CHARMAX67 Non Non Nom à restituer

+ abbreviation CHARMAX20 Non Non Sigle

+ freeFieldCode1 Type "customerFreeField1" Non Non Code champ libre 1 Le type "customerFreeField1" est
décrit dans la documentation des
types transverses au domaine
Référentiels.

+ freeFieldCode2 Type "customerFreeField2" Non Non Code champ libre 2 Le type "customerFreeField2" est
décrit dans la documentation des
types transverses au domaine
Référentiels.

+ freeFieldCode3 Type "customerFreeField3" Non Non Code champ libre 3 Le type "customerFreeField3" est
décrit dans la documentation des
types transverses au domaine
Référentiels.

9/12
Version Standard Confidentiel Amplitude
Services génériques

Niveau Nom de la balise Format Obligatoire Multiple Description Commentaires/Contrôles

+ externalIdentifier CHARMAX25 Non Non Numéro

d'immatriculation
externe

+ situation Type "customerSituation" Non Non Situation Le type "customerSituation" est

décrit dans la documentation des
types transverses au domaine
Référentiels.

+ fatca Type "customerFatca" Non Non Informations Le type "customerFatca" est

FATCA du client décrit dans la documentation des
types transverses au domaine
Référentiels.

+ specificInformation Type "customerSpecInfo" Non Non Informations Le type "customerSpecInfo" est

spécifiques décrit dans la documentation des
types transverses au domaine
Référentiels.

+ generalAttributes Type Non Non Attributs généraux Le type

"customerGeneralAttributes" "customerGeneralAttributes" est
décrit dans la documentation des
types transverses au domaine
Référentiels.

10/12
Version Standard Confidentiel Amplitude
Services génériques

Niveau Nom de la balise Format Obligatoire Multiple Description Commentaires/Contrôles

+ reportingAttributes Type Non Non Attributs reporting Le type

"customerReportingAttribute "customerReportingAttributes" est
s" décrit dans la documentation des
types transverses au domaine
Référentiels.

+ paymentMethods Type Non Non Moyens de Le type

"customerPaymentMethods" paiement "customerPaymentMethods" est
décrit dans la documentation des
types transverses au domaine
Référentiels.

+ additionalInformation Type Non Non Informations Le type

"customerAdditionalInformat additionnelles "customerAdditionalInformation"
ion" est décrit dans la documentation
des types transverses au domaine
Référentiels.

+ addressesDetail Type Non Non Adresses Le type

"getCustomerAddressDetailR "getCustomerAddressDetailRespo
esponse" nse" est décrit dans la
documentation "[SMG][DOC]
Détail de l’adresse d’un client".

11/12
Version Standard Confidentiel Amplitude
Services génériques

Niveau Nom de la balise Format Obligatoire Multiple Description Commentaires/Contrôles

+ phoneNumbers Type Non Non Liste des numéros Le type

"getCustomerPhoneNumberL de téléphone "getCustomerPhoneNumberListRe
istResponse" sponse" est décrit dans la
documentation "[SMG][DOC]
Liste des numéros de téléphone
d’un client".

+ emailAdresses Type Non Non Liste des adresses Le type

"getCustomerEmailAddressLi email "getCustomerEmailAddressListRes
stResponse" ponse" est décrit dans la
documentation "[SMG][DOC]
Liste des adresses email d’un
client".

+ freeAttributes Type Non Non Attributs libres Le type

"customerFreeAttributesDet "customerFreeAttributesDetail"
ail" est décrit dans la documentation
des types transverses au domaine
Référentiels.

+ activeProfile Type Non Non Profil actif du client Le type

"getCustomerActiveProfileRe "getCustomerActiveProfileRespons
sponse" e" est décrit dans la
documentation "[SMG][DOC]
Profil actif d’un client".

12/12