Intégration et interrogation contrat

L'action pour l’interrogation ou l’intégration d’un contrat : Integration_contrat

Balise de paramètres (parameters)

Niveau

Contenu

Obligatoire

Remarques

dos

1

Dossier achat-vente

NON

Par défaut selon utilisateur

actiontyp

1

Type d’action attendue:

“GET” pour interroger
“INSERT” pour créer
“UPDATE” pour modifier

OUI

A FINIR, INFOS DE LA PAGE R&D

...

{“thirdparty”:”C0000001”,”Contractnumber”:testref”,”contractcod”:LOC”,”ContratFam”:ABOREVUE”,”GENERCALPREV”:2”}

...

2

...

Liste des champs avec leur nom de champ et la valeur

...

OUI

...

si GENERCALPREV = 2 pour générer le calendrier

sinon 1.

...

EQUIPTB : [ { “MATERIAL“: { “CODEMATERIAL“:”Q0005”}}]

...

2

...

CEACONTRAT

...

NON

...

pour rattacher les matériels avec le contrat

Le cas GET pour interroger

Balise du corps (data)	Niveau	Contenu	Obligatoire	Remarques
contract	2	Liste des champs avec leur nom de champ et la valeurpos	OUI
dealCONTRACTNUMBER	3	code affaire	NON	Code affaire à interrogerRéférence du contrat	OUI

Le cas INSERT pour créée

Balise du corps (data)	Niveau	Contenu	Obligatoire	Remarques
dealcontract	2	Liste des champs avec leur nom de champ et la valeurpos	OUI	Table CEACONTRAT
dealCONTRACTNUMBER	3	code affaire	NON	si pas renseigné le code affaire sera incrémenté automatiquement	descriptionRéférence de contrat	OUI
THIRDPARTY	3libellé	affaireCode client	OUI
CONTRACTCODE	dealsteptype	3	Etat Modèle de l’affairecontrat	OUI	(opportunity/deal/model) par défaut = opportunity
dealstep	3	étape d’affaire	OUI
thirdpartyclient	3	code client si le type de tiers est client	OUI si le type de tiers est client
thirdpartprospect	3	code prospect si le type de tiers est prospect	OUI si le type de tiers est prospect
dealfamily	3	famille d’affaire	NON
sitecode	3	code site	NON
agencycode	3	code agence	NON	optionnel
warehouse	3	dépôt	NON	optionnel
currency	3	devise	NON	optionnel
model	3	code affaire modèle	NON	si création d’un affaire à partir d’un affaire modèle
needsflag	3	indicateur copier besoins	NON	valeurs possibles : YES/NO
eventsflag	3	indicateur copier évènements	NON	valeurs possibles : YES/NO
rubricsflag	3	indicateur copier rubriques	NON	valeurs possibles : YES/NO
activitiesflag	3	indicateur copier activités	NON	valeurs possibles : YES/NO
constraintflag	3	indicateur copier contraintes	NON	valeurs possibles : YES/NO
tecflag	3	indicateur copier données techniques	NON	valeurs possibles : YES/NO

Le cas UPDATE pour modification

...

Balise du corps (data)

...

Niveau

...

Contenu

...

Obligatoire insert

...

Remarques

...

deal

...

2

...

Liste des champs avec leur nom de champ et la valeurpos

...

OUI

...

deal

...

3

...

code affaire

...

NON

...

{“nomChamp1”:”valeur1”,”nomChamp2”:valeur2”}

...

2

...

Liste des champs à modifier avec leurs noms de champ et la valeurs

...

NON

...

(Ici des exemples prêts à copier. Exemple = que la zone data, complet= tout)

...

Utilisé pour initialiser des champs
CONTRACTFAM	3
LABEL	3	Libellé du contrat	OUI
STARTDATE	3	Date de début du contrat	OUI
ENDDATE	3	Date de fin du contrat
EQUIPTB : [ { “MATERIAL“: { “CODEMATERIAL“:”Q0005”}}]	3	Pour rattacher les matériels avec le contrat	Non

