WebHook Third Party Contact (V5.7)

Résumé

Manipulation de l'entité ThirdPartyContact (Contacts des tiers) en lecture via un objet métier depuis une application externe.

Ce webhook ne traite que les modes DEFINITION, GET et LIST.

Il permet donc d’interroger par exemple une liste de contacts de tiers (client, prospect, suspect, sous-traitants, …) sans passer par le webhook particulier à chaque type de tiers.

Pour les modes PUT et DELETE, il faudra passer par le webhook particulier à chaque type de tiers (WHK_CustomerContact, WHK_ProspectContact, WHK_SuspectContact, WHK_SubcontractorContact, …).

Tables

Les tables utilisées sont :

sw_data_customercontact : Table des contacts des tiers

Critères d'activation

WHK_ThirdPartyContact est défini dans la gestion des webhooks du studio.

Fonctionnement

verb: GET
resultType: simple

  "thirdpartycontact":{
    "codethirdpartycontact":"C0000001-DJ",
    "thirdparty_ID":"C0000001",
    "generictype_ID_civility":"M",
    "lastName":"DENEIR",
    "firstName":"Jacques",
    "address1":"1b rue Darwin",
    "address2":"",
    "address3":"",
    "postalCode":"21000",
    "city":"DIJON",
    "phoneNumber":"05 55 79 56 92",
    "faxNumber":"05 55 79 56 11",
    "mobilePhoneNumber":"06 07 08 09 10",
    "email":"jdeneir@nebout.div",
    "generictype_ID_country":"FR",
    "generictype_ID_province":"",
    "baseculture_ID":"",
  }

verb: GET
resultType: extended

  "thirdpartycontact":{
    "codethirdpartycontact":"C0000001-DJ",
    "thirdparty_ID":"C0000001",
    "generictype_ID_civility":"M",
    "lastName":"DENEIR",
    "firstName":"Jacques",    
    "address1":"1b rue Darwin",
    "address2":"",
    "address3":"",
    "postalCode":"21000",
    "city":"DIJON",
    "phoneNumber":"05 55 79 56 92",
    "faxNumber":"05 55 79 56 11",
    "mobilePhoneNumber":"06 07 08 09 10",
    "email":"jdeneir@nebout.div",
    "generictype_ID_country":"FR",
    "generictype_ID_province":"",
    "baseculture_ID":"",
    "gpsLongitude":"",
    "gpsLatitude":"",
    "description":"Acheteur direct",
    "generictype_ID_position":"Responsable commercial",
    "birthday":"1980-09-18",
    "mainContact":"0",
    "generictype_ID_service":"Commercial",
    "skype":"",
    "bouncedEmailDetected":"",
    "closedDate":"",
    "twitter":"",
    "linkedin":"",
    "decisionMaker":"",
    "thirdpartycontact_ID_superior":"",
    "topFlowchartLevel": "",
    "erpContactID":""
  }

verb: GET
resultType: extendedRelated
en complément du résultat pour resultType: extended on aura le détail pour les tables thirdparty, generictype_civility, generictype_position, generictype_country, generictype_province, generictype_service et baseculture

