Scroll down to learn more

Documentation Center

Welcome to Opinum Documentation Center. You find here all the content you need to enjoy your data.

Search Results for

    Show / Hide Table of Contents

    Whatif execution mode

    This mode instruct the MDE to do as much operations as it can without affecting any Opinum entity; an operation report (named WHATIF_*) is stored back to the account storage at the end of the processing. This is a “test” mode that can be used during development phase.

    Important

    The Whatif mode is limited when new entities are created: if the MDE creates new source that must be attached to a new site that the MDE is supposed to create in the same "round", the source can't report the exact site it is attached to because this site does not exist

    Here is a sample of such Whatif report (please note ''"SiteId": null'' in the source dump that reflects a non-existing site due to the WhatIf execution):

    	=========== ADD SITES ===========
    	Object type: SiteBusiness key(s): 999
    	Operation(s): Create site
    	Object dump: {
    	  "Location": null,
    	  "ClientData": {
    	    "Location Master Data": {
    	      "Technical Identifiers": {
    	        "LOC_ID": 999,
    	        "CADI NR": 998
    	      },
    	      "Other Information": {
    	        "LOC_TYP_NAME": "OPINUM",
    	        "PROVINCE": "Branbant Wallon"
    	      },
    	      "EAN": {
    	        "MTR_EAN_ELE_OFF": "541448860999999999",
    	        "MTR_EAN_GAS": "541448860999999998",
    	        "GOS": "541448860999999997"
    	      }
    	    }
    	  },
    	  "TypeId": 15,
    	  "Street": "6 Rue Emile Franqui",
    	  "PostalCode": "1345",
    	  "City": "LLN",
    	  "Country": null,
    	  "TimeZoneId": "Romance Standard Time",
    	  "Id": 0,
    	  "Name": "OPINUM HOME"
    	}
    	=========== REMOVE SITES ===========
    	=========== UPDATE SITES ===========
    	=========== ADD SOURCES ===========
    	Object type: SourceBusiness key(s): 8888
    	Operation(s): Create source
    	Object dump: {
    	  "SiteId": null,
    	  "SiteName": null,
    	  "SerialNumber": "8888",
    	  "SimId": null,
    	  "DisplayVariableTypeId": 131,
    	  "GatewayId": 7057,
    	  "GatewayTypeId": 0,
    	  "MeterAddress": null,
    	  "ClientData": {
    	    "Meter Master Data": {
    	      "Technical Identifiers": {
    	        "MTR_ID": 8888
    	      },
    	      "Other Information": {
    	        "MTR_POLL": "Y",
    	        "MTR_TYP_NAME": "ELEKTRICITEIT",
    	        "MTR_PULSE": 0.01
    	      }
    	    }
    	  },
    	  "EanNumber": null,
    	  "MeterNumber": null,
    	  "Localisation": null,
    	  "Description": null,
    	  "Tags": [
    	    "V_FRISCOUNT",
    	    "raw"
    	  ],
    	  "Id": 0,
    	  "EnergyTypeId": 1,
    	  "EnergyUsageId": null,
    	  "Name": "OPINUM_SOURCE1",
    	  "SourceTypeId": 77,
    	  "TimeZoneId": null
    	}
    	=========== REMOVE SOURCES ===========
    	=========== UPDATE SOURCES ===========
    	=========== CHANGE SOURCE SITE ===========
    

    Developer Center

    User manual API Swagger Github
    © Opinum 2025  -   www.opinum.com

    Follow us

    Linkedin Twitter Youtube Facebook