Un mapping des champs de la table CEACONTRAT est nécessaire ; voir GTTMAPPING Charger_Map_CEACONTRAT_OI pour plus de détails

Nom du champ	Nom de la balise JSON	Remarque
Dos	FOLDER
TiersIndividu	THIRDPARTY
Lib80	LABEL
ContratRef	CONTRACTNUMBER
ValDebDt	STARTDATE
ValFinDt	ENDDATE
TypeContrat	CONTRACTTYPE
ElemNo	DEALELEMENT
ContratFam	CONTRACTFAM
renouvfrqtyp	TYPEFREQUENCYRENEWAL
renouvduree	DURATION	Type durée
resilfrqtyp	TYPEFREQUENCYTERMINATION	type Délai résiliation
delresil	TERMINATIONDEADLINE	Délai résiliation
frqtyp	TYPEFREQUENCY
contratduree	CONTRACTDURATION	Durée initiale
taciteflg	TACITAGREEMENT	Tacite reconduction
reconducfrqtyp	TYPEFREQUENCYRENEWAL	Durée reconduction
reconducduree	RENEWALDURATION	Durée reconduction
sitecod	SITE	site
ContratCod	CONTRACTCODE	Modèle de contrat
ContratMt	AMOUNT	Valorisation en
fadebdt	BILLINGSTARTDATE
mttyp	AMOUNTTYPE
moincluflg	LABORINCLUDED	Main doeuvre incluse
pceincluflg	PIECEINCLUDED	Pièces incluses
depincluflg	LOCATIONINCLUDED	Déplacements inclus
ventetx	RATESALEPRICE	Taux normal
ventetx1	INITIALRATEALEPRICE	Taux initial
ventetx1dt	ENDDATERATE
preffano	ORIGINEINVOICEPREFIX	Dernière facture
fano	ORIGINEINVOICENUMBER	Dernière facture
fafam	BILLINGFAMILY	famille de facturation
fagrptyp	BILLINGGROUPINGMODE
indextyp	INDEXATIONTYPE	Type indexation
indexmois	MONTHINDEX
indexcoef	INDEXINGCOEFFICIENT	Coefficient fixe
indexformule	INDEXINGFORMULA	Formule
indexplafcoef	CEILINGCOEFFCIENTINDEXATION	Plafond à la hausse %
indexseuilcoef	COEFFICIENTTHRESHOLDINDEXATION	Seuil à la baisse %
indexbasetyp	BASETYPEINDEXING	Base Année n-1
indexbaisseflg	RATEDROPAUTHORIZATION	Baisse interdite
indexbasedt	INDEXBASEDATE	Date base des indices
indexbasemt	BASECONTRACTAMOUNT	Valeur
indexdebdt	FIRSTINDEXATIONDATE	Date 1ère indexation
echflg	MATURITYTYPE	TYPE Décheance
facaltyp	CALENDARTYPE	Type calendrier
faprorataflg	PRORATEDBILLING	Facturation au prorata temporis
debdt	FIRSTPERIODSTARTDATE	Date début première période
tvatie	THIRDPARTYVATSYSTEM
regl	PAYMENTCHOICE
dev	CURRENCY
tiersfact	BILLINGTHIRDPARTY
tiersfacttyp	BILLINGMETHOD
adrcod	ADDRESSCODE	Adresse Facturation
marche	BARGAIN	Liens
Affaire	DEAL
Axe1	AXIS1	Axes analytiques
Axe2	AXIS2
Axe3	AXIS3
Axe4	AXIS4
TaFam	THIRDPARTYPRICINGFAMILY	Tarification
TaFamX	THIRDPARTYEXCEPTIONPRICINGFAMILY
PromoTaCod	RATECODEPROMOTION
TaCod	RATECODE
HtCod	RATETYPE	HT=1, TTC=2
ReFam	THIRDPARTYDISCOUNTCATEGORY
ReFamX	THIRDPARTYEXCEPTIONDISCOUNTCATEGORY
PromoRemCod	DISCOUNTCODEPROMOTION
RemCod	DISCOUNTCODE
Rem1	DISCOUNT1
Rem2	DISCOUNT2
Rem3	DISCOUNT3
RemTyp1	DISCOUNTTYPE1
RemTyp2	DISCOUNTTYPE2
RemTyp3	DISCOUNTTYPE3
Repr1	SALESPERSON1	Commerciaux
Repr2	SALESPERSON2
Repr3	SALESPERSON3
tafaminter	INTERVENTIONTHIRDPARTYPRICINGFAMILY	Tarification intervention
tafamxinter	INTERVENTIONTHIRDPARTYEXCEPTIONPRICINGFAMILY
promotacodinter	INTERVENTIONRATECODEPROMOTION
tacodinter	INTERVENTIONRATECODE
refaminter	INTERVENTIONTHIRDPARTYDISCOUNTCATEGORY	Remise
refamxinter	INTERVENTIONTHIRDPARTYEXCEPTIONDISCOUNTCATEGORY
promoremcodinter	INTERVENTIONDISCOUNTCODEPROMOTION
remcodinter	INTERVENTIONDISCOUNTCODE
reminter1	INTERVENTIONDISCOUNT1
reminter2	INTERVENTIONDISCOUNT2
reminter3	INTERVENTIONDISCOUNT3
remtypinter1	INTERVENTIONDISCOUNTTYPE1
remtypinter2	INTERVENTIONDISCOUNTTYPE2
remtypinter3	INTERVENTIONDISCOUNTTYPE3
seuilcod	BILLINGTHRESHOLD	Seuil de facturation intervention
txttextyp	NOTETEXTTYPE	Impression
editmatflg	EDITIONMATERIALPFC	Edition matériel dans texte de la PFC
editindexflg	EDITIONTEXTINDEXINGPFC	Edition texte indexation dans texte de la PFC
impdocfl	PRINTTEXTFROMMODEL	Impression du texte provenant du modèle
impfafl	AUTOMATICPRINTINGINVOICES	Impression automatique des factures
textyp	TEXTTYPE
GENERCALPREV	GENERCALPREV	option pour la génération du calendrier
EQUIPTB	EQUIPTB	Tableau des équipements sous la forme MATERIAL':{'CODEMATERIEL':'xx'}

