Comparaison des versions

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

...

  • sw_data_equipmentaddress : Table des adresses des équipements

  • sw_data_modulecoldequipmentcharacteristic : Module Froid - Table des caractéristiques froid des équipements

Critères d'activation

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

...

Bloc de code
languagejson
"settings":
{
  "getContracts": "1", // pour le verb GET et LIST permet de retourner les informations des contrats actifs de l'équipement
  "getWarranties": "1" // pour le verb GET et LIST permet de retourner les informations des garanties actives de l'équipement
}

verb: GET
resultType: simple

Bloc de code
languagejson
  "equipmentgetModuleColdEquipmentCharacteristic":{
    "codeequipment1": "BAL01-201910",
    "description": "Ballon 300 litres",
    "equipmenttype_ID": "BALL", // pour le verb GET et LIST permet de retourner les informations des caractéristiques module froid équipement
}

verb: GET
resultType: simple

Bloc de code
languagejson
  "equipment":{
    "serialNumbercodeequipment": "BAL-169BAL01-201910",
    "description": "Ballon 300 litres",
    "equipmenttype_ID": "BALL",
    "serialNumber": "BAL-169-2",
    "equipmentstatus_ID": "BEING_CREATED"
  }

...

Bloc de code
languagejson
  "equipment":{
    "codeequipment": "BAL01-201910",
    "description": "Ballon 300 litres",
    "equipmenttype_ID": "BALL",
    "serialNumber": "BAL-169-2",
    "equipment_ID_parent": "",
    "location": "Cave",
    "gpsLongitude": "",
    "gpsLatitude": "",
    "gpsAccuracy": "",
    "gpsUpdateDate_fixed": "",
    "gpsManual": "",
    "baseuser_ID_favoriteTechnician": "",
    "installationDate": "2020-08-04 00:00:00",
    "equipmentstatus_ID": "BEING_CREATED",
    "customerReference": "",
    "brand": "",
    "maker": "",
    "inServiceDate": "",
    "terminationDate": "",
    "replacementDate": "",
    "product_ID": "",
    "quantityRepresented": "1",
    "orderheader_ID": "",
    "externalID": "DTR 1 C1",
    "equipmentkind_ID": "DEFAULT",
   } "useModuleCold": "0"
  }

verb: GET
resultType: extendedRelated
en complément du résultat pour resultType: extended on aura le détail pour les tables equipmenttype, equipmentkind, equipment_parent, baseuser_favoriteTechnician, equipmentstatus et product

...

verb: GET
resultType: simple, extended, extendedRelated
getContracts: "1",
getWarranties: "1"
getModuleColdEquipmentCharacteristic: “1”

Bloc de code
languagejson
"equipment": {
    ...
  },
"contracts": [
  {
    "codecontract": "2950000000014",
    "label": "Contrat maintenance",
    "contractNumber": "CONTRACT_000057",
    "startDate": "2020-07-13 00:00:00",
    "endDate": ""
  },
  {
    ... 
  }],
"warranties": [
  {
    "codeequipmentwarranty": "5550000000022",
    "equipmentwarrantytype_ID": "Garantie classique",
    "startDate": "2020-05-18 16:20:05",
    "endDate": "2021-05-18 16:20:05",
    "partIncluded": "0",
    "workIncluded": "0",
    "travelIncluded": "0"
  },
  {
    ...
  }]

verb: PUT
Selon webhookVersion renseigné dans le header :

  • webhookVersion = 1 -> les blocs json equipmenttype, customer et site sont obligatoires.

  • webhookVersion = 2 -> les blocs json equipmenttype, customer et site ne doivent plus être renseignés, sinon il y aura une erreur en retour. Ils doivent être appelés explicitement par leur webhooks correspondants (equipmenttype, customer et customeraddress) en amont.

Info

La description pour webhookVersion = 1 peut être consultée dans les pages de la version Divalto weavy 5.5 et antérieures.

