Résumé
Manipulation de l'entité Branchoffice (Agences) en lecture/écriture/suppression via un objet métier depuis une application externe.
Tables
Les tables utilisées sont :
sw_data_branchoffice : Table des agences
Les tables liées sont :
sw_data_modulecoldbranchoffice : Module Froid - Table des données froid des agences
Critères d'activation
WHK_Branchoffice est défini dans la gestion des webhooks du studio.
Fonctionnement
settings parameters
"settings":
{
"getModuleColdBranchoffice": "1" // pour le verb GET et LIST permet de retourner les informations des données module froid agence
}
verb: GET
resultType: simple
"branchoffice": {
"codebranchoffice": "75.PAR",
"name": "Paris",
"address1": "1 avenue des Champs Elysées",
"address2": "",
"postalCode": "75000",
"city": "PARIS",
"generictype_ID_country": "FR",
"phoneNumber": "01 88 81 50 10",
"faxNumber": "01 89 82 51 11",
"email": "agc-paris@papyrus.fr"
}
verb: GET
resultType: extended
"branchoffice":{
"codebranchoffice": "75.PAR",
"name": "Paris",
"address1": "1 avenue des Champs Elysées",
"address2": "",
"postalCode": "75000",
"city": "PARIS",
"generictype_ID_country": "FR",
"phoneNumber": "01 88 81 50 10",
"faxNumber": "01 89 82 51 11",
"email": "agc-paris@papyrus.fr",
"website": "www.papyrus.com",
"bankholidayparamheader_ID": "FRANCE",
"gpsLongitude": "",
"gpsLatitude": "",
"baseusergroup_ID": "#TEST SB-TEST SB lib"
}
verb: GET
resultType: extendedRelated
en complément du résultat pour resultType: extended on aura le détail pour la table generictype_country
"related": [
{
"generictype_country": {
"codegenerictype": "COUNTRY-FR",
"label": "FRANCE",
"originalCode": "FR",
"dataType": "COUNTRY",
"description": "",
"translationKey": "GenType_COUNTRY-FR",
"generictype_ID_parent": "",
"tag": "",
"orderNumber": ""
}
}]
verb: GET
resultType: simple, extended, extendedRelated
getModuleColdBranchoffice: “1”
"branchoffice": {
...
},
"modulecoldbranchoffice": [
{
"codemodulecoldbranchoffice": "75.PAR",
"capacityCertificateNumber": "236101CAT1"
}
]
verb: PUT
{
"branchoffice": {
"codebranchoffice": "75.PAR", /* Code globalement unique de l'agence (Varchar (255))*/
"name": "Paris", /* Nom de l'agence (Varchar (255))*/
"address1": "1 avenue des Champs Elysées", /* Adresse 1 (Varchar (255))*/
"address2": "", /* Adresse 2 (Varchar (255))*/
"postalCode": "75000", /* Code postal (Varchar (16))*/
"city": "PARIS", /* Ville (Varchar (255))*/
"generictype_ID_country": "COUNTRY-FR", /* Code pays (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = COUNTRY)*/
"phoneNumber": "01 88 81 50 10", /* Numéro de téléphone (Varchar (64))*/
"faxNumber": "01 89 82 51 11", /* Numéro de télécopie (Varchar (64))*/
"email": "agc-paris@papyrus.fr", /* Email (Varchar (255))*/
"website": "www.papyrus.com", /* Site internet (Varchar (255))*/
"bankholidayparamheader_ID": "", /* Code entête paramétrage jours fériés (ForeignKey () - sw_data_bankholidayparamheader.codebankholidayparamheader)*/
"baseusergroup_ID": "TEST SB-BRANCHOFFICE" /* Code groupe utilisateur (ForeignKey () - sw_data_baseusergroup.codebaseusergroup)*/
},
/* Une seule donnée froid pour une agence */
"modulecoldbranchoffice": [
{
"codemodulecoldbranchoffice" : "75.PAR", /* Code globalement unique de la donnée froid de l'agence (Varchar (255))*/
"capacityCertificateNumber": "236101CAT1" /* N° d'attestation de capacité (Varchar (64))*/
}
]
}
verb: LIST
resultType: simple, extended reprendre les définitions du GET
"filters:" {
"codeBranchoffice": "value", filter is equal
"name": "value", filter is contains
"codeCountry": "value", filter is equal
"useModuleCold": "value", filter is equal (if value = "1" return only branchoffices that use cold data)
},
"orderBy": "value"
Valeurs possibles pour le tri "orderBy" :
codeBranchOfficeAsc : par code agence ascendant
nameAsc : par nom ascendant