Exemple de corps pour un GET

Bloc de code

language	json

'data':
    {
        'contract': {'CONTRACTNUMBER':'NEWCONTRACT01'}
    }

Exemple de corps pour un INSERT

Bloc de code

language	json

'data':
        {
        'dealcontract':
            {       
                'CONTRACTNUMBER':'NEWCONTRACT01',
                'THIRDPARTY': 'C0000010',
                'CONTRACTCODE': 'ENTRET',
                'LABEL': 'C0000010',
                'STARTDATE': '20230101',
     'DEAL': 'E0501'
           'ENDDATE': '20231231',
                'GENERCALPREV': '2',
                'CONTRACTFAM': 'ABOREVUE',
                'EQUIPTB': [ {'MATERIAL':{'CODEMATERIEL':'IMPLANT1'}, 'MATERIAL':{'CODEMATERIEL':'MONT-C1'}}]                
            }
        }

Exemple

...

complet flux JSON pour un

...

GET

Bloc de code

language	json

'data{ 
    "action":"WEB_SERVICE_INFINITY",
    "access_token":"{{TOKEN}}",
    "param":"
        {
        'action': {
            'swinfinity': 'integration_contrat',
            'parameters': {'dos': '998', 'actiontyp':'GET'}
           'deal': },            
        'data':
            {
                'DEALcontract': {'CONTRACTNUMBER':'E0501NEWCONTRACT01'}
            }
        }"
}

Exemple complet flux JSON pour un

...

INSERT

Bloc de code

language	json

...

Bloc de code

language	json