"related":[
{
  "thirdparty":{
    "codethirdparty":"C0000001",
    "name":"ENTREPRISE DIJON GUICHARD",
    "baseuser_ID":"",
    "address1":"33 Avenue du Drapeau",
    "address2":"",
    "address3":"",
    "postalCode":"21000",
    "city":"DIJON",
    "phoneNumber":"03 90 11 22 33",
    "faxNumber":"03 90 11 22 44",
    "mobilePhoneNumber":"06 90 11 22 33",
    "email":"contact@guichard.com",
    "deliveryDays":"1A;1B;2A;2B;3A;3B;4A;4B;5A;5B",
    "openingDays":"1A;1B;2A;2B;3A;3B;4A;4B;5A;5B",
    "siretNumber":"",
    "vatIntra":"",
    "apeCode":"516K",
    "comment":"",
    "blocked":"0",
    "blockedComment":"",
    "message":"",
    "vacationStart":"",
    "vacationEnd":"",
    "gpsLongitude":"5.04372",
    "gpsLatitude":"47.33222",
    "gpsPrecision":"8",
    "gpsUpdateDate":"2020-09-03 23:02:12",
    "gpsManual":"",
    "accountNumber":"C0000001",
    "contactName":"",
    "currency_ID":"",
    "authorizedCredit":"0",
    "risk":"1",
    "language":"",
    "underSurveillance":"",
    "workforce":"25",
    "thirdparty_ID_paying":"",
    "pricecategory_ID":"",
    "discountRate":"0",
    "website":"https://www.guichard.com",
    "legalStatus":"Société Anonyme avec Directoire",
    "generictype_ID_brand":"",
    "generictype_ID_deliveryMode":"",
    "generictype_ID_paymentMean":"",
    "generictype_ID_country":"FR",
    "generictype_ID_province":"",
    "generictype_ID_thirdpartyType":"CTC",
    "generictype_ID_thirdpartyFamily":"",
    "confirmationEmail":"contact@guichard.com",
    "confirmationFax":"03 90 11 22 44",
    "generictype_ID_taxCode":"",
    "productdepot_ID":"",
    "generictype_ID_accountingCategory":"",
    "generictype_ID_thirdpartyPotential":"B",
    "generictype_ID_civility":"",
    "skype":"contact@guichard.com",
    "generictype_ID_role":"",
    "unused":"0",
    "customergroup_ID":"",
    "generictype_ID_referencing":"2",
    "generictype_ID_distribution":"SELF",
    "generictype_ID_market":"BIG",
    "area":"",
    "baseculture_ID":"FR-FR",
    "baseuser_ID_favoriteTechnician":"TECH-01",
    "branchoffice_ID":"SXB",
    "emailFormat":"",
    "isIndividual":"0",
    "facebook":"https://www.facebook.com/guichard/",
    "twitter":"https://twitter.com/guichard",>
    "youtube":"https://www.youtube.com/watch?v=6jGbnEwQJ54",
    "linkedin":"https://www.linkedin.com/company/guichard",
    "activity":""
  },
  "generictype_civility":{
    "codegenerictype":"CIVILITY-M",
    "label":"Monsieur",
    "originalCode":"M",
    "dataType":"CIVILITY",
    "description":"",
    "translationKey":"GenType_CIVILITY-M",
    "generictype_ID_parent":"",
    "tag":"",
    "orderNumber":""
  },
  "generictype_country": {
    "codegenerictype": "COUNTRY-FR",
    "label": "FRANCE",
    "originalCode": "FR",
    "dataType": "COUNTRY",
    "description": "",
    "translationKey": "GenType_COUNTRY-FR",
    "generictype_ID_parent": "",
    "tag": "",
    "orderNumber": ""
  },
  "generictype_province": {
    "codegenerictype": "",
    "label": "",
    "originalCode": "",
    "dataType": "",
    "description": "",
    "translationKey": "",
    "generictype_ID_parent": "",
    "tag": "",
    "orderNumber": ""
  },
  "baseculture": {
    "codebaseculture": "FR-FR",
    "label": "French - France",
    "codelanguage": "FR"
  },
  "generictype_position": {
    "codegenerictype": "CONTACT_POSITION-2",
    "label": "Responsable commercial",
    "originalCode": "2",
    "dataType": "CONTACT_POSITION",
    "description": "",
    "translationKey": "GenType_CONTACT_POSITION-2",
    "generictype_ID_parent": "",
    "tag": "",
    "orderNumber": ""
  },
  "generictype_service": {
    "codegenerictype": "SERVICE-COMM",
    "label": "Commercial",
    "originalCode": "COMM",
    "dataType": "SERVICE",
    "description": "",
    "translationKey": "",
    "generictype_ID_parent": "",
    "tag": "",
    "orderNumber": ""
  }
}]

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

"filters:" {
  "codeThirdPartyContact": "value", filter is equal
  "codeThirdParty": "value", filter is equal
  "codeThirdPartyType": "value", filter is equal
  "lastName": "value", filter is contains  
  "firstName": "value", filter is contains
  "birthday": "value", filter is greater or equal to
  "birthdayBetween": "value1|value2", filter is between value1 and value2
  "codeCountry": "value", filter is equal
  "email": "value", filter is equal
  "emailDomain": "value", filter is endswith (ie "emailDomain": "@domaine.extension")
  "notClosedBefore": "value", filter is (closedDate is null OR closedDate > value)
  "closedAfter": "value", filter is closedDate > value
  "closedBefore": "value" filter is closedDate < value
},
"orderBy": "value"

Valeurs possibles pour le tri "orderBy" :

lastNameAscfirstNameAsc : par nom et prénom ascendant