Empirica SDM API

Sdm

createProfileCOC

Create profile for contract object of contract.


/api/sdm/seprom/coc/{cocId}/create

Usage and SDK Samples

curl -X POST "https://localhost/sdm/services/rest/sdm/api/sdm/seprom/coc/{cocId}/create?distributorId=&eicPoD=&group=&productId=&dateFrom=&dateTo="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SdmApi;

import java.io.File;
import java.util.*;

public class SdmApiExample {

    public static void main(String[] args) {

        SdmApi apiInstance = new SdmApi();
        Integer cocId = 56; // Integer | Contract object identifier
        String eicPoD = eicPoD_example; // String | EIC for point of delivery
        Boolean group = true; // Boolean |
        Integer productId = 56; // Integer | Product identifier
        Integer distributorId = 56; // Integer |
        date dateFrom = 2013-10-20; // date |
        date dateTo = 2013-10-20; // date |
        try {
            apiInstance.createProfileCOC(cocId, eicPoD, group, productId, distributorId, dateFrom, dateTo);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#createProfileCOC");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SdmApi;

public class SdmApiExample {

    public static void main(String[] args) {
        SdmApi apiInstance = new SdmApi();
        Integer cocId = 56; // Integer | Contract object identifier
        String eicPoD = eicPoD_example; // String | EIC for point of delivery
        Boolean group = true; // Boolean |
        Integer productId = 56; // Integer | Product identifier
        Integer distributorId = 56; // Integer |
        date dateFrom = 2013-10-20; // date |
        date dateTo = 2013-10-20; // date |
        try {
            apiInstance.createProfileCOC(cocId, eicPoD, group, productId, distributorId, dateFrom, dateTo);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#createProfileCOC");
            e.printStackTrace();
        }
    }
}
Integer *cocId = 56; // Contract object identifier
String *eicPoD = eicPoD_example; // EIC for point of delivery
Boolean *group = true; //
Integer *productId = 56; // Product identifier
Integer *distributorId = 56; //  (optional)
date *dateFrom = 2013-10-20; //  (optional)
date *dateTo = 2013-10-20; //  (optional)

SdmApi *apiInstance = [[SdmApi alloc] init];

// Create profile for contract object of contract.
[apiInstance createProfileCOCWith:cocId
    eicPoD:eicPoD
    group:group
    productId:productId
    distributorId:distributorId
    dateFrom:dateFrom
    dateTo:dateTo
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaSdmApi = require('empirica_sdm_api');

var api = new EmpiricaSdmApi.SdmApi()

var cocId = 56; // {Integer} Contract object identifier

var eicPoD = eicPoD_example; // {String} EIC for point of delivery

var group = true; // {Boolean}

var productId = 56; // {Integer} Product identifier

var opts = {
  'distributorId': 56, // {Integer}
  'dateFrom': 2013-10-20, // {date}
  'dateTo': 2013-10-20 // {date}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createProfileCOC(cocId, eicPoD, group, productId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createProfileCOCExample
    {
        public void main()
        {

            var apiInstance = new SdmApi();
            var cocId = 56;  // Integer | Contract object identifier
            var eicPoD = eicPoD_example;  // String | EIC for point of delivery
            var group = true;  // Boolean |
            var productId = 56;  // Integer | Product identifier
            var distributorId = 56;  // Integer |  (optional)
            var dateFrom = 2013-10-20;  // date |  (optional)
            var dateTo = 2013-10-20;  // date |  (optional)

            try
            {
                // Create profile for contract object of contract.
                apiInstance.createProfileCOC(cocId, eicPoD, group, productId, distributorId, dateFrom, dateTo);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SdmApi.createProfileCOC: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SdmApi();
$cocId = 56; // Integer | Contract object identifier
$eicPoD = eicPoD_example; // String | EIC for point of delivery
$group = true; // Boolean |
$productId = 56; // Integer | Product identifier
$distributorId = 56; // Integer |
$dateFrom = 2013-10-20; // date |
$dateTo = 2013-10-20; // date |

try {
    $api_instance->createProfileCOC($cocId, $eicPoD, $group, $productId, $distributorId, $dateFrom, $dateTo);
} catch (Exception $e) {
    echo 'Exception when calling SdmApi->createProfileCOC: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SdmApi;

my $api_instance = WWW::SwaggerClient::SdmApi->new();
my $cocId = 56; # Integer | Contract object identifier
my $eicPoD = eicPoD_example; # String | EIC for point of delivery
my $group = true; # Boolean |
my $productId = 56; # Integer | Product identifier
my $distributorId = 56; # Integer |
my $dateFrom = 2013-10-20; # date |
my $dateTo = 2013-10-20; # date |

eval {
    $api_instance->createProfileCOC(cocId => $cocId, eicPoD => $eicPoD, group => $group, productId => $productId, distributorId => $distributorId, dateFrom => $dateFrom, dateTo => $dateTo);
};
if ($@) {
    warn "Exception when calling SdmApi->createProfileCOC: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SdmApi()
cocId = 56 # Integer | Contract object identifier
eicPoD = eicPoD_example # String | EIC for point of delivery
group = true # Boolean |
productId = 56 # Integer | Product identifier
distributorId = 56 # Integer |  (optional)
dateFrom = 2013-10-20 # date |  (optional)
dateTo = 2013-10-20 # date |  (optional)

try:
    # Create profile for contract object of contract.
    api_instance.create_profile_coc(cocId, eicPoD, group, productId, distributorId=distributorId, dateFrom=dateFrom, dateTo=dateTo)
except ApiException as e:
    print("Exception when calling SdmApi->createProfileCOC: %s\n" % e)

Parameters

Path parameters
Name Description
cocId*
Integer (int32)
Contract object identifier
Required
Query parameters
Name Description
distributorId
Integer (int32)
eicPoD*
String
EIC for point of delivery
Required
group*
Boolean
Required
productId*
Integer (int32)
Product identifier
Required
dateFrom
date (date)
dateTo
date (date)

Responses

Status: default - successful operation


deleteLockingBB

Delete locking for billing basis.


/api/sdm/seprom/{bbId}/deleteLockingBB

Usage and SDK Samples

curl -X POST "https://localhost/sdm/services/rest/sdm/api/sdm/seprom/{bbId}/deleteLockingBB"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SdmApi;

import java.io.File;
import java.util.*;

public class SdmApiExample {

    public static void main(String[] args) {

        SdmApi apiInstance = new SdmApi();
        Integer bbId = 56; // Integer | Billing basis identifier
        try {
            apiInstance.deleteLockingBB(bbId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#deleteLockingBB");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SdmApi;

public class SdmApiExample {

    public static void main(String[] args) {
        SdmApi apiInstance = new SdmApi();
        Integer bbId = 56; // Integer | Billing basis identifier
        try {
            apiInstance.deleteLockingBB(bbId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#deleteLockingBB");
            e.printStackTrace();
        }
    }
}
Integer *bbId = 56; // Billing basis identifier

SdmApi *apiInstance = [[SdmApi alloc] init];

// Delete locking for billing basis.
[apiInstance deleteLockingBBWith:bbId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaSdmApi = require('empirica_sdm_api');

var api = new EmpiricaSdmApi.SdmApi()

var bbId = 56; // {Integer} Billing basis identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteLockingBB(bbId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteLockingBBExample
    {
        public void main()
        {

            var apiInstance = new SdmApi();
            var bbId = 56;  // Integer | Billing basis identifier

            try
            {
                // Delete locking for billing basis.
                apiInstance.deleteLockingBB(bbId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SdmApi.deleteLockingBB: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SdmApi();
$bbId = 56; // Integer | Billing basis identifier

try {
    $api_instance->deleteLockingBB($bbId);
} catch (Exception $e) {
    echo 'Exception when calling SdmApi->deleteLockingBB: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SdmApi;

my $api_instance = WWW::SwaggerClient::SdmApi->new();
my $bbId = 56; # Integer | Billing basis identifier

eval {
    $api_instance->deleteLockingBB(bbId => $bbId);
};
if ($@) {
    warn "Exception when calling SdmApi->deleteLockingBB: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SdmApi()
bbId = 56 # Integer | Billing basis identifier

try:
    # Delete locking for billing basis.
    api_instance.delete_locking_bb(bbId)
except ApiException as e:
    print("Exception when calling SdmApi->deleteLockingBB: %s\n" % e)

Parameters

Path parameters
Name Description
bbId*
Integer (int32)
Billing basis identifier
Required

Responses

Status: default - successful operation


deleteProfileCOC

Delete profile for contract object of contract.


/api/sdm/seprom/coc/{cocId}/delete

Usage and SDK Samples

curl -X POST "https://localhost/sdm/services/rest/sdm/api/sdm/seprom/coc/{cocId}/delete"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SdmApi;

import java.io.File;
import java.util.*;

public class SdmApiExample {

    public static void main(String[] args) {

        SdmApi apiInstance = new SdmApi();
        Integer cocId = 56; // Integer | Contract object identifier
        try {
            apiInstance.deleteProfileCOC(cocId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#deleteProfileCOC");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SdmApi;

public class SdmApiExample {

    public static void main(String[] args) {
        SdmApi apiInstance = new SdmApi();
        Integer cocId = 56; // Integer | Contract object identifier
        try {
            apiInstance.deleteProfileCOC(cocId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#deleteProfileCOC");
            e.printStackTrace();
        }
    }
}
Integer *cocId = 56; // Contract object identifier

SdmApi *apiInstance = [[SdmApi alloc] init];

// Delete profile for contract object of contract.
[apiInstance deleteProfileCOCWith:cocId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaSdmApi = require('empirica_sdm_api');

var api = new EmpiricaSdmApi.SdmApi()

var cocId = 56; // {Integer} Contract object identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProfileCOC(cocId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProfileCOCExample
    {
        public void main()
        {

            var apiInstance = new SdmApi();
            var cocId = 56;  // Integer | Contract object identifier

            try
            {
                // Delete profile for contract object of contract.
                apiInstance.deleteProfileCOC(cocId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SdmApi.deleteProfileCOC: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SdmApi();
$cocId = 56; // Integer | Contract object identifier

try {
    $api_instance->deleteProfileCOC($cocId);
} catch (Exception $e) {
    echo 'Exception when calling SdmApi->deleteProfileCOC: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SdmApi;

my $api_instance = WWW::SwaggerClient::SdmApi->new();
my $cocId = 56; # Integer | Contract object identifier

eval {
    $api_instance->deleteProfileCOC(cocId => $cocId);
};
if ($@) {
    warn "Exception when calling SdmApi->deleteProfileCOC: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SdmApi()
cocId = 56 # Integer | Contract object identifier

try:
    # Delete profile for contract object of contract.
    api_instance.delete_profile_coc(cocId)
except ApiException as e:
    print("Exception when calling SdmApi->deleteProfileCOC: %s\n" % e)

Parameters

Path parameters
Name Description
cocId*
Integer (int32)
Contract object identifier
Required

Responses

Status: default - successful operation


getConsumption

Retrieve consumption values for all curves of given cocId within dateFrom and dateTo.


/api/sdm/seprom/{cocId}/consumptionByMonth

Usage and SDK Samples

curl -X GET "https://localhost/sdm/services/rest/sdm/api/sdm/seprom/{cocId}/consumptionByMonth?dateFrom=&dateTo="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SdmApi;

import java.io.File;
import java.util.*;

public class SdmApiExample {

    public static void main(String[] args) {

        SdmApi apiInstance = new SdmApi();
        Integer cocId = 56; // Integer | Contract object identifier
        date dateFrom = 2013-10-20; // date |
        date dateTo = 2013-10-20; // date |
        try {
            array[APIConsumptionCurve] result = apiInstance.getConsumption(cocId, dateFrom, dateTo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#getConsumption");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SdmApi;

public class SdmApiExample {

    public static void main(String[] args) {
        SdmApi apiInstance = new SdmApi();
        Integer cocId = 56; // Integer | Contract object identifier
        date dateFrom = 2013-10-20; // date |
        date dateTo = 2013-10-20; // date |
        try {
            array[APIConsumptionCurve] result = apiInstance.getConsumption(cocId, dateFrom, dateTo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#getConsumption");
            e.printStackTrace();
        }
    }
}
Integer *cocId = 56; // Contract object identifier
date *dateFrom = 2013-10-20; //
date *dateTo = 2013-10-20; //

SdmApi *apiInstance = [[SdmApi alloc] init];

// Retrieve consumption values for all curves of given cocId within dateFrom and dateTo.
[apiInstance getConsumptionWith:cocId
    dateFrom:dateFrom
    dateTo:dateTo
              completionHandler: ^(array[APIConsumptionCurve] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaSdmApi = require('empirica_sdm_api');

var api = new EmpiricaSdmApi.SdmApi()

var cocId = 56; // {Integer} Contract object identifier

var dateFrom = 2013-10-20; // {date}

var dateTo = 2013-10-20; // {date}


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumption(cocId, dateFrom, dateTo, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumptionExample
    {
        public void main()
        {

            var apiInstance = new SdmApi();
            var cocId = 56;  // Integer | Contract object identifier
            var dateFrom = 2013-10-20;  // date |
            var dateTo = 2013-10-20;  // date |

            try
            {
                // Retrieve consumption values for all curves of given cocId within dateFrom and dateTo.
                array[APIConsumptionCurve] result = apiInstance.getConsumption(cocId, dateFrom, dateTo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SdmApi.getConsumption: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SdmApi();
$cocId = 56; // Integer | Contract object identifier
$dateFrom = 2013-10-20; // date |
$dateTo = 2013-10-20; // date |

try {
    $result = $api_instance->getConsumption($cocId, $dateFrom, $dateTo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SdmApi->getConsumption: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SdmApi;

my $api_instance = WWW::SwaggerClient::SdmApi->new();
my $cocId = 56; # Integer | Contract object identifier
my $dateFrom = 2013-10-20; # date |
my $dateTo = 2013-10-20; # date |

eval {
    my $result = $api_instance->getConsumption(cocId => $cocId, dateFrom => $dateFrom, dateTo => $dateTo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SdmApi->getConsumption: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SdmApi()
cocId = 56 # Integer | Contract object identifier
dateFrom = 2013-10-20 # date |
dateTo = 2013-10-20 # date |

try:
    # Retrieve consumption values for all curves of given cocId within dateFrom and dateTo.
    api_response = api_instance.get_consumption(cocId, dateFrom, dateTo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SdmApi->getConsumption: %s\n" % e)

Parameters

Path parameters
Name Description
cocId*
Integer (int32)
Contract object identifier
Required
Query parameters
Name Description
dateFrom*
date (date)
Required
dateTo*
date (date)
Required

Responses

Status: 200 - successful operation


getValuesToDate

Retrieve consumption values for contract object of contract.


/api/sdm/seprom/{cocId}/consumption

Usage and SDK Samples

curl -X GET "https://localhost/sdm/services/rest/sdm/api/sdm/seprom/{cocId}/consumption?tariffication=&measureUnit=&dateFrom=&dateTo=&extrapolFlag=&bbId=&bbDateFrom=&bbDateTo="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SdmApi;

import java.io.File;
import java.util.*;

public class SdmApiExample {

    public static void main(String[] args) {

        SdmApi apiInstance = new SdmApi();
        Integer cocId = 56; // Integer | Contract object identifier
        String tariffication = tariffication_example; // String | Tariffication code
        String measureUnit = measureUnit_example; // String | Measurement unit code
        date dateFrom = 2013-10-20; // date |
        date dateTo = 2013-10-20; // date |
        String extrapolFlag = extrapolFlag_example; // String | Extrapolation flag
        Integer bbId = 56; // Integer | Locking billing basis
        date bbDateFrom = 2013-10-20; // date | Locking billing basis
        date bbDateTo = 2013-10-20; // date | Locking billing basis
        try {
            array[APIConsumptionValue] result = apiInstance.getValuesToDate(cocId, tariffication, measureUnit, dateFrom, dateTo, extrapolFlag, bbId, bbDateFrom, bbDateTo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#getValuesToDate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SdmApi;

public class SdmApiExample {

    public static void main(String[] args) {
        SdmApi apiInstance = new SdmApi();
        Integer cocId = 56; // Integer | Contract object identifier
        String tariffication = tariffication_example; // String | Tariffication code
        String measureUnit = measureUnit_example; // String | Measurement unit code
        date dateFrom = 2013-10-20; // date |
        date dateTo = 2013-10-20; // date |
        String extrapolFlag = extrapolFlag_example; // String | Extrapolation flag
        Integer bbId = 56; // Integer | Locking billing basis
        date bbDateFrom = 2013-10-20; // date | Locking billing basis
        date bbDateTo = 2013-10-20; // date | Locking billing basis
        try {
            array[APIConsumptionValue] result = apiInstance.getValuesToDate(cocId, tariffication, measureUnit, dateFrom, dateTo, extrapolFlag, bbId, bbDateFrom, bbDateTo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#getValuesToDate");
            e.printStackTrace();
        }
    }
}
Integer *cocId = 56; // Contract object identifier
String *tariffication = tariffication_example; // Tariffication code (optional)
String *measureUnit = measureUnit_example; // Measurement unit code (optional)
date *dateFrom = 2013-10-20; //  (optional)
date *dateTo = 2013-10-20; //  (optional)
String *extrapolFlag = extrapolFlag_example; // Extrapolation flag (optional)
Integer *bbId = 56; // Locking billing basis (optional)
date *bbDateFrom = 2013-10-20; // Locking billing basis (optional)
date *bbDateTo = 2013-10-20; // Locking billing basis (optional)

SdmApi *apiInstance = [[SdmApi alloc] init];

// Retrieve consumption values for contract object of contract.
[apiInstance getValuesToDateWith:cocId
    tariffication:tariffication
    measureUnit:measureUnit
    dateFrom:dateFrom
    dateTo:dateTo
    extrapolFlag:extrapolFlag
    bbId:bbId
    bbDateFrom:bbDateFrom
    bbDateTo:bbDateTo
              completionHandler: ^(array[APIConsumptionValue] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaSdmApi = require('empirica_sdm_api');

var api = new EmpiricaSdmApi.SdmApi()

var cocId = 56; // {Integer} Contract object identifier

var opts = {
  'tariffication': tariffication_example, // {String} Tariffication code
  'measureUnit': measureUnit_example, // {String} Measurement unit code
  'dateFrom': 2013-10-20, // {date}
  'dateTo': 2013-10-20, // {date}
  'extrapolFlag': extrapolFlag_example, // {String} Extrapolation flag
  'bbId': 56, // {Integer} Locking billing basis
  'bbDateFrom': 2013-10-20, // {date} Locking billing basis
  'bbDateTo': 2013-10-20 // {date} Locking billing basis
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getValuesToDate(cocId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getValuesToDateExample
    {
        public void main()
        {

            var apiInstance = new SdmApi();
            var cocId = 56;  // Integer | Contract object identifier
            var tariffication = tariffication_example;  // String | Tariffication code (optional)
            var measureUnit = measureUnit_example;  // String | Measurement unit code (optional)
            var dateFrom = 2013-10-20;  // date |  (optional)
            var dateTo = 2013-10-20;  // date |  (optional)
            var extrapolFlag = extrapolFlag_example;  // String | Extrapolation flag (optional)
            var bbId = 56;  // Integer | Locking billing basis (optional)
            var bbDateFrom = 2013-10-20;  // date | Locking billing basis (optional)
            var bbDateTo = 2013-10-20;  // date | Locking billing basis (optional)

            try
            {
                // Retrieve consumption values for contract object of contract.
                array[APIConsumptionValue] result = apiInstance.getValuesToDate(cocId, tariffication, measureUnit, dateFrom, dateTo, extrapolFlag, bbId, bbDateFrom, bbDateTo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SdmApi.getValuesToDate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SdmApi();
$cocId = 56; // Integer | Contract object identifier
$tariffication = tariffication_example; // String | Tariffication code
$measureUnit = measureUnit_example; // String | Measurement unit code
$dateFrom = 2013-10-20; // date |
$dateTo = 2013-10-20; // date |
$extrapolFlag = extrapolFlag_example; // String | Extrapolation flag
$bbId = 56; // Integer | Locking billing basis
$bbDateFrom = 2013-10-20; // date | Locking billing basis
$bbDateTo = 2013-10-20; // date | Locking billing basis

try {
    $result = $api_instance->getValuesToDate($cocId, $tariffication, $measureUnit, $dateFrom, $dateTo, $extrapolFlag, $bbId, $bbDateFrom, $bbDateTo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SdmApi->getValuesToDate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SdmApi;

my $api_instance = WWW::SwaggerClient::SdmApi->new();
my $cocId = 56; # Integer | Contract object identifier
my $tariffication = tariffication_example; # String | Tariffication code
my $measureUnit = measureUnit_example; # String | Measurement unit code
my $dateFrom = 2013-10-20; # date |
my $dateTo = 2013-10-20; # date |
my $extrapolFlag = extrapolFlag_example; # String | Extrapolation flag
my $bbId = 56; # Integer | Locking billing basis
my $bbDateFrom = 2013-10-20; # date | Locking billing basis
my $bbDateTo = 2013-10-20; # date | Locking billing basis

eval {
    my $result = $api_instance->getValuesToDate(cocId => $cocId, tariffication => $tariffication, measureUnit => $measureUnit, dateFrom => $dateFrom, dateTo => $dateTo, extrapolFlag => $extrapolFlag, bbId => $bbId, bbDateFrom => $bbDateFrom, bbDateTo => $bbDateTo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SdmApi->getValuesToDate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SdmApi()
cocId = 56 # Integer | Contract object identifier
tariffication = tariffication_example # String | Tariffication code (optional)
measureUnit = measureUnit_example # String | Measurement unit code (optional)
dateFrom = 2013-10-20 # date |  (optional)
dateTo = 2013-10-20 # date |  (optional)
extrapolFlag = extrapolFlag_example # String | Extrapolation flag (optional)
bbId = 56 # Integer | Locking billing basis (optional)
bbDateFrom = 2013-10-20 # date | Locking billing basis (optional)
bbDateTo = 2013-10-20 # date | Locking billing basis (optional)

try:
    # Retrieve consumption values for contract object of contract.
    api_response = api_instance.get_values_to_date(cocId, tariffication=tariffication, measureUnit=measureUnit, dateFrom=dateFrom, dateTo=dateTo, extrapolFlag=extrapolFlag, bbId=bbId, bbDateFrom=bbDateFrom, bbDateTo=bbDateTo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SdmApi->getValuesToDate: %s\n" % e)

Parameters

Path parameters
Name Description
cocId*
Integer (int32)
Contract object identifier
Required
Query parameters
Name Description
tariffication
String
Tariffication code
measureUnit
String
Measurement unit code
dateFrom
date (date)
dateTo
date (date)
extrapolFlag
String
Extrapolation flag
bbId
Integer (int32)
Locking billing basis
bbDateFrom
date (date)
Locking billing basis
bbDateTo
date (date)
Locking billing basis

Responses

Status: 200 - successful operation


getValuesToDateMax

Retrieve maximum consumption values for contract object of contract.


/api/sdm/seprom/{cocId}/consumptionMax

Usage and SDK Samples

curl -X GET "https://localhost/sdm/services/rest/sdm/api/sdm/seprom/{cocId}/consumptionMax?tariffication=&measureUnit=&countMax=&maxDayCount=&dateFrom=&dateTo=&extrapolFlag=&bbId=&bbDateFrom=&bbDateTo="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SdmApi;

import java.io.File;
import java.util.*;

public class SdmApiExample {

    public static void main(String[] args) {

        SdmApi apiInstance = new SdmApi();
        Integer cocId = 56; // Integer | Contract object identifier
        String tariffication = tariffication_example; // String | Tariffication code
        String measureUnit = measureUnit_example; // String | Measurement unit code
        Integer countMax = 56; // Integer |
        BigDecimal maxDayCount = 3.4; // BigDecimal |
        date dateFrom = 2013-10-20; // date |
        date dateTo = 2013-10-20; // date |
        String extrapolFlag = extrapolFlag_example; // String | Extrapolation flag
        Integer bbId = 56; // Integer | Locking billing basis
        date bbDateFrom = 2013-10-20; // date | Locking billing basis
        date bbDateTo = 2013-10-20; // date | Locking billing basis
        try {
            array[APIConsumptionValue] result = apiInstance.getValuesToDateMax(cocId, tariffication, measureUnit, countMax, maxDayCount, dateFrom, dateTo, extrapolFlag, bbId, bbDateFrom, bbDateTo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#getValuesToDateMax");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SdmApi;

public class SdmApiExample {

    public static void main(String[] args) {
        SdmApi apiInstance = new SdmApi();
        Integer cocId = 56; // Integer | Contract object identifier
        String tariffication = tariffication_example; // String | Tariffication code
        String measureUnit = measureUnit_example; // String | Measurement unit code
        Integer countMax = 56; // Integer |
        BigDecimal maxDayCount = 3.4; // BigDecimal |
        date dateFrom = 2013-10-20; // date |
        date dateTo = 2013-10-20; // date |
        String extrapolFlag = extrapolFlag_example; // String | Extrapolation flag
        Integer bbId = 56; // Integer | Locking billing basis
        date bbDateFrom = 2013-10-20; // date | Locking billing basis
        date bbDateTo = 2013-10-20; // date | Locking billing basis
        try {
            array[APIConsumptionValue] result = apiInstance.getValuesToDateMax(cocId, tariffication, measureUnit, countMax, maxDayCount, dateFrom, dateTo, extrapolFlag, bbId, bbDateFrom, bbDateTo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#getValuesToDateMax");
            e.printStackTrace();
        }
    }
}
Integer *cocId = 56; // Contract object identifier
String *tariffication = tariffication_example; // Tariffication code (optional)
String *measureUnit = measureUnit_example; // Measurement unit code (optional)
Integer *countMax = 56; //  (optional)
BigDecimal *maxDayCount = 3.4; //  (optional)
date *dateFrom = 2013-10-20; //  (optional)
date *dateTo = 2013-10-20; //  (optional)
String *extrapolFlag = extrapolFlag_example; // Extrapolation flag (optional)
Integer *bbId = 56; // Locking billing basis (optional)
date *bbDateFrom = 2013-10-20; // Locking billing basis (optional)
date *bbDateTo = 2013-10-20; // Locking billing basis (optional)

SdmApi *apiInstance = [[SdmApi alloc] init];

// Retrieve maximum consumption values for contract object of contract.
[apiInstance getValuesToDateMaxWith:cocId
    tariffication:tariffication
    measureUnit:measureUnit
    countMax:countMax
    maxDayCount:maxDayCount
    dateFrom:dateFrom
    dateTo:dateTo
    extrapolFlag:extrapolFlag
    bbId:bbId
    bbDateFrom:bbDateFrom
    bbDateTo:bbDateTo
              completionHandler: ^(array[APIConsumptionValue] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaSdmApi = require('empirica_sdm_api');

var api = new EmpiricaSdmApi.SdmApi()

var cocId = 56; // {Integer} Contract object identifier

var opts = {
  'tariffication': tariffication_example, // {String} Tariffication code
  'measureUnit': measureUnit_example, // {String} Measurement unit code
  'countMax': 56, // {Integer}
  'maxDayCount': 3.4, // {BigDecimal}
  'dateFrom': 2013-10-20, // {date}
  'dateTo': 2013-10-20, // {date}
  'extrapolFlag': extrapolFlag_example, // {String} Extrapolation flag
  'bbId': 56, // {Integer} Locking billing basis
  'bbDateFrom': 2013-10-20, // {date} Locking billing basis
  'bbDateTo': 2013-10-20 // {date} Locking billing basis
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getValuesToDateMax(cocId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getValuesToDateMaxExample
    {
        public void main()
        {

            var apiInstance = new SdmApi();
            var cocId = 56;  // Integer | Contract object identifier
            var tariffication = tariffication_example;  // String | Tariffication code (optional)
            var measureUnit = measureUnit_example;  // String | Measurement unit code (optional)
            var countMax = 56;  // Integer |  (optional)
            var maxDayCount = 3.4;  // BigDecimal |  (optional)
            var dateFrom = 2013-10-20;  // date |  (optional)
            var dateTo = 2013-10-20;  // date |  (optional)
            var extrapolFlag = extrapolFlag_example;  // String | Extrapolation flag (optional)
            var bbId = 56;  // Integer | Locking billing basis (optional)
            var bbDateFrom = 2013-10-20;  // date | Locking billing basis (optional)
            var bbDateTo = 2013-10-20;  // date | Locking billing basis (optional)

            try
            {
                // Retrieve maximum consumption values for contract object of contract.
                array[APIConsumptionValue] result = apiInstance.getValuesToDateMax(cocId, tariffication, measureUnit, countMax, maxDayCount, dateFrom, dateTo, extrapolFlag, bbId, bbDateFrom, bbDateTo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SdmApi.getValuesToDateMax: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SdmApi();
$cocId = 56; // Integer | Contract object identifier
$tariffication = tariffication_example; // String | Tariffication code
$measureUnit = measureUnit_example; // String | Measurement unit code
$countMax = 56; // Integer |
$maxDayCount = 3.4; // BigDecimal |
$dateFrom = 2013-10-20; // date |
$dateTo = 2013-10-20; // date |
$extrapolFlag = extrapolFlag_example; // String | Extrapolation flag
$bbId = 56; // Integer | Locking billing basis
$bbDateFrom = 2013-10-20; // date | Locking billing basis
$bbDateTo = 2013-10-20; // date | Locking billing basis

try {
    $result = $api_instance->getValuesToDateMax($cocId, $tariffication, $measureUnit, $countMax, $maxDayCount, $dateFrom, $dateTo, $extrapolFlag, $bbId, $bbDateFrom, $bbDateTo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SdmApi->getValuesToDateMax: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SdmApi;

my $api_instance = WWW::SwaggerClient::SdmApi->new();
my $cocId = 56; # Integer | Contract object identifier
my $tariffication = tariffication_example; # String | Tariffication code
my $measureUnit = measureUnit_example; # String | Measurement unit code
my $countMax = 56; # Integer |
my $maxDayCount = 3.4; # BigDecimal |
my $dateFrom = 2013-10-20; # date |
my $dateTo = 2013-10-20; # date |
my $extrapolFlag = extrapolFlag_example; # String | Extrapolation flag
my $bbId = 56; # Integer | Locking billing basis
my $bbDateFrom = 2013-10-20; # date | Locking billing basis
my $bbDateTo = 2013-10-20; # date | Locking billing basis

eval {
    my $result = $api_instance->getValuesToDateMax(cocId => $cocId, tariffication => $tariffication, measureUnit => $measureUnit, countMax => $countMax, maxDayCount => $maxDayCount, dateFrom => $dateFrom, dateTo => $dateTo, extrapolFlag => $extrapolFlag, bbId => $bbId, bbDateFrom => $bbDateFrom, bbDateTo => $bbDateTo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SdmApi->getValuesToDateMax: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SdmApi()
cocId = 56 # Integer | Contract object identifier
tariffication = tariffication_example # String | Tariffication code (optional)
measureUnit = measureUnit_example # String | Measurement unit code (optional)
countMax = 56 # Integer |  (optional)
maxDayCount = 3.4 # BigDecimal |  (optional)
dateFrom = 2013-10-20 # date |  (optional)
dateTo = 2013-10-20 # date |  (optional)
extrapolFlag = extrapolFlag_example # String | Extrapolation flag (optional)
bbId = 56 # Integer | Locking billing basis (optional)
bbDateFrom = 2013-10-20 # date | Locking billing basis (optional)
bbDateTo = 2013-10-20 # date | Locking billing basis (optional)

try:
    # Retrieve maximum consumption values for contract object of contract.
    api_response = api_instance.get_values_to_date_max(cocId, tariffication=tariffication, measureUnit=measureUnit, countMax=countMax, maxDayCount=maxDayCount, dateFrom=dateFrom, dateTo=dateTo, extrapolFlag=extrapolFlag, bbId=bbId, bbDateFrom=bbDateFrom, bbDateTo=bbDateTo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SdmApi->getValuesToDateMax: %s\n" % e)

Parameters

Path parameters
Name Description
cocId*
Integer (int32)
Contract object identifier
Required
Query parameters
Name Description
tariffication
String
Tariffication code
measureUnit
String
Measurement unit code
countMax
Integer (int32)
maxDayCount
BigDecimal
dateFrom
date (date)
dateTo
date (date)
extrapolFlag
String
Extrapolation flag
bbId
Integer (int32)
Locking billing basis
bbDateFrom
date (date)
Locking billing basis
bbDateTo
date (date)
Locking billing basis

Responses

Status: 200 - successful operation


registerExternalMessage

Register external message into SDM and process it.


/api/sdm/messages

Usage and SDK Samples

curl -X POST "https://localhost/sdm/services/rest/sdm/api/sdm/messages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SdmApi;

import java.io.File;
import java.util.*;

public class SdmApiExample {

    public static void main(String[] args) {

        SdmApi apiInstance = new SdmApi();
        APIExternalSourceMessage body = ; // APIExternalSourceMessage | Message from external source.
        try {
            apiInstance.registerExternalMessage(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#registerExternalMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SdmApi;

public class SdmApiExample {

    public static void main(String[] args) {
        SdmApi apiInstance = new SdmApi();
        APIExternalSourceMessage body = ; // APIExternalSourceMessage | Message from external source.
        try {
            apiInstance.registerExternalMessage(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SdmApi#registerExternalMessage");
            e.printStackTrace();
        }
    }
}
APIExternalSourceMessage *body = ; // Message from external source. (optional)

SdmApi *apiInstance = [[SdmApi alloc] init];

// Register external message into SDM and process it.
[apiInstance registerExternalMessageWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaSdmApi = require('empirica_sdm_api');

var api = new EmpiricaSdmApi.SdmApi()

var opts = {
  'body':  // {APIExternalSourceMessage} Message from external source.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.registerExternalMessage(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class registerExternalMessageExample
    {
        public void main()
        {

            var apiInstance = new SdmApi();
            var body = new APIExternalSourceMessage(); // APIExternalSourceMessage | Message from external source. (optional)

            try
            {
                // Register external message into SDM and process it.
                apiInstance.registerExternalMessage(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SdmApi.registerExternalMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SdmApi();
$body = ; // APIExternalSourceMessage | Message from external source.

try {
    $api_instance->registerExternalMessage($body);
} catch (Exception $e) {
    echo 'Exception when calling SdmApi->registerExternalMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SdmApi;

my $api_instance = WWW::SwaggerClient::SdmApi->new();
my $body = WWW::SwaggerClient::Object::APIExternalSourceMessage->new(); # APIExternalSourceMessage | Message from external source.

eval {
    $api_instance->registerExternalMessage(body => $body);
};
if ($@) {
    warn "Exception when calling SdmApi->registerExternalMessage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SdmApi()
body =  # APIExternalSourceMessage | Message from external source. (optional)

try:
    # Register external message into SDM and process it.
    api_instance.register_external_message(body=body)
except ApiException as e:
    print("Exception when calling SdmApi->registerExternalMessage: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: default - successful operation