WebHook Branchoffice (V5.4)

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

verb: GET
resultType: simple, extended, extendedRelated
getModuleColdBranchoffice: “1”

verb: PUT

verb: LIST
resultType: simple, extended reprendre les définitions du GET

Valeurs possibles pour le tri "orderBy" :

codeBranchOfficeAsc : par code agence ascendant
nameAsc : par nom ascendant