Help Center subsuite - mahalo

| Services documentés d

| Services documentés dans cet article

__ ** Structures d'échanges : ** __

Structure d'échange (WSTarif)

Structure d'échange (WSService)

Structure d'échange (WSZoneCollection)

Structure d'échange (WSFamilleFraisPort)

Structure d'échange (WSZonesFamillePortCollection)

__ ** WS pour les tarifs d'abonnement : ** __

Liste de tous les tarifs d'abonnement (getTarifs ou getTarifsAbonnement )

Nombre total de tarifs d'abonnement (getNbTarifs ou get NbTarifsAbonnement)

Visualisation d'un tarif d'abonnement identifié par son code (getTarifByCodeTarif )

__ ** WS pour les tarifs d'articles libres : ** __

Liste de tous les tarifs d'articles libres (getTarifsArticleLibre )

Nombre total de tarifs d'articles libres (getNbTarifsArticleLibre )

Visualisation d'un tarif d'article libre identifié par son code (getTarifsArticleLibreByCodeTarif)

Nombre de tarif d'article libre identifié par son code (getNbTarifsArticleLibreByCodeTarif)

Liste des tarifs d'articles libres associés à un stock identifié par son code (getTarifsArticleLibreByCodeStock)

Nombre de tarifs d'articles libres associés à un stock identifié par son code (getNbTarifsArticleLibreByCodeStock)

Liste des tarifs d'articles libres associés à un stock identifié par sa référence unique (getTarifsArticleLibreByRefStock)

Nombre de tarifs d'articles libres associés à un stock identifié par sa référence unique (getNbTarifsArticleLibreByRefStock)

__ ** WS pour les formules : ** __

Liste de toutes les formules (getFormules )

Nombre total de tarifs formules (getNbFormules)

Visualisation d'une formule identifiée par son code (getFormuleByCodeTarif)

Visualisation d'une formule identifiée par sa référence unique (getFormuleByRefTarif)

Liste des formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par son code (getFormulesByCodeTarif)

Nombre de formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par son code (getNbFormulesByCodeTarif)

Liste des formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par sa référence unique (getFormulesByRefTarif)

Nombre de formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par sa référence unique (getNbFormulesByRefTarif)

__ ** WS pour les tarifs d'abonnement, les tarifs d'articles libres et les formules : ** __

Visualisation d'un tarif identifié par sa référence unique (getTarif)