{ 
    "action":"WEB_SERVICE_INFINITY",
    "access_token":"{{TOKEN}}",
    "param":"
        {
        'action': {
            'swinfinity': 'integration_contrat',
            'parameters': {'dos': '998', 'actiontyp':'INSERT'}
            },
        'data':
            {
            'contract':
                {       
                    'CONTRATREF':'NEWCONTRACT03',
                    'THIRDPARTY': 'C0000010',
                    'CONTRACTCODE': 'ENTRET',
                    'LABEL': 'C0000010',
                    'STARTDATE': '20230101',
                    'ENDDATE': '20231231',
                    'CONTRACTFAM': 'ABOREVUE',
                    'EQUIPTB': [ {'MATERIAL':{'CODEMATERIEL':'IMPLANT1'}, 'MATERIAL':{'CODEMATERIEL':'MONT-C1'}}]
                }
            }
        }"
}

Format de la réponse :

Balise

Contenu

error

Anomalie technique de l’appel du service web

0 = pas n’anomalie, autre valeur = anomalie

Dans ce cas la balise txterrindique le message d’erreur

result

Détail du résultat fonctionnel de l’appel du service web

resultcode= 0 => pas d’anomalie fonctionnelle la demande est bien traitée

resultcode<>0 => anomalie fonctionnelle/métier dont la raison est indiquée dans errormessage

Le CONTRATREF est retourné dans la response ainsi que le numéro de contrat dans CONTRATNO

Exemple de réponse GET

Bloc de code

language	json

{
    "error": 0,
    "result": "{\"label\": \"infinity\",\"codeScript\": \"integration_contrat\",\"resultType\": \"JSON\",\"result\":
    {\"common\":{\"resultcode\": \"0\",\"errormessage\": \"\"},\"response\":{\"CONTRACTNUMBER\": \"NEWCONTRACT01\",\"tierstyp\": \"2\",\"THIRDPARTY\": \"C0000010\",\"CONTRACTFAM\": \"ABOREVUE\",\"LABEL\": \"C0000010\",\"dureetyp\": \"2\",\"STARTDATE\": \"20230101\",\"ENDDATE\": \"20231231\",\"DURATION\": \"12\",\"TYPEFREQUENCYRENEWAL\": \"2\",\"TERMINATIONDEADLINE\": \"1\",\"renouvprevdt\": \"20240101\",\"TYPEFREQUENCYTERMINATION\": \"2\",\"TYPEFREQUENCY\": \"3\",\"TACITAGREEMENT\": \"1\",\"TYPEFREQUENCYRENEWAL\": \"3\",\"CONTRACTCODE\": \"ENTRET\",\"AMOUNT\": \"1200,00\",\"AMOUNTTYPE\": \"1\",\"LABORINCLUDED\": \"2\",\"PIECEINCLUDED\": \"2\",\"LOCATIONINCLUDED\": \"2\",\"BILLINGGROUPINGMODE\": \"1\",\"INDEXATIONTYPE\": \"4\",\"MATURITYTYPE\": \"2\"}}}",
    "txterr": "",
    "infos": ""
}

Exemple de réponse INSERT

Bloc de code

language	json

{
        "error": 0 0,
        "result":  "{\"label\":  \"infinity\",\"codeScript\":  \"associer_fichierintegration_contrat\",\"resultType\": \"JSON\",\"result\":
        {\"common\":{\"resultcode\":  \"0\",\"errormessage\":  \"\"},\"response\":{\"CONTRATREF\": \"NEWCONTRACT01\",\"CONTRATNO\": \"16\"}}}",
        "txterr":  "",
        "infos":  ""
}

Comparaison des versions

Ancienne version 1

Nouvelle version Actuel

Légende

Intégration et interrogation contrat

Exemple de corps pour un GET

Exemple de corps pour un INSERT

Exemple

complet flux JSON pour un

GET

Exemple complet flux JSON pour un

INSERT

Comparaison de pages

Comparaison des versions

Ancienne version 1

Nouvelle version Actuel

Légende

Intégration et interrogation contrat

Exemple de corps pour un GET

Exemple de corps pour un INSERT

Exemple

complet flux JSON pour un

GET

Exemple complet flux JSON pour un

INSERT