Bloc de code
languagejson
{
  "equipment": {
    "codeequipment": "BAL01-201910", /* Code globalement unique de l'équipement,
  "modulecoldequipmentcharacteristic": [
    {
      "codemodulecoldequipmentcharacteristic": "BAL01-201910",
      "modulecoldfluidnature_ID": "Fluide 01",
      "coolingCapacity": "2",
      "hasAutoLeakDetector": "0"
    }
  ]

verb: PUT
Selon webhookVersion renseigné dans le header :

  • webhookVersion = 1 -> les blocs json equipmenttype, customer et site sont obligatoires.

  • webhookVersion = 2 -> les blocs json equipmenttype, customer et site ne doivent plus être renseignés, sinon il y aura une erreur en retour. Ils doivent être appelés explicitement par leur webhooks correspondants (equipmenttype, customer et customeraddress) en amont.

Info

La description pour webhookVersion = 1 peut être consultée dans les pages de la version Divalto weavy 5.5 et antérieures.

Bloc de code
languagejson
{
  "equipment": {
    "codeequipment": "BAL01-201910", /* Code globalement unique de l'équipement (Varchar (255))*/
    "equipmentkind_ID": "DEFAULT", /* Code du genre d'équipement (ForeignKey () - sw_data_equipmentkind.codeequipmentkind)*/
    "equipmenttype_ID": "BALL", /* Code du type d'équipement (ForeignKey () - sw_data_equipmenttype.codeequipmenttype)*/
    "description": "Ballon 300 litres", /* Description de l'équipement (Text (65535))*/
    "serialNumber": "BAL-169-2", /* N° de série (Varchar (64))*/
    "equipment_ID_parent": null, /* Code de l'équipement parent (nécessite que le parent a été créée avant celui-ci) (ForeignKey () - sw_data_equipment.codeequipment)*/
    "location": "Cave", /* Localisation sur le site (Varchar (255))*/
    "equipmentkindequipmentstatus_ID": "DEFAULTBEING_CREATED", /* CodeStatut dude genre dl'équipement (ForeignKey () - sw_data_equipmentkindequipmentstatus.codeequipmentkindcodeequipmentstatus)*/
    "equipmenttype_IDcustomerReference": "BALL"null, /* CodeRéférence duchez typele d'équipementclient (ForeignKeyVarchar () - sw_data_equipmenttype.codeequipmenttype64))*/
    "descriptionbrand": "Ballon 300 litres", /* Description de l'équipement* Marque (TextVarchar (65535255))*/
    "serialNumbermaker": "BAL-169-2", /* N° de sérieConstructeur (Varchar (64255))*/
    "equipment_ID_ParentinstallationDate": null"2020-08-04", /* Code de l'équipement parent (nécessite que le parent a été créée avant celui-ci) (ForeignKey () - sw_data_equipment.codeequipment Date d'installation (DateTime ())*/
    "inServiceDate": null, /* Date de mise en service (DateTime ())*/
    "locationterminationDate": "Cave"null, /* Date Localisationde sur le sitefin d'existence (VarcharDateTime (255))*/
    "equipmentstatus_IDreplacementDate": "BEING_CREATED"null, /* StatutDate de l'équipementremplacement (ForeignKeyDateTime () - sw_data_equipmentstatus.codeequipmentstatus)*/
    "customerReferenceproduct_ID": null, /* RéférenceCode chezarticle le(ForeignKey client() (Varchar (64))- sw_data_product.codeproduct)*/ 
    "brandquantityRepresented": "1", /* Quantité Marquereprésentée (VarcharInt (255))*/
    "makerexternalID": "", /* Constructeur (Varchar (255))*/DTR                1        "installationDate": "2020-08-04 C12", /* DateOrigine d'installationexterne (DateTimeVarchar (64))*/
    "inServiceDateuseModuleCold": null"0", /* Date de mise en service (DateTime Utilise le module froid (Valeurs possibles : 0,1) (Bool ())*/
    "terminationDateinternalcodeequipment": null, /* codeequipment Dateoriginal de fin d'existenceweavy pour transcodage (DateTimeVarchar (255))*/

   "replacementDate": null, /* DateOptionnel de: remplacementpour (DateTime ())*/
    "product_ID": null, /* Code article (ForeignKey () - sw_data_product.codeproduct)*/ mettre à jour les champs dynamiques selon paramétrage */
    /* Exemple 1 : */
    "quantityRepresenteddynamicfields": 
"1", /* Quantité représentée (Int ())*/    [{
      "externalIDfieldname": "MATPRIX"DTR,
      "fieldvalue": "45.12"
    },
  1  {
      C12", /* Origine externe (Varchar (64))*/"fieldname": "MATCODE",
      "internalcodeequipmentfieldvalue": null, /* codeequipment original de weavy pour transcodage (Varchar (255))*/
"Nickel"    
    },
    /*{
Optionnel : pour mettre à jour les...
champs dynamiques selon paramétrage */}]
    /* Exemple 12 : */
    "dynamicfields": 
    [{
      "fieldname": "MATPRIX",
      "fieldvalue": "45.12"
    },
    {
 /* A partir de la version SUMMER'21, le mappage direct des champs dynamiques est possible en utilisant le nom du champ en bdd */
    "fieldnamev_MATPRIX": "MATCODE45.12",

     "fieldvaluev_MATCODE": "Nickel",
    ...
   },
  "equipmentaddress": {
    "codeequipmentaddress":  {
      ...
    }]
   "BAL01-201910-SITE", /* Code globalement unique de l'adresse de l'équipement (Varchar (255))*/
    "equipment_ID": "BAL01-201910", /* ExempleCode 2 : */
    /* A partir de la version SUMMER'21, le mappage direct des champs dynamiques est possible en utilisant le nom du champ en bdd de l'équipement. Reprendre le code équipement du bloc json "equipment" (ForeignKey () - sw_data_equipment.codeequipment)*/
    "customeraddress_ID" : "C0000001-BDX", /* Code adresse client  (ForeignKey () - sw_data_customeraddress.codecustomeraddress)*/
    "v_MATPRIXstartDate": "45.122019-10-26", /* Date de  "v_MATCODE": "Nickel",début (DateTime ())*/
    ...
  },
  "equipmentaddress": {"endDate": null, /* Date de fin (DateTime ())*/
    "codeequipmentaddressinternalcodeequipmentaddress": "BAL01-201910-SITE",null /* Codecodeequipmentaddress globalement uniqueoriginal de l'adresseweavy depour l'équipementtranscodage (Varchar (255))*/
    "equipment_ID": "BAL01-201910",},
  /* CodeUne de l'équipement. Reprendre le codeseule caratéristique froid pour un équipement du*/
bloc json "equipmentmodulecoldequipmentcharacteristic": [
  (ForeignKey () - sw_data_equipment.codeequipment)*/{
      "customeraddress_IDcodemodulecoldequipmentcharacteristic" : "C0000001BAL01-BDX201910", /* Code adresse client  (ForeignKey () - sw_data_customeraddress.codecustomeraddress)*/ globalement unique de la caractéristique froid de l'équipement (Varchar (255))*/
      "startDatemodulecoldfluidnature_ID": "2019-10-26NATURE01", /** Code Datenature de débutfluide (DateTimeForeignKey () - sw_data_modulecoldfluidnature.codemodulecoldfluidnature)*/
      "endDatecoolingCapacity": null"2", /* DateCapacité de finrefroidissement (DateTimeDouble ())*/
      "internalcodeequipmentaddresshasAutoLeakDetector": null"0" /* codeequipmentaddressA un originaldétecteur de weavy pour transcodage (Varchar (255 fuite automatique (Valeurs possibles : 0,1) (Bool ())*/
    }
  ]
}

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

Bloc de code
languagejson
"filters:" {
  "codeEquipment": "value", filter is equal
  "description": "value", filter is contains
  "serialNumber": "value", filter is equal
  "equipmentType": "value", filter is equal
  "equipmentKind": "value", filter is equal
  "codeCustomerAddress": "value", filter is equal
  "codeEquipmentStatus": "value", filter is equal
  "equipmentNotClosed": "value", filter is codeEquipmentStatus <> 'DELETED' and (terminationDate is null OR terminationDate >= value)
  "useModuleCold": "value", filter is equal (if value = "1" return only equipments that use cold characteristics)
},
"orderBy": "value"

Valeurs possibles pour le tri "orderBy" :

...