__ ** WS Tarifs de réabonnement ( pour les tarifs d'abonnement et les formules ) : ** __

Liste des tarifs de réabonnement d'un tarif identifié par sa référence unique (getTarifsReabonnementByRefTarif)

Nombre de tarifs de réabonnement d'un tarif identifié par sa référence unique (getNbTarifsReabonnementByRefTarif) 

Liste des tarifs de réabonnement d'un tarif identifié par son code (getTarifsReabonnementByCodeTarif)

Nombre de tarifs de réabonnement d'un tarif identifié par son code (getNbTarifsReabonnementByCodeTarif)

Liste des tarifs de réabonnement d'un abonnement identifié par son numéro (getTarifsReabonnementByRefAbonnement)

Nombre de tarifs de réabonnement d'un abonnement identifié par son numéro (getNbTarifsReabonnementByRefAbonnement)

Tarif par défaut de réabonnement d'un tarif identifié par sa référence unique (getTarifsReabonnementDefautByRefTarif)

Tarif par défaut de réabonnement d'un tarif identifié par son code (getTarifReabonnementDefautByCodeTarif)

Tarif par défaut de réabonnement d'un abonnement identifié par son numéro (getTarifReabonnementDefautByRefAbonnement)

__ ** WS Association des tarifs et des origines d'abonnement et de réabonnement : ** __

Liste des tarifs ou des formules autorisés par le niveau (getTarifsByOrigine)

Nombre de tarifs ou de formules autorisés par le niveau (getNbTarifsByOrigine)

__ ** WS Services : ** __

Liste des services associés à un tarif (getServicesByRefTarif)

__ ** WS Frais de port : ** __

Visualisation d'une famille de frais de port identifié par sa référence unique (getFamilleFraisPort)

| Technologie

|| Protocole

La solution technique mise en place côté AboWeb repose sur des Web Services sans états.

Le protocole utilisé est SOAP 1.1. La couche de transport utilisée est HTTP 1.1.

L’intérêt principal de cette technologie est de pouvoir fournir un moyen d’échange indépendant de la plateforme et du langage de programmation utilisé. Les messages basés sur XML peuvent également être validés par une grammaire et des outils appropriés pour s’assurer que leur structure est correcte avant toute tentative de traitement des données.

|| Sécurité

Les Web Services implémentent la norme WS-Security 1.0 afin de réaliser les fonctions d’authentification des messages échangés.

L’authentification est réalisée à l’aide d’un login et d’un mot de passe crypté avec l’algorithme de hachage SHA-1 en base64 dans l’en-tête des messages. La balise utilisée, à savoir <UsernameToken> est conforme au standard.

Exemple d’en-tête (en rouge) :

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ges="http://www.gesmag.com/">

${color}[#ff0000](<soapenv:Header>

          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">

            <wsse:UsernameToken>

                  <wsse:Username>login</wsse:Username>

                  <wsse:Password>mdp</wsse:Password>

           </wsse:UsernameToken>

        </wsse:Security>

</soapenv:Header>

)

<soapenv:Body>

<ges:getTarif>

[…]

      </ges:getTarif>

   </soapenv:Body>

</soapenv:Envelope>

La confidentialité et l’intégrité des messages ne sont pas implémentées à ce jour.

|| Point d’accès

Les points d’accès sont contenus dans les fichiers WSDL générés sur les différents environnements.

Sur l’environnement de test, nous avons :

**Service :** gestion des tarifs

**URL :** http://preprod.aboweb.com/aboweb/TarifService?wsdl

Le compte utilisateur sur cet environnement sera communiqué par mail.

| Structures d’échange

Ce chapitre présente les structures de données complexes utilisées comme paramètres et valeurs de retour des Web Services. Pour chaque structure, les noms, types et descriptions des paramètres sont fournies. Les valeurs obligatoires en entrée sont indiquées. Les données en lecture seule sont gérées exclusivement dans AboWeb.

|| WSTarif

**${color}[#0080ff](<tarif>)**

${color}[#0080ff](<!--Type de tarif - Tarifs d’articles libres, tarifs d’abonnements, formules d’abonnements-->)

    <!--Integer - Type de tarif - Valeurs possibles : 0 pour les tarifs simple ou tarif d’article libre et 1 pour les tarifs formules -->

    **<typeTarif>1</typeTarif>**

    <!--Boolean - Indique s’il s’agit d’un tarif de formule -->

    **<formule>true</formule>**

    <!--Boolean - Indique s’il s’agit d’un tarif d’article libre -->

    **<estArticleLibre>false</estArticleLibre>**

    <!--Boolean - Indique s’il s’agit d’un tarif composant une formule -->

    **<estLigneFormule>false</estLigneFormule>**

${color}[#0080ff](<!--Informations générales pour les tarifs d’articles libres et les tarifs d’abonnements et les tarifs formules -->)

    <!--Integer - Référence de la société liée au tarif -->

    **<refSociete>2</refSociete>**

    <!--Integer - Référence du titre lié au tarif -->

    **<refTitre>3</refTitre>**

    <!--String - Code du titre lié au tarif -->

    **<codeTitre>SIKAH06</codeTitre>**

    <!--Integer - Identifiant du tarif -->

    **<refTarif>511</refTarif>**

    <!--String - Code du tarif -->

    **<codeTarif>AHGU63A38_F0607-1AN12N-ST</codeTarif>**

    <!--String - Famille du tarif -->

    **<familleTarif></familleTarif>**

    <!--String - Désignation du tarif -->

    **<desiTarif>Formule titres 06 et 07 1AN12N-ST</desiTarif>**

    <!--String - Libellé commercial du tarif -->

    **<libCommercial>Formule titres 06 et 07 1AN12N-ST</libCommercial>**

${color}[#0080ff](<!--Informations générales pour les tarifs d’articles libres et les tarifs d’abonnements -->)

    <!--Integer - Nombre de numéro à servir -->

    **<servir>0</servir>**

    <!--String - Origine du tarif-->

    **<origineAbo></origineAbo>**

    <!--String - Référence origine-->

    **<refOrigine></refOrigine/>**

    <!--String - Famille comptable-->**

    **<familleComptable></familleComptable>**

    <!--String - Code externe du tarif ( référence à un code provenant d’une autre application) -->

    **<codeTarifTransco></codeTarifTransco>**

${color}[#0080ff](<!--Informations générales pour les tarifs d’articles libres -->)

    <!--Float - Poids unitaire d’un article libre-->

    **<poidsUnitaire>0.0</poidsUnitaire>**

${color}[#0080ff](<!--Montants pour les tarifs d’articles libres et les tarifs d’abonnements -->)    

    <!--String - Code TVA permettant de calculer le montant TTC -->

    **<codeTva>B</codeTva>**

    <!--Float - Montant HT -->

    **<montantHt>0.83</montantHt>**

    <!--Float - Montant TTC -->

    **<montantTtc>0.85</montantTtc>**

    <!--Boolean - Indique si l’on effectue l’arrondi sur TTC -->

    **<arrondiSurTtc>false</arrondiSurTtc>**

${color}[#0080ff](<!--List<WSTarif> - Eléments de la formule pour les tarifs formules -->)

    **<detailsFormule>**

        <!-- Toutes les infos d'un tarif d’article libre ou d'un tarif d’abonnement -->

            **<typeTarif>0</typeTarif>**

            **<formule>false</formule>**

            **<estArticleLibre>false</estArticleLibre>**

            **<estLigneFormule>true</estLigneFormule>**

            **<refSociete>2</refSociete>**

            **<refTitre>3</refTitre>**

            **<codeTitre>SIKAH06</codeTitre>**

            **<refTarif>509</refTarif>**

            **<codeTarif>AHGU63A38_T07-1AN12N-ST</codeTarif>**

            <!-- etc ... -->

        <!--Info supplémentaire apparaissant uniquement si le tarif est un élément de formule -->

            <!--Boolean - Indique s’il s’agit du tarif maitre de la formule. -->

            **<maitre>true</maitre>**

            <!--Integer - ième élément de la formule. -->

            **<noLigne>1</noLigne>**

    **</detailsFormule>**

     **<detailsFormule>**

        <!-- Toutes les infos d'un tarif d’article libre ou d'un tarif d’abonnement -->

        <!--Info supplémentaire apparaissant uniquement si le tarif est un élément de formule -->

    **</detailsFormule>**

${color}[#0080ff](<!--Options -->)

    <!--Boolean - Indique s’il s’agit d’un tarif gratuit -->

    **<gratuit>false</gratuit>**

    <!--Boolean - Indique s’il s’agit d’un tarif d’abonnement à durée libre -->

    **<tarifADL>false</tarifADL>**

    <!--Boolean - Indique s’il s’agit d’un tarif d’abonnement à tacite reconduction -->

    **<tarifATC>false</tarifATC>**

    <!--Boolean - Indique s’il s’agit d’un tarif invisible -->

    **<invisible>false</invisible>**

    <!--<WSTarif> - Indique s’il s’agit d’un tarif gratuit -->

    **<refTarifReabo>**

        <!-- Toutes les infos d'un tarif d’abonnement ou d'un tarif formule -->

            **<typeTarif>1</typeTarif>**

            **<formule>true</formule>**

            **<estArticleLibre>false</estArticleLibre>**

            <!-- etc ... -->

    **</refTarifReabo>**

    <!--Boolean - Indique s’il s’agit du tarif par défaut du titre -->

    **<defaut>false</defaut>**

    <!--Boolean - Indique s’il s’agit d’un tarif relançable -->

    **<nePasRelancer>false</nePasRelancer>**

    <!--Boolean - Indique s’il l’on n’envoie pas d’email de bienvenue pour ce tarif -->

    **<pasdEmail>false</pasdEmail>**

${color}[#0080ff](<!--Options pour les tarifs formules -->)

    <!--Boolean - Indique si l’on peut utiliser l’option d’upgrade downgrade pour la formule -->

    **<upgradeDowngrade>false</upgradeDowngrade>**

    <!--Boolean - Indique s’il s’agit d’une formule au prorata -->

    **<formuleProrata>false</formuleProrata>**

${color}[#0080ff](<!--Options pour les règlements -->)

    <!--Boolean - Indique s’il s’agit d’un tarif en prélèvement -->

    **<tarifPreleve>false</tarifPreleve>**

    <!--Integer - Type de règlement - Valeurs possibles : 0 pour les paiements standard, 2 pour les prélèvements SEPA ou 6 pour les prélèvements CB -->

    **<typeReglement>1</typeReglement>**

    <!--Integer - Nombre de prélèvements prévus -->

    **<nbPrelevements>1</nbPrelevements>**

    <!--Integer - Fréquence des prélèvements - Valeurs possibles : 1 pour prélèvement tous les x mois ou 2 pour prélèvement tous les x numéros -->

    **<frequencePrelevementUnite>1</frequencePrelevementUnite>**

    <!--Integer - Correspond à x dans prélèvements tous les x mois ou prélèvements tous les x numéros) -->

    **<prelevementTousLes>1</prelevementTousLes>**

    <!--Integer - a priori ou a postériori - Utilisé avec les prélèvements tous les x numéros - Valeurs possibles : 1 pour a priori ou 2 pour a postériori -->

    **<debutPrelevement>1</debutPrelevement>**

${color}[#0080ff](<!--List<WSZoneCollection> - Comptes produit pour les tarifs d’articles libres et les tarifs d’abonnements -->)

    **<tarifZoneCollection>**

        <!--<WSZoneCollection> 1 compte produit -->

        **<codeZoneTva>1</codeZoneTva>**

        <!-- etc ... -->

    **</tarifZoneCollection>**

    **<tarifZoneCollection>**

        <!--<WSZoneCollection> 1 autre compte produit -->

    **</tarifZoneCollection>**

${color}[#0080ff](<!--Options de livraison -->)

    <!--Integer - Référence de la famille de frais de port -->

    **<refFamillePort></refFamillePort>**

${color}[#0080ff](<!--Options de livraison pour les tarifs d’articles libres -->)

    <!--Boolean - Indique si on gère le stock pour cet article -->

    **<gererStock>false</gererStock>**

    <!--Integer - Référence unique du stock -->

    **<refStock></refStock>**

    <!--String - Code du stock -->

    **<codeStock></codeStock>**

    <!--Integer - Quantité disponible avant validation de la livraison des articles -->

    **<stockDisponible></stockDisponible>**

${color}[#0080ff](<!--Options de livraison pour les tarifs formules -->)

    <!--Float - Seuil d’envoi des primes -->

    **<seuilEligibilitePrime>100</seuilEligibilitePrime>**

${color}[#0080ff](<!--List<WSService> - Liste des services du tarif -->)

     **<services>**

        <!--<WSService> 1 service -->

        **<codeService>SERV1</codeService>**

        <!-- etc ... -->

    **</services>**

    **<services>**

        <!--<WSService> 1 autre service -->

    **</services>**

**${color}[#0080ff](</tarif>)**    

|| WSService

**${color}[#0080ff](<services>)**

    <!--String - Code du service -->

    **<codeService>CODE SERVICE 1</codeService>**

    <!--String - Libellé du service -->

    **<libelleService>LIBELLE SERVICE 1</libelleService>**

    <!--Integer - Identifiant du service -->

    **<refService>1</refService>**

**${color}[#0080ff](</services>)**

|| WSZoneCollection

**${color}[#0080ff](<tarifZoneCollection>)**

    <!--Integer - Identifiant de la zone de Tva -->

    **<codeZoneTva>3</codeZoneTva>**

    <!--String - Compte -->

    **<compte>701112</compte>**

    <!--Boolean - Indique si TVA exonérée ou non -->

    **<exonere>true</exonere>**

    <!--String - Libellé de la zone TVA -->

    **<libZoneTva>TVA DOM</libZoneTva>**

    <!--Integer - Référence du tarif -->

    **<refTarif>649</refTarif>**

**${color}[#0080ff](</tarifZoneCollection>)**

|| WSFamilleFraisPort

**${color}[#0080ff](<familleFraisPort>)**

    ${color}[#0080ff](<!--Informations générales concernant la famille de frais de port -->)

        <!--String - Code de la famille de frais de port -->

        **<codeFamillePort>VAN-PAP</codeFamillePort>**

        <!--String - Compte de tva de la famille de frais de port -->

        **<codeTva>A</codeTva>**

        <!--String - Désignation en clair -->

        **<designation>Vente au numéro papier</designation>**

        <!--Integer - Mode de calcul - Valeurs possibles : 1 pour frais de port calculés par article, 2 pour frais de port calculés global ou 3 pour frais de port calculés sur le poids global-->

        **<modeDeCalcul>1</modeDeCalcul>**

        <!--Integer - Identifiant de la famille de frais de port -->

        **<refFamillePort>1</refFamillePort>**

    ${color}[#0080ff](<!--Définition des tranches la famille de frais de port -->)

        <!--Integer - Début de la tranche 1 de frais de port concerné -->

        **<debutTranche1>1</debutTranche1>**

        <!--Integer - Début de la tranche 2 de frais de port concerné -->

        **<debutTranche2>2</debutTranche2>**

        <!--etc ...  -->

        <!--Integer - Début de la tranche 6 de frais de port concerné -->

        **<debutTranche6>51</debutTranche6>**

        <!--Integer - Fin de la tranche 1 de frais de port concerné -->

        **<finTranche1>1</finTranche1>**

        <!--Integer - Fin de la tranche 2 de frais de port concerné -->

        **<finTranche2>5</finTranche2>**

        <!--etc ...  -->

        <!--Integer - Fin de la tranche 6 de frais de port concerné -->

        **<finTranche6>1000</finTranche6>**

    ${color}[#0080ff](<!--List<WSZonesFamillePortCollection> - Liste des montants pour chaque tranche et zone de famille de port -->)

    **<zonesFamillePortCollection>**

        <!--WSZonesFamillePortCollection - Montants pour chaque tranche de la zone DOM -->

        **<libelleCourtZone>Dom</libelleCourtZone>**

        **<montantTranche1>2.7</montantTranche1>**

        **<montantTranche2>2.7</montantTranche2>**

        **<montantTranche3>2.7</montantTranche3>**

        **<montantTranche4>2.7</montantTranche4>**

        **<montantTranche5>2.7</montantTranche5>**

        **<montantTranche6>2.7</montantTranche6>**

        **<montantTranche7>0.0</montantTranche7>**

        **<montantTranche8>0.0</montantTranche8>**

        **<noZoneFamillePort>2</noZoneFamillePort>**

        **<refZoneFamillePort>1</refZoneFamillePort>**

    **</zonesFamillePortCollection>**

    **<zonesFamillePortCollection>**

        <!--WSZonesFamillePortCollection - Montants pour chaque tranche de la zone UE et Suisse -->

        **<libelleCourtZone>UE et Suisse</libelleCourtZone>**

        <!--etc ...  -->

    **</zonesFamillePortCollection>**

    <!--etc ...  -->

**${color}[#0080ff](</familleFraisPort>)**

|| WSZonesFamillePortCollection

**${color}[#0080ff](<zonesFamillePortCollection>)**

    <!--String - Libelle de la zone de frais de port -->

    **<libelleCourtZone>Dom</libelleCourtZone>**

    <!--Integer - No de la zone de frais de port -->

    **<noZoneFamillePort>2</noZoneFamillePort>**

    <!--Integer - Identifiant de la zone de frais de port -->

    **<refZoneFamillePort>1</refZoneFamillePort>**

    <!--Float - Montant de la tranche 1 -->

    **<montantTranche1>2.7</montantTranche1>**

    <!--Float - Montant de la tranche 2 -->

    **<montantTranche2>2.7</montantTranche2>**

    <!--Float - Montant de la tranche 3 -->

    **<montantTranche3>2.7</montantTranche3>**

    <!--Float - Montant de la tranche 4 -->

    **<montantTranche4>2.7</montantTranche4>**

    <!--Float - Montant de la tranche 5 -->

    **<montantTranche5>2.7</montantTranche5>**

    <!--Float - Montant de la tranche 6 -->

    **<montantTranche6>2.7</montantTranche6>**

    <!--Float - Montant de la tranche 7 -->

    **<montantTranche7>0.0</montantTranche7>**

    <!--Float - Montant de la tranche 8 -->

    **<montantTranche8>0.0</montantTranche8>**

**${color}[#0080ff](</zonesFamillePortCollection>)**

| Services

Ce chapitre décrit l’ensemble des services nécessaires à la réalisation des cas d’utilisation. Pour chaque service, plusieurs informations sont fournies : le nom du service, la fonctionnalité réalisée, les paramètres en entrée, la valeur de retour et les cas d’erreurs (SOAPFault). Les structures de données complexes sont présentées dans le chapitre "Structures d'échange".

Les informations concernant l’éditeur sont déduites de l’utilisateur authentifié. On considère qu’il n’y a qu’une société.

Pour des raisons de performance, la taille des listes retournée est limitée à 50 objets. Par ailleurs, il faut éviter de réaliser des opérations d’ajout/suppression d’objets pendant le parcourt des listes à moins de savoir gérer le décalage à l’aide de l’attribut « offset ».

|| Liste de tous les tarifs d'abonnements (getTarifs ou getTarifsAbonnement )

_ WS pour les tarifs d'abonnement _

getTarifs et getTarifsAbonnement sont les mêmes WS. getTarifs a juste été dupliqué en getTarifsAbonnement car le nom est plus parlant.

Retourne une liste de 50 tarifs d'abonnement maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getTarifs>)**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getTarifs>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre total de tarifs d'abonnement (getNbTarifs ou get NbTarifsAbonnement)

_ WS pour les tarifs d'abonnement _

getNbTarifs ou get NbTarifsAbonnement sont les mêmes WS. getNbTarifs a juste été dupliqué en NbTarifsAbonnement car le nom est plus parlant.

Retourne le nombre de tarifs d’abonnements.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsAbonnement/>)**

  __ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Visualisation d'un tarif identifié par son code (getTarifByCodeTarif )

_ WS pour les tarifs d'abonnement _

Retourne un tarif d'abonnement à partir de son code.

__Trame :__

**${color}[#0080ff](<ges:getTarifByCodeTarif>)**

    ${color}[#0080ff](<!--Paramètres obligatoires en cas de multi-société, optionnel sinon -->)

               <!--Integer - Identifiant interne unique de la société -->

               **<refSociete>1</refSociete>**

    ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--Integer - Identifiant interne unique du titre -->

        **<refTitre>1</refTitre>**

        <!--String - Code du tarif -->

        **<codeTarif>AQGU24A22_ART_002</codeTarif>**

**${color}[#0080ff](</ges:getTarifByCodeTarif>)**

  __ Retour :__

Structure d’échange **List<WSTarif>**. 

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

202 : Donnée invalide - plusieurs sociétés possibles

|| Liste de tous les tarifs d'articles libres (getTarifsArticleLibre )

_ WS pour les tarifs d'articles libres _

Retourne une liste de 50 articles libres maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getTarifsArticleLibre>)**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getTarifsArticleLibre>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre total de tarifs d'articles libres (getNbTarifsArticleLibre)

_ WS pour les tarifs d'articles libres _

Retourne le nombre de tarifs d’articles libres.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsArticleLibre/>)**

  __ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Visualisation d'un tarif d'article libre identifié par son code (getTarifsArticleLibreByCodeTarif)

_ WS pour les tarifs d'articles libres _

Retourne un tarif d'articles libres à partir de son code.

__Trame :__

**${color}[#0080ff](<ges:getTarifsArticleLibreByCodeTarif>)**

    ${color}[#0080ff](<!--Paramètres obligatoires en cas de multi-société, optionnel sinon -->)

               <!--Integer - Identifiant interne unique de la société -->

               **<refSociete>1</refSociete>**

    ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--String - Code du tarif article libre -->

        **<codeTarif>AQGU24A22_ART_002</codeTarif>**

**${color}[#0080ff](</ges:getTarifsArticleLibreByCodeTarif>)**

  __ Retour :__

Structure d’échange **<WSTarif>**. 

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

202 : Donnée invalide - plusieurs sociétés possibles

|| Nombre de tarif d'article libre identifié par son code (getNbTarifsArticleLibreByCodeTarif)

_ WS pour les tarifs d'articles libres _

Retourne le nombre d'articles libres à partir de son code. 

Sans intérêt car il ne peut y en avoir qu'un seul.

|| Liste des tarifs d'articles libres associés à un stock identifié par son code (getTarifsArticleLibreByCodeStock)

_ WS pour les tarifs d'articles libres _

Retourne les tarifs d'articles libres associés à un stock identifié par son code.

Retourne une liste de 50 articles libres maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getTarifsArticleLibreByCodeStock>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

               <!--String - Code du stock. Il s'agit du codeStock de la structure d'échange WSTarif -->

               **<codeStock>ACGU40A33_ART_001</codeStock>**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getTarifsArticleLibreByCodeStock>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre de tarifs d'articles libres associés à un stock identifié par son code (getNbTarifsArticleLibreByCodeStock)

_ WS pour les tarifs d'articles libres _

Retourne le nombre de tarifs d'articles libres associés à un stock identifié par son code.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsArticleLibreByCodeStock>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

               <!--String - Code du stock. Il s'agit du codeStock de la structure d'échange WSTarif -->

               **<codeStock>ACGU40A33_ART_001</codeStock>**

**${color}[#0080ff](</ges:getNbTarifsArticleLibreByCodeStock>)**

__ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Liste des tarifs d'articles libres associés à un stock identifié par sa référence unique (getTarifsArticleLibreByRefStock)

_ WS pour les tarifs d'articles libres _

Retourne les tarifs d'articles libres associés à un stock identifié par sa référence unique.

Retourne une liste de 50 articles libres maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getTarifsArticleLibreByRefStock>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

               <!--String - Identifiant unique du stock. Il s'agit du refStock de la structure d'échange WSTarif -->

               **<refStock>2777</refStock>**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getTarifsArticleLibreByRefStock>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre de tarifs d'articles libres associés à un stock identifié par sa référence unique (getNbTarifsArticleLibreByRefStock)

_ WS pour les tarifs d'articles libres _

Retourne le nombre de tarifs d'articles libres associés à un stock identifié par sa référence unique.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsArticleLibreByRefStock>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

               <!--String - Identifiant unique du stock. Il s'agit du refStock de la structure d'échange WSTarif -->

               **<refStock>2777</refStock>**

**${color}[#0080ff](</ges:getNbTarifsArticleLibreByRefStock>)**

__ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Liste de toutes les formules (getFormules )

_ WS pour les tarifs formules _

Retourne une liste de 50 formules maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getFormules>)**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getFormules>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre total de tarifs formules (getNbFormules)

_ WS pour les tarifs formules _

Retourne le nombre de tarifs formules.

__Trame :__

**${color}[#0080ff](<ges:getNbFormules/>)**

  __ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Visualisation d'une formule identifiée par son code (getFormuleByCodeTarif)

_ WS pour les tarifs formules _

Retourne un tarif formule à partir de son code.

__Trame :__

**${color}[#0080ff](<ges:getFormuleByCodeTarif>)**

    ${color}[#0080ff](<!--Paramètres obligatoires en cas de multi-société, optionnel sinon -->)

               <!--Integer - Identifiant interne unique de la société -->

               **<refSociete>1</refSociete>**

    ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--String - Code du tarif formule -->

        **<codeTarif>ACGU40A33_FORM_002_A1A2121</codeTarif>**

**${color}[#0080ff](</ges:getFormuleByCodeTarif>)**

  __ Retour :__

Structure d’échange **<WSTarif>**. 

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

202 : Donnée invalide - plusieurs sociétés possibles

1054 : Le tarif trouvé n''est pas une formule.

|| Visualisation d'une formule identifiée par sa référence unique (getFormuleByRefTarif)

Retourne un tarif formule à partir de sa référence unique.

__Trame :__

**${color}[#0080ff](<ges:getFormuleByRefTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!--Integer – Référence interne du tarif formule – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>53</refTarif>**

**${color}[#0080ff](</ges:getFormuleByRefTarif>)**

  __ Retour :__

Structure d’échange **<WSTarif>**. 

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

202 : Donnée invalide - plusieurs sociétés possibles

1054 : Le tarif trouvé n''est pas une formule.

|| Liste des formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par son code (getFormulesByCodeTarif)

_ WS pour les tarifs formules _

Retourne une liste formules dont un des éléments correspond à un tarif d'abonnement ou à un tarif d'article libre identifié par son code.

Retourne une liste de 50 formules maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getFormulesByCodeTarif>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--String - Code du tarif d'abonnement ou du tarif d'article libre constituant un des élements des formules recherchées -->

        **<codeTarif>ACGU40A33_ART_A1A2121</codeTarif>**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getFormulesByCodeTarif>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre de formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par son code (getNbFormulesByCodeTarif)

_ WS pour les tarifs formules _

Retourne le nombre de formules dont un des éléments correspond à un tarif d'abonnement ou à un tarif d'article libre identifié par son code.

__Trame :__

**${color}[#0080ff](<ges:getNbFormulesByCodeTarif)>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--String - Code du tarif d'abonnement ou du tarif d'article libre constituant un des élements des formules recherchées -->

        **<codeTarif>ACGU40A33_ART_A1A2121</codeTarif>**

**${color}[#0080ff](</ges:getNbFormulesByCodeTarif)>)**

__ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Liste des formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par sa référence unique (getFormulesByRefTarif)

_ WS pour les tarifs formules _

Retourne une liste formules dont un des éléments correspond à un tarif d'abonnement ou à un tarif d'article libre identifié par sa référence unique.

Retourne une liste de 50 formules maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getFormulesByRefTarif>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--Integer – Référence interne du tarif d'abonnement ou du tarif d'article libre constituant un des élements des formules recherchées – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>53</refTarif>**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getFormulesByRefTarif>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre de formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par sa référence unique (getNbFormulesByRefTarif)

Retourne le nombre de formules dont un des éléments correspond à un tarif d'abonnement ou à un tarif d'article libre identifié par sa référence unique.

__Trame :__

**${color}[#0080ff](<ges:getNbFormulesByRefTarif>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--Integer – Référence interne du tarif d'abonnement ou du tarif d'article libre constituant un des élements des formules recherchées – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>53</refTarif>**

**${color}[#0080ff](</ges:getNbFormulesByRefTarif>)**

__ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Visualisation d'un tarif d'abonnement identifié par sa référence unique (getTarif)

_ WS pour les tarifs d'abonnement, les articles libres et les formules _

Retourne un tarif à partir de son identifiant.

__Trame :__

**${color}[#0080ff](<ges:getTarif>)**

    ${color}[#0080ff](<!--Paramètre obligatoire -->)

        <!--Integer - Identifiant interne unique du tarif -->

        **<refTarif>5917</refTarif>**

**${color}[#0080ff](</ges:getTarif>)**

  __ Retour :__

Structure d’échange **<WSTarif>**. 

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Liste des tarifs de réabonnement d'un tarif identifié par sa référence unique (getTarifsReabonnementByRefTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne une liste de 50 tarifs de réabonnement maximum, à partir d’un identifiant de tarif de base, ordonnée par « refTarif » croissante.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet Aboshop__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getTarifsReabonnementByRefTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!--Integer – Référence interne du tarif dont on veut récupérer les tarifs de réabonnement aboshop – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>53</refTarif>**

    ${color}[#0080ff](<!—Paramètre optionnel:-->)

        <!--Integer – Index du premier élément de la liste (commence par 0) – Ce paramètre ne sert pas car il ne peut pas y avoir plus de 50 tarifs de réabonnements pour un tarif -->

             **<offset>0</offset>**

**${color}[#0080ff](</ges:getTarifsReabonnementByRefTarif> )**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Nombre de tarifs de réabonnement d'un tarif identifié par sa référence unique (getNbTarifsReabonnementByRefTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne le nombre de tarifs de réabonnement pour un tarif donné, à partir d’un identifiant de tarif.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet Aboshop__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsReabonnementByRefTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!--Integer – Référence interne du tarif dont on veut récupérer les tarifs de réabonnement aboshop – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>53</refTarif>**

**${color}[#0080ff](</ges:getNbTarifsReabonnementByRefTarif> )**

__ Retour :__

Long – Nombre de tarifs de réabonnement

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Liste des tarifs de réabonnement d'un tarif identifié par son code (getTarifsReabonnementByCodeTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne une liste de 50 tarifs de réabonnement maximum, à partir d’un code de tarif de base, ordonnée par « refTarif » croissante.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet Aboshop__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getTarifsReabonnementByCodeTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!--String - Code du tarif  -->

             **<codeTarif>AQGU24A22_002</codeTarif>**

    ${color}[#0080ff](<!—Paramètre optionnel:-->)

        <!--Integer – Index du premier élément de la liste (commence par 0) – Ce paramètre ne sert pas car il ne peut pas y avoir plus de 50 tarifs de réabonnements pour un tarif -->

             **<offset>0</offset>**

**${color}[#0080ff](</ges:getTarifsReabonnementByCodeTarif> )**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Nombre de tarifs de réabonnement d'un tarif identifié par son code (getNbTarifsReabonnementByCodeTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne le nombre de tarifs de réabonnement pour un tarif donné, à partir d’un code de tarif de base.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet Aboshop__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsReabonnementByCodeTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

            <!--String - Code du tarif  -->

             **<codeTarif>AQGU24A22_002</codeTarif>**

**${color}[#0080ff](</ges:getNbTarifsReabonnementByCodeTarif> )**

__ Retour :__

Long – Nombre de tarifs de réabonnement

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Liste des tarifs de réabonnement d'un abonnement identifié par son numéro (getTarifsReabonnementByRefAbonnement)

_ WS pour les tarifs d'abonnement et les formules _

Retourne une liste de 50 tarifs de réabonnement maximum, à partir d’un identifiant d’abonnement, ordonnée par « refTarif » croissante.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet Aboshop__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getTarifsReabonnementByRefAbonnement>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!-- Integer – Référence unique interne de l’abonnement -->

             **<refAbonnement>15428</refAbonnement>**

    ${color}[#0080ff](<!—Paramètre optionnel:-->)

        <!--Integer – Index du premier élément de la liste (commence par 0) – Ce paramètre ne sert pas car il ne peut pas y avoir plus de 50 tarifs de réabonnements pour un tarif -->

             **<offset>0</offset>**

**${color}[#0080ff](</ges:getTarifsReabonnementByRefAbonnement> )**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Nombre de tarifs de réabonnement d'un abonnement identifié par son numéro (getNbTarifsReabonnementByRefAbonnement)

_ WS pour les tarifs d'abonnement et les formules _

Retourne le nombre de tarifs de réabonnement pour un abonnement donné, à partir d’un identifiant d’abonnement.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet général__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsReabonnementByRefAbonnement>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

            <!-- Integer – Référence unique interne de l’abonnement -->

             **<refAbonnement>15428</refAbonnement>**

**${color}[#0080ff](</ges:getNbTarifsReabonnementByRefAbonnement> )**

__ Retour :__

Long – Nombre de tarifs de réabonnement

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Tarif par défaut de réabonnement d'un tarif identifié par sa référence unique (getTarifsReabonnementDefautByRefTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne le tarif de réabonnement par défaut d’un tarif à partir de son identifiant.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet général__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getTarifReabonnementDefautByRefTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

            <!--Integer – Référence interne du tarif dont on veut récupérer les tarifs de réabonnement aboweb – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>5923</refTarif>**

**${color}[#0080ff](</ges:getTarifReabonnementDefautByRefTarif> )**

__ Retour :__

Structure d’échange **WSTarif**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Tarif par défaut de réabonnement d'un tarif identifié par son code (getTarifReabonnementDefautByCodeTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne le tarif de réabonnement par défaut d’un tarif à partir de son « code tarif ».

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet général__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getTarifReabonnementDefautByCodeTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!--String - Code du tarif  -->

             **<codeTarif>AQGU24A22_002</codeTarif>**

**${color}[#0080ff](</ges:getTarifReabonnementDefautByCodeTarif> )**

__ Retour :__

Structure d’échange **WSTarif**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Tarif par défaut de réabonnement d'un abonnement identifié par son numéro (getTarifReabonnementDefautByRefAbonnement)

_ WS pour les tarifs d'abonnement et les formules _

Retourne le tarif de réabonnement par défaut d’un abonnement à partir d’un identifiant d’abonnement.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet général__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getTarifReabonnementDefautByRefAbonnement>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!-- Integer – Référence unique interne de l’abonnement -->

             **<refAbonnement>15428</refAbonnement>**

**${color}[#0080ff](</ges:getTarifReabonnementDefautByRefAbonnement> )**

__ Retour :__

Structure d’échange **WSTarif**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Liste des tarifs ou des formules autorisés par le niveau (getTarifsByOrigine)

_ WS pour les tarifs d'abonnement et les formules _

Ce WS concerne le paramétrage optionnel d'association de tarifs avec des origines d'abonement et de réabonnements. Pour plus de détails sur cette option, voir la documentation https://mahalo-app.crisp.help/fr/article/choix-du-tarif-en-fonction-dune-origine-dabonnement-ou-de-reabonnement-optionnel-1e6h5gt/ 

getTarifsByOrigine retourne la liste des formules ou des tarifs autorisés par le niveau (canal, sous-canal, campagne, lot, segment, référence origine, origine de réabonnement) passé en paramètre.

Retourne une liste de 50 tarifs maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getTarifsByOrigine>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!-- Integer – Référence unique interne du niveau. Les valeurs possibles sont : -->

            <!-- 500 : Référence origine -->

            <!-- 501 : Lot -->

            <!-- 502 : Segment -->

            <!-- 503 : Campagne -->

            <!-- 504 : Sous-canal -->

            <!-- 505 : Canal -->

            <!-- 506 : Origine réabonnement -->

             **<codeNiveau>502</codeNiveau>**

        <!-- String – Un des libellé du niveau. Par exemple ici un des libellés correspondant à un segment car nous avons choisi le codeNivau 502 au dessus. -->

        **<libelle>Segment 2.2.2</libelle>**

        <!-- Integer – Indique que l'on recherche les tarifs simples ou les formules. Les valeurs possibles sont : -->

            <!-- 0 : Tarifs simples -->

            <!-- 1 : Formules -->

        **<typeTarif>1</typeTarif>**

    ${color}[#0080ff](<!—Paramètre optionnel:-->)

        <!--Integer – Référence interne du titre maitre -->

        **<refTitre>1</refTitre>**

        <!--Boolean - permet d'inclure ou d'exclure les articles libres (true : seulement, false : exclusion, null : tous) -->

        <!--A NE PAS RENSEIGNER car il n'existe pas jusqu'à présent d'associations possibles entre un AL et une origine d'abonnement ou de réabonnement -->

        _ **<article>null</article>** _

        <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>0</offset>**

**${color}[#0080ff](</ges:getTarifsByOrigine> )**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Nombre de tarifs ou de formules autorisés par le niveau (getNbTarifsByOrigine)

_ WS pour les tarifs d'abonnement et les formules _

Ce WS concerne le paramétrage optionnel d'association de tarifs avec des origines d'abonement et de réabonnements. Pour plus de détails sur cette option, voir la documentation https://mahalo-app.crisp.help/fr/article/choix-du-tarif-en-fonction-dune-origine-dabonnement-ou-de-reabonnement-optionnel-1e6h5gt/ 

getTarifsByOrigine retourne le nombre de formules ou des tarifs autorisés par le niveau (canal, sous-canal, campagne, lot, segment, référence origine, origine de réabonnement) passé en paramètre.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsByOrigine>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!-- Integer – Référence unique interne du niveau. Les valeurs possibles sont : -->

            <!-- 500 : Référence origine -->

            <!-- 501 : Lot -->

            <!-- 502 : Segment -->

            <!-- 503 : Campagne -->

            <!-- 504 : Sous-canal -->

            <!-- 505 : Canal -->

            <!-- 506 : Origine réabonnement -->

             **<codeNiveau>502</codeNiveau>**

        <!-- String – Un des libellé du niveau. Par exemple ici un des libellés correspondant à un segment car nous avons choisi le codeNivau 502 au dessus. -->

        **<libelle>Segment 2.2.2</libelle>**

        <!-- Integer – Indique que l'on recherche les tarifs simples ou les formules. Les valeurs possibles sont : -->

            <!-- 0 : Tarifs simples -->

            <!-- 1 : Formules -->

        **<typeTarif>1</typeTarif>**

    ${color}[#0080ff](<!—Paramètre optionnel:-->)

        <!--Integer – Référence interne du titre maitre -->

        **<refTitre>1</refTitre>**

        <!--Boolean - permet d'inclure ou d'exclure les articles libres (true : seulement, false : exclusion, null : tous) -->

        <!--A NE PAS RENSEIGNER car il n'existe pas jusqu'à présent d'associations possibles entre un AL et une origine d'abonnement ou de réabonnement -->

        _ **<article>null</article>** _

**${color}[#0080ff](</ges:getNbTarifsByOrigine> )**

__ Retour :__

Long – Nombre de tarifs

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Liste des services associés à un tarif (getServicesByRefTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne les services associés à un tarif donné, à partir d’un identifiant de tarif.

__Trame :__

**${color}[#0080ff](<ges:getServicesByRefTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!--Integer – Référence interne du tarif dont on veut récupérer les services – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>5923</refTarif>**

**${color}[#0080ff](</ges:getServicesByRefTarif> )**

__ Retour :__

Structure d’échange List<WSService>

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

1051    Tarif inexistant si le tarif en entrée n’existe pas

201    Champs obligatoire (codeTarif)

|| Visualisation d'une famille de frais de port identifié par sa référence unique (getFamilleFraisPort)

Retourne une famille de frais de port à partir de son identifiant.

Son identifiant correspond à refFamillePort de la structure d’échange WSFamilleFraisPort.

__Trame :__

**${color}[#0080ff](<ges:getFamilleFraisPort>)**

    ${color}[#0080ff](<!--Paramètre obligatoire -->)

        <!--Integer – Référence interne du tarif dont on veut récupérer les tarifs de réabonnement aboshop – son identifiant correspond à refFamillePort de la structure d’échange WSFamilleFraisPort -->

        **<reference>1</reference>**

**${color}[#0080ff](</ges:getFamilleFraisPort>)**

  __ Retour :__

Structure d’échange **WSFamilleFraisPort**. 

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

ans cet article

__ ** Structures d'échanges : ** __

Structure d'échange (WSTarif)

Structure d'échange (WSService)

Structure d'échange (WSZoneCollection)

Structure d'échange (WSFamilleFraisPort)

Structure d'échange (WSZonesFamillePortCollection)

__ ** WS pour les tarifs d'abonnement : ** __

Liste de tous les tarifs d'abonnement (getTarifs ou getTarifsAbonnement )

Nombre total de tarifs d'abonnement (getNbTarifs ou get NbTarifsAbonnement)

Visualisation d'un tarif d'abonnement identifié par son code (getTarifByCodeTarif )

__ ** WS pour les tarifs d'articles libres : ** __

Liste de tous les tarifs d'articles libres (getTarifsArticleLibre )

Nombre total de tarifs d'articles libres (getNbTarifsArticleLibre )

Visualisation d'un tarif d'article libre identifié par son code (getTarifsArticleLibreByCodeTarif)

Nombre de tarif d'article libre identifié par son code (getNbTarifsArticleLibreByCodeTarif)

Liste des tarifs d'articles libres associés à un stock identifié par son code (getTarifsArticleLibreByCodeStock)

Nombre de tarifs d'articles libres associés à un stock identifié par son code (getNbTarifsArticleLibreByCodeStock)

Liste des tarifs d'articles libres associés à un stock identifié par sa référence unique (getTarifsArticleLibreByRefStock)

Nombre de tarifs d'articles libres associés à un stock identifié par sa référence unique (getNbTarifsArticleLibreByRefStock)

__ ** WS pour les formules : ** __

Liste de toutes les formules (getFormules )

Nombre total de tarifs formules (getNbFormules)

Visualisation d'une formule identifiée par son code (getFormuleByCodeTarif)

Visualisation d'une formule identifiée par sa référence unique (getFormuleByRefTarif)

Liste des formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par son code (getFormulesByCodeTarif)

Nombre de formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par son code (getNbFormulesByCodeTarif)

Liste des formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par sa référence unique (getFormulesByRefTarif)

Nombre de formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par sa référence unique (getNbFormulesByRefTarif)

__ ** WS pour les tarifs d'abonnement, les tarifs d'articles libres et les formules : ** __

Visualisation d'un tarif identifié par sa référence unique (getTarif)

__ ** WS Tarifs de réabonnement ( pour les tarifs d'abonnement et les formules ) : ** __

Liste des tarifs de réabonnement d'un tarif identifié par sa référence unique (getTarifsReabonnementByRefTarif)

Nombre de tarifs de réabonnement d'un tarif identifié par sa référence unique (getNbTarifsReabonnementByRefTarif) 

Liste des tarifs de réabonnement d'un tarif identifié par son code (getTarifsReabonnementByCodeTarif)

Nombre de tarifs de réabonnement d'un tarif identifié par son code (getNbTarifsReabonnementByCodeTarif)

Liste des tarifs de réabonnement d'un abonnement identifié par son numéro (getTarifsReabonnementByRefAbonnement)

Nombre de tarifs de réabonnement d'un abonnement identifié par son numéro (getNbTarifsReabonnementByRefAbonnement)

Tarif par défaut de réabonnement d'un tarif identifié par sa référence unique (getTarifsReabonnementDefautByRefTarif)

Tarif par défaut de réabonnement d'un tarif identifié par son code (getTarifReabonnementDefautByCodeTarif)

Tarif par défaut de réabonnement d'un abonnement identifié par son numéro (getTarifReabonnementDefautByRefAbonnement)

__ ** WS Association des tarifs et des origines d'abonnement et de réabonnement : ** __

Liste des tarifs ou des formules autorisés par le niveau (getTarifsByOrigine)

Nombre de tarifs ou de formules autorisés par le niveau (getNbTarifsByOrigine)

__ ** WS Services : ** __

Liste des services associés à un tarif (getServicesByRefTarif)

__ ** WS Frais de port : ** __

Visualisation d'une famille de frais de port identifié par sa référence unique (getFamilleFraisPort)

| Technologie

|| Protocole

La solution technique mise en place côté AboWeb repose sur des Web Services sans états.

Le protocole utilisé est SOAP 1.1. La couche de transport utilisée est HTTP 1.1.

L’intérêt principal de cette technologie est de pouvoir fournir un moyen d’échange indépendant de la plateforme et du langage de programmation utilisé. Les messages basés sur XML peuvent également être validés par une grammaire et des outils appropriés pour s’assurer que leur structure est correcte avant toute tentative de traitement des données.

|| Sécurité

Les Web Services implémentent la norme WS-Security 1.0 afin de réaliser les fonctions d’authentification des messages échangés.

L’authentification est réalisée à l’aide d’un login et d’un mot de passe crypté avec l’algorithme de hachage SHA-1 en base64 dans l’en-tête des messages. La balise utilisée, à savoir <UsernameToken> est conforme au standard.

Exemple d’en-tête (en rouge) :

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ges="http://www.gesmag.com/">

${color}[#ff0000](<soapenv:Header>

          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">

            <wsse:UsernameToken>

                  <wsse:Username>login</wsse:Username>

                  <wsse:Password>mdp</wsse:Password>

           </wsse:UsernameToken>

        </wsse:Security>

</soapenv:Header>

)

<soapenv:Body>

<ges:getTarif>

[…]

      </ges:getTarif>

   </soapenv:Body>

</soapenv:Envelope>

La confidentialité et l’intégrité des messages ne sont pas implémentées à ce jour.

|| Point d’accès

Les points d’accès sont contenus dans les fichiers WSDL générés sur les différents environnements.

Sur l’environnement de test, nous avons :

**Service :** gestion des tarifs

**URL :** http://preprod.aboweb.com/aboweb/TarifService?wsdl

Le compte utilisateur sur cet environnement sera communiqué par mail.

| Structures d’échange

Ce chapitre présente les structures de données complexes utilisées comme paramètres et valeurs de retour des Web Services. Pour chaque structure, les noms, types et descriptions des paramètres sont fournies. Les valeurs obligatoires en entrée sont indiquées. Les données en lecture seule sont gérées exclusivement dans AboWeb.

|| WSTarif

**${color}[#0080ff](<tarif>)**

${color}[#0080ff](<!--Type de tarif - Tarifs d’articles libres, tarifs d’abonnements, formules d’abonnements-->)

    <!--Integer - Type de tarif - Valeurs possibles : 0 pour les tarifs simple ou tarif d’article libre et 1 pour les tarifs formules -->

    **<typeTarif>1</typeTarif>**

    <!--Boolean - Indique s’il s’agit d’un tarif de formule -->

    **<formule>true</formule>**

    <!--Boolean - Indique s’il s’agit d’un tarif d’article libre -->

    **<estArticleLibre>false</estArticleLibre>**

    <!--Boolean - Indique s’il s’agit d’un tarif composant une formule -->

    **<estLigneFormule>false</estLigneFormule>**

${color}[#0080ff](<!--Informations générales pour les tarifs d’articles libres et les tarifs d’abonnements et les tarifs formules -->)

    <!--Integer - Référence de la société liée au tarif -->

    **<refSociete>2</refSociete>**

    <!--Integer - Référence du titre lié au tarif -->

    **<refTitre>3</refTitre>**

    <!--String - Code du titre lié au tarif -->

    **<codeTitre>SIKAH06</codeTitre>**

    <!--Integer - Identifiant du tarif -->

    **<refTarif>511</refTarif>**

    <!--String - Code du tarif -->

    **<codeTarif>AHGU63A38_F0607-1AN12N-ST</codeTarif>**

    <!--String - Famille du tarif -->

    **<familleTarif></familleTarif>**

    <!--String - Désignation du tarif -->

    **<desiTarif>Formule titres 06 et 07 1AN12N-ST</desiTarif>**

    <!--String - Libellé commercial du tarif -->

    **<libCommercial>Formule titres 06 et 07 1AN12N-ST</libCommercial>**

${color}[#0080ff](<!--Informations générales pour les tarifs d’articles libres et les tarifs d’abonnements -->)

    <!--Integer - Nombre de numéro à servir -->

    **<servir>0</servir>**

    <!--String - Origine du tarif-->

    **<origineAbo></origineAbo>**

    <!--String - Référence origine-->

    **<refOrigine></refOrigine/>**

    <!--String - Famille comptable-->**

    **<familleComptable></familleComptable>**

    <!--String - Code externe du tarif ( référence à un code provenant d’une autre application) -->

    **<codeTarifTransco></codeTarifTransco>**

${color}[#0080ff](<!--Informations générales pour les tarifs d’articles libres -->)

    <!--Float - Poids unitaire d’un article libre-->

    **<poidsUnitaire>0.0</poidsUnitaire>**

${color}[#0080ff](<!--Montants pour les tarifs d’articles libres et les tarifs d’abonnements -->)    

    <!--String - Code TVA permettant de calculer le montant TTC -->

    **<codeTva>B</codeTva>**

    <!--Float - Montant HT -->

    **<montantHt>0.83</montantHt>**

    <!--Float - Montant TTC -->

    **<montantTtc>0.85</montantTtc>**

    <!--Boolean - Indique si l’on effectue l’arrondi sur TTC -->

    **<arrondiSurTtc>false</arrondiSurTtc>**

${color}[#0080ff](<!--List<WSTarif> - Eléments de la formule pour les tarifs formules -->)

    **<detailsFormule>**

        <!-- Toutes les infos d'un tarif d’article libre ou d'un tarif d’abonnement -->

            **<typeTarif>0</typeTarif>**

            **<formule>false</formule>**

            **<estArticleLibre>false</estArticleLibre>**

            **<estLigneFormule>true</estLigneFormule>**

            **<refSociete>2</refSociete>**

            **<refTitre>3</refTitre>**

            **<codeTitre>SIKAH06</codeTitre>**

            **<refTarif>509</refTarif>**

            **<codeTarif>AHGU63A38_T07-1AN12N-ST</codeTarif>**

            <!-- etc ... -->

        <!--Info supplémentaire apparaissant uniquement si le tarif est un élément de formule -->

            <!--Boolean - Indique s’il s’agit du tarif maitre de la formule. -->

            **<maitre>true</maitre>**

            <!--Integer - ième élément de la formule. -->

            **<noLigne>1</noLigne>**

    **</detailsFormule>**

     **<detailsFormule>**

        <!-- Toutes les infos d'un tarif d’article libre ou d'un tarif d’abonnement -->

        <!--Info supplémentaire apparaissant uniquement si le tarif est un élément de formule -->

    **</detailsFormule>**

${color}[#0080ff](<!--Options -->)

    <!--Boolean - Indique s’il s’agit d’un tarif gratuit -->

    **<gratuit>false</gratuit>**

    <!--Boolean - Indique s’il s’agit d’un tarif d’abonnement à durée libre -->

    **<tarifADL>false</tarifADL>**

    <!--Boolean - Indique s’il s’agit d’un tarif d’abonnement à tacite reconduction -->

    **<tarifATC>false</tarifATC>**

    <!--Boolean - Indique s’il s’agit d’un tarif invisible -->

    **<invisible>false</invisible>**

    <!--<WSTarif> - Indique s’il s’agit d’un tarif gratuit -->

    **<refTarifReabo>**

        <!-- Toutes les infos d'un tarif d’abonnement ou d'un tarif formule -->

            **<typeTarif>1</typeTarif>**

            **<formule>true</formule>**

            **<estArticleLibre>false</estArticleLibre>**

            <!-- etc ... -->

    **</refTarifReabo>**

    <!--Boolean - Indique s’il s’agit du tarif par défaut du titre -->

    **<defaut>false</defaut>**

    <!--Boolean - Indique s’il s’agit d’un tarif relançable -->

    **<nePasRelancer>false</nePasRelancer>**

    <!--Boolean - Indique s’il l’on n’envoie pas d’email de bienvenue pour ce tarif -->

    **<pasdEmail>false</pasdEmail>**

${color}[#0080ff](<!--Options pour les tarifs formules -->)

    <!--Boolean - Indique si l’on peut utiliser l’option d’upgrade downgrade pour la formule -->

    **<upgradeDowngrade>false</upgradeDowngrade>**

    <!--Boolean - Indique s’il s’agit d’une formule au prorata -->

    **<formuleProrata>false</formuleProrata>**

${color}[#0080ff](<!--Options pour les règlements -->)

    <!--Boolean - Indique s’il s’agit d’un tarif en prélèvement -->

    **<tarifPreleve>false</tarifPreleve>**

    <!--Integer - Type de règlement - Valeurs possibles : 0 pour les paiements standard, 2 pour les prélèvements SEPA ou 6 pour les prélèvements CB -->

    **<typeReglement>1</typeReglement>**

    <!--Integer - Nombre de prélèvements prévus -->

    **<nbPrelevements>1</nbPrelevements>**

    <!--Integer - Fréquence des prélèvements - Valeurs possibles : 1 pour prélèvement tous les x mois ou 2 pour prélèvement tous les x numéros -->

    **<frequencePrelevementUnite>1</frequencePrelevementUnite>**

    <!--Integer - Correspond à x dans prélèvements tous les x mois ou prélèvements tous les x numéros) -->

    **<prelevementTousLes>1</prelevementTousLes>**

    <!--Integer - a priori ou a postériori - Utilisé avec les prélèvements tous les x numéros - Valeurs possibles : 1 pour a priori ou 2 pour a postériori -->

    **<debutPrelevement>1</debutPrelevement>**

${color}[#0080ff](<!--List<WSZoneCollection> - Comptes produit pour les tarifs d’articles libres et les tarifs d’abonnements -->)

    **<tarifZoneCollection>**

        <!--<WSZoneCollection> 1 compte produit -->

        **<codeZoneTva>1</codeZoneTva>**

        <!-- etc ... -->

    **</tarifZoneCollection>**

    **<tarifZoneCollection>**

        <!--<WSZoneCollection> 1 autre compte produit -->

    **</tarifZoneCollection>**

${color}[#0080ff](<!--Options de livraison -->)

    <!--Integer - Référence de la famille de frais de port -->

    **<refFamillePort></refFamillePort>**

${color}[#0080ff](<!--Options de livraison pour les tarifs d’articles libres -->)

    <!--Boolean - Indique si on gère le stock pour cet article -->

    **<gererStock>false</gererStock>**

    <!--Integer - Référence unique du stock -->

    **<refStock></refStock>**

    <!--String - Code du stock -->

    **<codeStock></codeStock>**

    <!--Integer - Quantité disponible avant validation de la livraison des articles -->

    **<stockDisponible></stockDisponible>**

${color}[#0080ff](<!--Options de livraison pour les tarifs formules -->)

    <!--Float - Seuil d’envoi des primes -->

    **<seuilEligibilitePrime>100</seuilEligibilitePrime>**

${color}[#0080ff](<!--List<WSService> - Liste des services du tarif -->)

     **<services>**

        <!--<WSService> 1 service -->

        **<codeService>SERV1</codeService>**

        <!-- etc ... -->

    **</services>**

    **<services>**

        <!--<WSService> 1 autre service -->

    **</services>**

**${color}[#0080ff](</tarif>)**    

|| WSService


**${color}[#0080ff](<services>)**

    <!--String - Code du service -->

    **<codeService>CODE SERVICE 1</codeService>**

    <!--String - Libellé du service -->

    **<libelleService>LIBELLE SERVICE 1</libelleService>**

    <!--Integer - Identifiant du service -->

    **<refService>1</refService>**

**${color}[#0080ff](</services>)**

|| WSZoneCollection


**${color}[#0080ff](<tarifZoneCollection>)**

    <!--Integer - Identifiant de la zone de Tva -->

    **<codeZoneTva>3</codeZoneTva>**

    <!--String - Compte -->

    **<compte>701112</compte>**

    <!--Boolean - Indique si TVA exonérée ou non -->

    **<exonere>true</exonere>**

    <!--String - Libellé de la zone TVA -->

    **<libZoneTva>TVA DOM</libZoneTva>**

    <!--Integer - Référence du tarif -->

    **<refTarif>649</refTarif>**

**${color}[#0080ff](</tarifZoneCollection>)**

|| WSFamilleFraisPort


**${color}[#0080ff](<familleFraisPort>)**

    ${color}[#0080ff](<!--Informations générales concernant la famille de frais de port -->)

        <!--String - Code de la famille de frais de port -->

        **<codeFamillePort>VAN-PAP</codeFamillePort>**

        <!--String - Compte de tva de la famille de frais de port -->

        **<codeTva>A</codeTva>**

        <!--String - Désignation en clair -->

        **<designation>Vente au numéro papier</designation>**

        <!--Integer - Mode de calcul - Valeurs possibles : 1 pour frais de port calculés par article, 2 pour frais de port calculés global ou 3 pour frais de port calculés sur le poids global-->

        **<modeDeCalcul>1</modeDeCalcul>**

        <!--Integer - Identifiant de la famille de frais de port -->

        **<refFamillePort>1</refFamillePort>**

    ${color}[#0080ff](<!--Définition des tranches la famille de frais de port -->)

        <!--Integer - Début de la tranche 1 de frais de port concerné -->

        **<debutTranche1>1</debutTranche1>**

        <!--Integer - Début de la tranche 2 de frais de port concerné -->

        **<debutTranche2>2</debutTranche2>**

        <!--etc ...  -->

        <!--Integer - Début de la tranche 6 de frais de port concerné -->

        **<debutTranche6>51</debutTranche6>**

        <!--Integer - Fin de la tranche 1 de frais de port concerné -->

        **<finTranche1>1</finTranche1>**

        <!--Integer - Fin de la tranche 2 de frais de port concerné -->

        **<finTranche2>5</finTranche2>**

        <!--etc ...  -->

        <!--Integer - Fin de la tranche 6 de frais de port concerné -->

        **<finTranche6>1000</finTranche6>**

    ${color}[#0080ff](<!--List<WSZonesFamillePortCollection> - Liste des montants pour chaque tranche et zone de famille de port -->)

    **<zonesFamillePortCollection>**

        <!--WSZonesFamillePortCollection - Montants pour chaque tranche de la zone DOM -->

        **<libelleCourtZone>Dom</libelleCourtZone>**

        **<montantTranche1>2.7</montantTranche1>**

        **<montantTranche2>2.7</montantTranche2>**

        **<montantTranche3>2.7</montantTranche3>**

        **<montantTranche4>2.7</montantTranche4>**

        **<montantTranche5>2.7</montantTranche5>**

        **<montantTranche6>2.7</montantTranche6>**

        **<montantTranche7>0.0</montantTranche7>**

        **<montantTranche8>0.0</montantTranche8>**

        **<noZoneFamillePort>2</noZoneFamillePort>**

        **<refZoneFamillePort>1</refZoneFamillePort>**

    **</zonesFamillePortCollection>**

    **<zonesFamillePortCollection>**

        <!--WSZonesFamillePortCollection - Montants pour chaque tranche de la zone UE et Suisse -->

        **<libelleCourtZone>UE et Suisse</libelleCourtZone>**

        <!--etc ...  -->

    **</zonesFamillePortCollection>**

    <!--etc ...  -->

**${color}[#0080ff](</familleFraisPort>)**

|| WSZonesFamillePortCollection


**${color}[#0080ff](<zonesFamillePortCollection>)**

    <!--String - Libelle de la zone de frais de port -->

    **<libelleCourtZone>Dom</libelleCourtZone>**

    <!--Integer - No de la zone de frais de port -->

    **<noZoneFamillePort>2</noZoneFamillePort>**

    <!--Integer - Identifiant de la zone de frais de port -->

    **<refZoneFamillePort>1</refZoneFamillePort>**

    <!--Float - Montant de la tranche 1 -->

    **<montantTranche1>2.7</montantTranche1>**

    <!--Float - Montant de la tranche 2 -->

    **<montantTranche2>2.7</montantTranche2>**

    <!--Float - Montant de la tranche 3 -->

    **<montantTranche3>2.7</montantTranche3>**

    <!--Float - Montant de la tranche 4 -->

    **<montantTranche4>2.7</montantTranche4>**

    <!--Float - Montant de la tranche 5 -->

    **<montantTranche5>2.7</montantTranche5>**

    <!--Float - Montant de la tranche 6 -->

    **<montantTranche6>2.7</montantTranche6>**

    <!--Float - Montant de la tranche 7 -->

    **<montantTranche7>0.0</montantTranche7>**

    <!--Float - Montant de la tranche 8 -->

    **<montantTranche8>0.0</montantTranche8>**

**${color}[#0080ff](</zonesFamillePortCollection>)**

| Services

Ce chapitre décrit l’ensemble des services nécessaires à la réalisation des cas d’utilisation. Pour chaque service, plusieurs informations sont fournies : le nom du service, la fonctionnalité réalisée, les paramètres en entrée, la valeur de retour et les cas d’erreurs (SOAPFault). Les structures de données complexes sont présentées dans le chapitre "Structures d'échange".

Les informations concernant l’éditeur sont déduites de l’utilisateur authentifié. On considère qu’il n’y a qu’une société.

Pour des raisons de performance, la taille des listes retournée est limitée à 50 objets. Par ailleurs, il faut éviter de réaliser des opérations d’ajout/suppression d’objets pendant le parcourt des listes à moins de savoir gérer le décalage à l’aide de l’attribut « offset ».

|| Liste de tous les tarifs d'abonnements (getTarifs ou getTarifsAbonnement )

_ WS pour les tarifs d'abonnement _

getTarifs et getTarifsAbonnement sont les mêmes WS. getTarifs a juste été dupliqué en getTarifsAbonnement car le nom est plus parlant.

Retourne une liste de 50 tarifs d'abonnement maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getTarifs>)**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getTarifs>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre total de tarifs d'abonnement (getNbTarifs ou get NbTarifsAbonnement)

_ WS pour les tarifs d'abonnement _

getNbTarifs ou get NbTarifsAbonnement sont les mêmes WS. getNbTarifs a juste été dupliqué en NbTarifsAbonnement car le nom est plus parlant.

Retourne le nombre de tarifs d’abonnements.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsAbonnement/>)**

  __ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Visualisation d'un tarif identifié par son code (getTarifByCodeTarif )

_ WS pour les tarifs d'abonnement _

Retourne un tarif d'abonnement à partir de son code.

__Trame :__

**${color}[#0080ff](<ges:getTarifByCodeTarif>)**

    ${color}[#0080ff](<!--Paramètres obligatoires en cas de multi-société, optionnel sinon -->)

               <!--Integer - Identifiant interne unique de la société -->

               **<refSociete>1</refSociete>**

    ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--Integer - Identifiant interne unique du titre -->

        **<refTitre>1</refTitre>**

        <!--String - Code du tarif -->

        **<codeTarif>AQGU24A22_ART_002</codeTarif>**

**${color}[#0080ff](</ges:getTarifByCodeTarif>)**

  __ Retour :__

Structure d’échange **List<WSTarif>**. 

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

202 : Donnée invalide - plusieurs sociétés possibles

|| Liste de tous les tarifs d'articles libres (getTarifsArticleLibre )

_ WS pour les tarifs d'articles libres _

Retourne une liste de 50 articles libres maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getTarifsArticleLibre>)**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getTarifsArticleLibre>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre total de tarifs d'articles libres (getNbTarifsArticleLibre)

_ WS pour les tarifs d'articles libres _

Retourne le nombre de tarifs d’articles libres.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsArticleLibre/>)**

  __ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Visualisation d'un tarif d'article libre identifié par son code (getTarifsArticleLibreByCodeTarif)

_ WS pour les tarifs d'articles libres _

Retourne un tarif d'articles libres à partir de son code.

__Trame :__

**${color}[#0080ff](<ges:getTarifsArticleLibreByCodeTarif>)**

    ${color}[#0080ff](<!--Paramètres obligatoires en cas de multi-société, optionnel sinon -->)

               <!--Integer - Identifiant interne unique de la société -->

               **<refSociete>1</refSociete>**

    ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--String - Code du tarif article libre -->

        **<codeTarif>AQGU24A22_ART_002</codeTarif>**

**${color}[#0080ff](</ges:getTarifsArticleLibreByCodeTarif>)**

  __ Retour :__

Structure d’échange **<WSTarif>**. 

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

202 : Donnée invalide - plusieurs sociétés possibles

|| Nombre de tarif d'article libre identifié par son code (getNbTarifsArticleLibreByCodeTarif)

_ WS pour les tarifs d'articles libres _

Retourne le nombre d'articles libres à partir de son code. 

Sans intérêt car il ne peut y en avoir qu'un seul.

|| Liste des tarifs d'articles libres associés à un stock identifié par son code (getTarifsArticleLibreByCodeStock)

_ WS pour les tarifs d'articles libres _

Retourne les tarifs d'articles libres associés à un stock identifié par son code.

Retourne une liste de 50 articles libres maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getTarifsArticleLibreByCodeStock>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

               <!--String - Code du stock. Il s'agit du codeStock de la structure d'échange WSTarif -->

               **<codeStock>ACGU40A33_ART_001</codeStock>**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getTarifsArticleLibreByCodeStock>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre de tarifs d'articles libres associés à un stock identifié par son code (getNbTarifsArticleLibreByCodeStock)

_ WS pour les tarifs d'articles libres _

Retourne le nombre de tarifs d'articles libres associés à un stock identifié par son code.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsArticleLibreByCodeStock>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

               <!--String - Code du stock. Il s'agit du codeStock de la structure d'échange WSTarif -->

               **<codeStock>ACGU40A33_ART_001</codeStock>**

**${color}[#0080ff](</ges:getNbTarifsArticleLibreByCodeStock>)**

__ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Liste des tarifs d'articles libres associés à un stock identifié par sa référence unique (getTarifsArticleLibreByRefStock)

_ WS pour les tarifs d'articles libres _

Retourne les tarifs d'articles libres associés à un stock identifié par sa référence unique.

Retourne une liste de 50 articles libres maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getTarifsArticleLibreByRefStock>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

               <!--String - Identifiant unique du stock. Il s'agit du refStock de la structure d'échange WSTarif -->

               **<refStock>2777</refStock>**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getTarifsArticleLibreByRefStock>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre de tarifs d'articles libres associés à un stock identifié par sa référence unique (getNbTarifsArticleLibreByRefStock)

_ WS pour les tarifs d'articles libres _

Retourne le nombre de tarifs d'articles libres associés à un stock identifié par sa référence unique.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsArticleLibreByRefStock>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

               <!--String - Identifiant unique du stock. Il s'agit du refStock de la structure d'échange WSTarif -->

               **<refStock>2777</refStock>**

**${color}[#0080ff](</ges:getNbTarifsArticleLibreByRefStock>)**

__ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Liste de toutes les formules (getFormules )

_ WS pour les tarifs formules _

Retourne une liste de 50 formules maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getFormules>)**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getFormules>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre total de tarifs formules (getNbFormules)

_ WS pour les tarifs formules _

Retourne le nombre de tarifs formules.

__Trame :__

**${color}[#0080ff](<ges:getNbFormules/>)**

  __ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Visualisation d'une formule identifiée par son code (getFormuleByCodeTarif)

_ WS pour les tarifs formules _

Retourne un tarif formule à partir de son code.

__Trame :__

**${color}[#0080ff](<ges:getFormuleByCodeTarif>)**

    ${color}[#0080ff](<!--Paramètres obligatoires en cas de multi-société, optionnel sinon -->)

               <!--Integer - Identifiant interne unique de la société -->

               **<refSociete>1</refSociete>**

    ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--String - Code du tarif formule -->

        **<codeTarif>ACGU40A33_FORM_002_A1A2121</codeTarif>**

**${color}[#0080ff](</ges:getFormuleByCodeTarif>)**

  __ Retour :__

Structure d’échange **<WSTarif>**. 

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

202 : Donnée invalide - plusieurs sociétés possibles

1054 : Le tarif trouvé n''est pas une formule.

|| Visualisation d'une formule identifiée par sa référence unique (getFormuleByRefTarif)

Retourne un tarif formule à partir de sa référence unique.

__Trame :__

**${color}[#0080ff](<ges:getFormuleByRefTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!--Integer – Référence interne du tarif formule – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>53</refTarif>**

**${color}[#0080ff](</ges:getFormuleByRefTarif>)**

  __ Retour :__

Structure d’échange **<WSTarif>**. 

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

202 : Donnée invalide - plusieurs sociétés possibles

1054 : Le tarif trouvé n''est pas une formule.

|| Liste des formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par son code (getFormulesByCodeTarif)

_ WS pour les tarifs formules _

Retourne une liste formules dont un des éléments correspond à un tarif d'abonnement ou à un tarif d'article libre identifié par son code.

Retourne une liste de 50 formules maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getFormulesByCodeTarif>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--String - Code du tarif d'abonnement ou du tarif d'article libre constituant un des élements des formules recherchées -->

        **<codeTarif>ACGU40A33_ART_A1A2121</codeTarif>**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getFormulesByCodeTarif>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre de formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par son code (getNbFormulesByCodeTarif)

_ WS pour les tarifs formules _

Retourne le nombre de formules dont un des éléments correspond à un tarif d'abonnement ou à un tarif d'article libre identifié par son code.

__Trame :__

**${color}[#0080ff](<ges:getNbFormulesByCodeTarif)>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--String - Code du tarif d'abonnement ou du tarif d'article libre constituant un des élements des formules recherchées -->

        **<codeTarif>ACGU40A33_ART_A1A2121</codeTarif>**

**${color}[#0080ff](</ges:getNbFormulesByCodeTarif)>)**

__ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Liste des formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par sa référence unique (getFormulesByRefTarif)

_ WS pour les tarifs formules _

Retourne une liste formules dont un des éléments correspond à un tarif d'abonnement ou à un tarif d'article libre identifié par sa référence unique.

Retourne une liste de 50 formules maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getFormulesByRefTarif>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--Integer – Référence interne du tarif d'abonnement ou du tarif d'article libre constituant un des élements des formules recherchées – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>53</refTarif>**

         ${color}[#0080ff](<!—Paramètre optionnel:-->)

           <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>100</offset>**

**${color}[#0080ff](</ges:getFormulesByRefTarif>)**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Nombre de formules contenant un tarif d'abonnement ou un tarif d'article libre identifié par sa référence unique (getNbFormulesByRefTarif)

Retourne le nombre de formules dont un des éléments correspond à un tarif d'abonnement ou à un tarif d'article libre identifié par sa référence unique.

__Trame :__

**${color}[#0080ff](<ges:getNbFormulesByRefTarif>)**

     ${color}[#0080ff](<!--Paramètres obligatoires -->)

        <!--Integer – Référence interne du tarif d'abonnement ou du tarif d'article libre constituant un des élements des formules recherchées – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>53</refTarif>**

**${color}[#0080ff](</ges:getNbFormulesByRefTarif>)**

__ Retour :__

Long – Nombre de tarifs.

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Visualisation d'un tarif d'abonnement identifié par sa référence unique (getTarif)

_ WS pour les tarifs d'abonnement, les articles libres et les formules _

Retourne un tarif à partir de son identifiant.

__Trame :__

**${color}[#0080ff](<ges:getTarif>)**

    ${color}[#0080ff](<!--Paramètre obligatoire -->)

        <!--Integer - Identifiant interne unique du tarif -->

        **<refTarif>5917</refTarif>**

**${color}[#0080ff](</ges:getTarif>)**

  __ Retour :__

Structure d’échange **<WSTarif>**. 

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle

|| Liste des tarifs de réabonnement d'un tarif identifié par sa référence unique (getTarifsReabonnementByRefTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne une liste de 50 tarifs de réabonnement maximum, à partir d’un identifiant de tarif de base, ordonnée par « refTarif » croissante.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet Aboshop__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getTarifsReabonnementByRefTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!--Integer – Référence interne du tarif dont on veut récupérer les tarifs de réabonnement aboshop – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>53</refTarif>**

    ${color}[#0080ff](<!—Paramètre optionnel:-->)

        <!--Integer – Index du premier élément de la liste (commence par 0) – Ce paramètre ne sert pas car il ne peut pas y avoir plus de 50 tarifs de réabonnements pour un tarif -->

             **<offset>0</offset>**

**${color}[#0080ff](</ges:getTarifsReabonnementByRefTarif> )**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Nombre de tarifs de réabonnement d'un tarif identifié par sa référence unique (getNbTarifsReabonnementByRefTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne le nombre de tarifs de réabonnement pour un tarif donné, à partir d’un identifiant de tarif.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet Aboshop__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsReabonnementByRefTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!--Integer – Référence interne du tarif dont on veut récupérer les tarifs de réabonnement aboshop – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>53</refTarif>**

**${color}[#0080ff](</ges:getNbTarifsReabonnementByRefTarif> )**

__ Retour :__

Long – Nombre de tarifs de réabonnement

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Liste des tarifs de réabonnement d'un tarif identifié par son code (getTarifsReabonnementByCodeTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne une liste de 50 tarifs de réabonnement maximum, à partir d’un code de tarif de base, ordonnée par « refTarif » croissante.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet Aboshop__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getTarifsReabonnementByCodeTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!--String - Code du tarif  -->

             **<codeTarif>AQGU24A22_002</codeTarif>**

    ${color}[#0080ff](<!—Paramètre optionnel:-->)

        <!--Integer – Index du premier élément de la liste (commence par 0) – Ce paramètre ne sert pas car il ne peut pas y avoir plus de 50 tarifs de réabonnements pour un tarif -->

             **<offset>0</offset>**

**${color}[#0080ff](</ges:getTarifsReabonnementByCodeTarif> )**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Nombre de tarifs de réabonnement d'un tarif identifié par son code (getNbTarifsReabonnementByCodeTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne le nombre de tarifs de réabonnement pour un tarif donné, à partir d’un code de tarif de base.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet Aboshop__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsReabonnementByCodeTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

            <!--String - Code du tarif  -->

             **<codeTarif>AQGU24A22_002</codeTarif>**

**${color}[#0080ff](</ges:getNbTarifsReabonnementByCodeTarif> )**

__ Retour :__

Long – Nombre de tarifs de réabonnement

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Liste des tarifs de réabonnement d'un abonnement identifié par son numéro (getTarifsReabonnementByRefAbonnement)

_ WS pour les tarifs d'abonnement et les formules _

Retourne une liste de 50 tarifs de réabonnement maximum, à partir d’un identifiant d’abonnement, ordonnée par « refTarif » croissante.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet Aboshop__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getTarifsReabonnementByRefAbonnement>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!-- Integer – Référence unique interne de l’abonnement -->

             **<refAbonnement>15428</refAbonnement>**

    ${color}[#0080ff](<!—Paramètre optionnel:-->)

        <!--Integer – Index du premier élément de la liste (commence par 0) – Ce paramètre ne sert pas car il ne peut pas y avoir plus de 50 tarifs de réabonnements pour un tarif -->

             **<offset>0</offset>**

**${color}[#0080ff](</ges:getTarifsReabonnementByRefAbonnement> )**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Nombre de tarifs de réabonnement d'un abonnement identifié par son numéro (getNbTarifsReabonnementByRefAbonnement)

_ WS pour les tarifs d'abonnement et les formules _

Retourne le nombre de tarifs de réabonnement pour un abonnement donné, à partir d’un identifiant d’abonnement.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet général__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsReabonnementByRefAbonnement>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

            <!-- Integer – Référence unique interne de l’abonnement -->

             **<refAbonnement>15428</refAbonnement>**

**${color}[#0080ff](</ges:getNbTarifsReabonnementByRefAbonnement> )**

__ Retour :__

Long – Nombre de tarifs de réabonnement

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Tarif par défaut de réabonnement d'un tarif identifié par sa référence unique (getTarifsReabonnementDefautByRefTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne le tarif de réabonnement par défaut d’un tarif à partir de son identifiant.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet général__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getTarifReabonnementDefautByRefTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

            <!--Integer – Référence interne du tarif dont on veut récupérer les tarifs de réabonnement aboweb – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>5923</refTarif>**

**${color}[#0080ff](</ges:getTarifReabonnementDefautByRefTarif> )**

__ Retour :__

Structure d’échange **WSTarif**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Tarif par défaut de réabonnement d'un tarif identifié par son code (getTarifReabonnementDefautByCodeTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne le tarif de réabonnement par défaut d’un tarif à partir de son « code tarif ».

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet général__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getTarifReabonnementDefautByCodeTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!--String - Code du tarif  -->

             **<codeTarif>AQGU24A22_002</codeTarif>**

**${color}[#0080ff](</ges:getTarifReabonnementDefautByCodeTarif> )**

__ Retour :__

Structure d’échange **WSTarif**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Tarif par défaut de réabonnement d'un abonnement identifié par son numéro (getTarifReabonnementDefautByRefAbonnement)

_ WS pour les tarifs d'abonnement et les formules _

Retourne le tarif de réabonnement par défaut d’un abonnement à partir d’un identifiant d’abonnement.

Il s’agit ici de retourner les **tarifs de réabonnements paramétrés dans __l’onglet général__ d’un tarif**.

__Trame :__

**${color}[#0080ff](<ges:getTarifReabonnementDefautByRefAbonnement>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!-- Integer – Référence unique interne de l’abonnement -->

             **<refAbonnement>15428</refAbonnement>**

**${color}[#0080ff](</ges:getTarifReabonnementDefautByRefAbonnement> )**

__ Retour :__

Structure d’échange **WSTarif**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Liste des tarifs ou des formules autorisés par le niveau (getTarifsByOrigine)

_ WS pour les tarifs d'abonnement et les formules _

Ce WS concerne le paramétrage optionnel d'association de tarifs avec des origines d'abonement et de réabonnements. Pour plus de détails sur cette option, voir la documentation https://mahalo-app.crisp.help/fr/article/choix-du-tarif-en-fonction-dune-origine-dabonnement-ou-de-reabonnement-optionnel-1e6h5gt/ 

getTarifsByOrigine retourne la liste des formules ou des tarifs autorisés par le niveau (canal, sous-canal, campagne, lot, segment, référence origine, origine de réabonnement) passé en paramètre.

Retourne une liste de 50 tarifs maximum, ordonnée par « refTarif » croissante.

__Trame :__

**${color}[#0080ff](<ges:getTarifsByOrigine>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!-- Integer – Référence unique interne du niveau. Les valeurs possibles sont : -->

            <!-- 500 : Référence origine -->

            <!-- 501 : Lot -->

            <!-- 502 : Segment -->

            <!-- 503 : Campagne -->

            <!-- 504 : Sous-canal -->

            <!-- 505 : Canal -->

            <!-- 506 : Origine réabonnement -->

             **<codeNiveau>502</codeNiveau>**

        <!-- String – Un des libellé du niveau. Par exemple ici un des libellés correspondant à un segment car nous avons choisi le codeNivau 502 au dessus. -->

        **<libelle>Segment 2.2.2</libelle>**

        <!-- Integer – Indique que l'on recherche les tarifs simples ou les formules. Les valeurs possibles sont : -->

            <!-- 0 : Tarifs simples -->

            <!-- 1 : Formules -->

        **<typeTarif>1</typeTarif>**

    ${color}[#0080ff](<!—Paramètre optionnel:-->)

        <!--Integer – Référence interne du titre maitre -->

        **<refTitre>1</refTitre>**

        <!--Boolean - permet d'inclure ou d'exclure les articles libres (true : seulement, false : exclusion, null : tous) -->

        <!--A NE PAS RENSEIGNER car il n'existe pas jusqu'à présent d'associations possibles entre un AL et une origine d'abonnement ou de réabonnement -->

        _ **<article>null</article>** _

        <!--Integer – Index du premier élément de la liste (commence par 0) - Les tarifs sont ordonnés par refTarif croissante – Ce WS retourne 50 tarifs maximum – Par défaut on retourne les 50 premiers tarifs. Si l on souhaite les 50 suivants indiquer 50 dans offset, puis 100 pour les 50 suivants et ainsi de suite   -->

             **<offset>0</offset>**

**${color}[#0080ff](</ges:getTarifsByOrigine> )**

__ Retour :__

Structure d’échange **List<WSTarif>**

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Nombre de tarifs ou de formules autorisés par le niveau (getNbTarifsByOrigine)

_ WS pour les tarifs d'abonnement et les formules _

Ce WS concerne le paramétrage optionnel d'association de tarifs avec des origines d'abonement et de réabonnements. Pour plus de détails sur cette option, voir la documentation https://mahalo-app.crisp.help/fr/article/choix-du-tarif-en-fonction-dune-origine-dabonnement-ou-de-reabonnement-optionnel-1e6h5gt/ 

getTarifsByOrigine retourne le nombre de formules ou des tarifs autorisés par le niveau (canal, sous-canal, campagne, lot, segment, référence origine, origine de réabonnement) passé en paramètre.

__Trame :__

**${color}[#0080ff](<ges:getNbTarifsByOrigine>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!-- Integer – Référence unique interne du niveau. Les valeurs possibles sont : -->

            <!-- 500 : Référence origine -->

            <!-- 501 : Lot -->

            <!-- 502 : Segment -->

            <!-- 503 : Campagne -->

            <!-- 504 : Sous-canal -->

            <!-- 505 : Canal -->

            <!-- 506 : Origine réabonnement -->

             **<codeNiveau>502</codeNiveau>**

        <!-- String – Un des libellé du niveau. Par exemple ici un des libellés correspondant à un segment car nous avons choisi le codeNivau 502 au dessus. -->

        **<libelle>Segment 2.2.2</libelle>**

        <!-- Integer – Indique que l'on recherche les tarifs simples ou les formules. Les valeurs possibles sont : -->

            <!-- 0 : Tarifs simples -->

            <!-- 1 : Formules -->

        **<typeTarif>1</typeTarif>**

    ${color}[#0080ff](<!—Paramètre optionnel:-->)

        <!--Integer – Référence interne du titre maitre -->

        **<refTitre>1</refTitre>**

        <!--Boolean - permet d'inclure ou d'exclure les articles libres (true : seulement, false : exclusion, null : tous) -->

        <!--A NE PAS RENSEIGNER car il n'existe pas jusqu'à présent d'associations possibles entre un AL et une origine d'abonnement ou de réabonnement -->

        _ **<article>null</article>** _

**${color}[#0080ff](</ges:getNbTarifsByOrigine> )**

__ Retour :__

Long – Nombre de tarifs

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

|| Liste des services associés à un tarif (getServicesByRefTarif)

_ WS pour les tarifs d'abonnement et les formules _

Retourne les services associés à un tarif donné, à partir d’un identifiant de tarif.

__Trame :__

**${color}[#0080ff](<ges:getServicesByRefTarif>)**

    ${color}[#0080ff](<!-- Paramètre obligatoire :-->)

        <!--Integer – Référence interne du tarif dont on veut récupérer les services – la référence interne correspond à refTarif de la structure d’échange WSTarif -->

             **<refTarif>5923</refTarif>**

**${color}[#0080ff](</ges:getServicesByRefTarif> )**

__ Retour :__

Structure d’échange List<WSService>

 __ Erreurs :__

100    Erreur technique

101    Erreur d’authentification

200    Erreur fonctionnelle

1051    Tarif inexistant si le tarif en entrée n’existe pas

201    Champs obligatoire (codeTarif)

|| Visualisation d'une famille de frais de port identifié par sa référence unique (getFamilleFraisPort)

Retourne une famille de frais de port à partir de son identifiant.

Son identifiant correspond à refFamillePort de la structure d’échange WSFamilleFraisPort.

__Trame :__

**${color}[#0080ff](<ges:getFamilleFraisPort>)**

    ${color}[#0080ff](<!--Paramètre obligatoire -->)

        <!--Integer – Référence interne du tarif dont on veut récupérer les tarifs de réabonnement aboshop – son identifiant correspond à refFamillePort de la structure d’échange WSFamilleFraisPort -->

        **<reference>1</reference>**

**${color}[#0080ff](</ges:getFamilleFraisPort>)**

  __ Retour :__

Structure d’échange **WSFamilleFraisPort**. 

 __ Erreurs :__

100    : Erreur technique

101    : Erreur d’authentification

200 : Erreur fonctionnelle