Empirica Core API

CcabusinessPartner

getBusinessPartnerAccounts

Retrieve all business partner's accounts valid to date


/api/cca/bp/{id}/accounts

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/cca/bp/{id}/accounts?date="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcabusinessPartnerApi;

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

public class CcabusinessPartnerApiExample {

    public static void main(String[] args) {
        
        CcabusinessPartnerApi apiInstance = new CcabusinessPartnerApi();
        Integer id = 56; // Integer | Business partner identifier
        date date = 2013-10-20; // date | Date for which accounts should be valid
        try {
            array[APIBankAccount] result = apiInstance.getBusinessPartnerAccounts(id, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcabusinessPartnerApi#getBusinessPartnerAccounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcabusinessPartnerApi;

public class CcabusinessPartnerApiExample {

    public static void main(String[] args) {
        CcabusinessPartnerApi apiInstance = new CcabusinessPartnerApi();
        Integer id = 56; // Integer | Business partner identifier
        date date = 2013-10-20; // date | Date for which accounts should be valid
        try {
            array[APIBankAccount] result = apiInstance.getBusinessPartnerAccounts(id, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcabusinessPartnerApi#getBusinessPartnerAccounts");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Business partner identifier
date *date = 2013-10-20; // Date for which accounts should be valid

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

// Retrieve all business partner's accounts valid to date
[apiInstance getBusinessPartnerAccountsWith:id
    date:date
              completionHandler: ^(array[APIBankAccount] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcabusinessPartnerApi()

var id = 56; // {Integer} Business partner identifier

var date = 2013-10-20; // {date} Date for which accounts should be valid


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

namespace Example
{
    public class getBusinessPartnerAccountsExample
    {
        public void main()
        {
            
            var apiInstance = new CcabusinessPartnerApi();
            var id = 56;  // Integer | Business partner identifier
            var date = 2013-10-20;  // date | Date for which accounts should be valid

            try
            {
                // Retrieve all business partner's accounts valid to date
                array[APIBankAccount] result = apiInstance.getBusinessPartnerAccounts(id, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcabusinessPartnerApi.getBusinessPartnerAccounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcabusinessPartnerApi();
$id = 56; // Integer | Business partner identifier
$date = 2013-10-20; // date | Date for which accounts should be valid

try {
    $result = $api_instance->getBusinessPartnerAccounts($id, $date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcabusinessPartnerApi->getBusinessPartnerAccounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcabusinessPartnerApi;

my $api_instance = WWW::SwaggerClient::CcabusinessPartnerApi->new();
my $id = 56; # Integer | Business partner identifier
my $date = 2013-10-20; # date | Date for which accounts should be valid

eval { 
    my $result = $api_instance->getBusinessPartnerAccounts(id => $id, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcabusinessPartnerApi->getBusinessPartnerAccounts: $@\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.CcabusinessPartnerApi()
id = 56 # Integer | Business partner identifier
date = 2013-10-20 # date | Date for which accounts should be valid

try: 
    # Retrieve all business partner's accounts valid to date
    api_response = api_instance.get_business_partner_accounts(id, date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcabusinessPartnerApi->getBusinessPartnerAccounts: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Business partner identifier
Required
Query parameters
Name Description
date*
date (date)
Date for which accounts should be valid
Required

Responses

Status: 200 - successful operation


getBusinessPartnerAddress

Retrieve business partner actual address (contact or permanent)


/api/cca/bp/{id}/address

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/cca/bp/{id}/address?perm="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcabusinessPartnerApi;

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

public class CcabusinessPartnerApiExample {

    public static void main(String[] args) {
        
        CcabusinessPartnerApi apiInstance = new CcabusinessPartnerApi();
        Integer id = 56; // Integer | Business partner identifier
        Boolean perm = true; // Boolean | Flag if permanent address should be retrieved instead of contact address
        try {
            APIAddress result = apiInstance.getBusinessPartnerAddress(id, perm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcabusinessPartnerApi#getBusinessPartnerAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcabusinessPartnerApi;

public class CcabusinessPartnerApiExample {

    public static void main(String[] args) {
        CcabusinessPartnerApi apiInstance = new CcabusinessPartnerApi();
        Integer id = 56; // Integer | Business partner identifier
        Boolean perm = true; // Boolean | Flag if permanent address should be retrieved instead of contact address
        try {
            APIAddress result = apiInstance.getBusinessPartnerAddress(id, perm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcabusinessPartnerApi#getBusinessPartnerAddress");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Business partner identifier
Boolean *perm = true; // Flag if permanent address should be retrieved instead of contact address

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

// Retrieve business partner actual address (contact or permanent)
[apiInstance getBusinessPartnerAddressWith:id
    perm:perm
              completionHandler: ^(APIAddress output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcabusinessPartnerApi()

var id = 56; // {Integer} Business partner identifier

var perm = true; // {Boolean} Flag if permanent address should be retrieved instead of contact address


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

namespace Example
{
    public class getBusinessPartnerAddressExample
    {
        public void main()
        {
            
            var apiInstance = new CcabusinessPartnerApi();
            var id = 56;  // Integer | Business partner identifier
            var perm = true;  // Boolean | Flag if permanent address should be retrieved instead of contact address

            try
            {
                // Retrieve business partner actual address (contact or permanent)
                APIAddress result = apiInstance.getBusinessPartnerAddress(id, perm);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcabusinessPartnerApi.getBusinessPartnerAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcabusinessPartnerApi();
$id = 56; // Integer | Business partner identifier
$perm = true; // Boolean | Flag if permanent address should be retrieved instead of contact address

try {
    $result = $api_instance->getBusinessPartnerAddress($id, $perm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcabusinessPartnerApi->getBusinessPartnerAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcabusinessPartnerApi;

my $api_instance = WWW::SwaggerClient::CcabusinessPartnerApi->new();
my $id = 56; # Integer | Business partner identifier
my $perm = true; # Boolean | Flag if permanent address should be retrieved instead of contact address

eval { 
    my $result = $api_instance->getBusinessPartnerAddress(id => $id, perm => $perm);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcabusinessPartnerApi->getBusinessPartnerAddress: $@\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.CcabusinessPartnerApi()
id = 56 # Integer | Business partner identifier
perm = true # Boolean | Flag if permanent address should be retrieved instead of contact address

try: 
    # Retrieve business partner actual address (contact or permanent)
    api_response = api_instance.get_business_partner_address(id, perm)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcabusinessPartnerApi->getBusinessPartnerAddress: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Business partner identifier
Required
Query parameters
Name Description
perm*
Boolean
Flag if permanent address should be retrieved instead of contact address
Required

Responses

Status: 200 - successful operation


getBusinessPartnerAddresses

Retrieve all business partner's adresses


/api/cca/bp/{id}/addresses

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/cca/bp/{id}/addresses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcabusinessPartnerApi;

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

public class CcabusinessPartnerApiExample {

    public static void main(String[] args) {
        
        CcabusinessPartnerApi apiInstance = new CcabusinessPartnerApi();
        Integer id = 56; // Integer | Business partner identifier
        try {
            array[APIAddress] result = apiInstance.getBusinessPartnerAddresses(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcabusinessPartnerApi#getBusinessPartnerAddresses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcabusinessPartnerApi;

public class CcabusinessPartnerApiExample {

    public static void main(String[] args) {
        CcabusinessPartnerApi apiInstance = new CcabusinessPartnerApi();
        Integer id = 56; // Integer | Business partner identifier
        try {
            array[APIAddress] result = apiInstance.getBusinessPartnerAddresses(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcabusinessPartnerApi#getBusinessPartnerAddresses");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Business partner identifier

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

// Retrieve all business partner's adresses
[apiInstance getBusinessPartnerAddressesWith:id
              completionHandler: ^(array[APIAddress] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcabusinessPartnerApi()

var id = 56; // {Integer} Business partner identifier


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

namespace Example
{
    public class getBusinessPartnerAddressesExample
    {
        public void main()
        {
            
            var apiInstance = new CcabusinessPartnerApi();
            var id = 56;  // Integer | Business partner identifier

            try
            {
                // Retrieve all business partner's adresses
                array[APIAddress] result = apiInstance.getBusinessPartnerAddresses(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcabusinessPartnerApi.getBusinessPartnerAddresses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcabusinessPartnerApi();
$id = 56; // Integer | Business partner identifier

try {
    $result = $api_instance->getBusinessPartnerAddresses($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcabusinessPartnerApi->getBusinessPartnerAddresses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcabusinessPartnerApi;

my $api_instance = WWW::SwaggerClient::CcabusinessPartnerApi->new();
my $id = 56; # Integer | Business partner identifier

eval { 
    my $result = $api_instance->getBusinessPartnerAddresses(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcabusinessPartnerApi->getBusinessPartnerAddresses: $@\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.CcabusinessPartnerApi()
id = 56 # Integer | Business partner identifier

try: 
    # Retrieve all business partner's adresses
    api_response = api_instance.get_business_partner_addresses(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcabusinessPartnerApi->getBusinessPartnerAddresses: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Business partner identifier
Required

Responses

Status: 200 - successful operation


getBusinessPartnerContacts

Retrieve all business partner's contacts valid to date


/api/cca/bp/{id}/contacts

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/cca/bp/{id}/contacts?date="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcabusinessPartnerApi;

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

public class CcabusinessPartnerApiExample {

    public static void main(String[] args) {
        
        CcabusinessPartnerApi apiInstance = new CcabusinessPartnerApi();
        Integer id = 56; // Integer | Business partner identifier
        date date = 2013-10-20; // date | Date for which contacts should be valid
        try {
            array[APIContact] result = apiInstance.getBusinessPartnerContacts(id, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcabusinessPartnerApi#getBusinessPartnerContacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcabusinessPartnerApi;

public class CcabusinessPartnerApiExample {

    public static void main(String[] args) {
        CcabusinessPartnerApi apiInstance = new CcabusinessPartnerApi();
        Integer id = 56; // Integer | Business partner identifier
        date date = 2013-10-20; // date | Date for which contacts should be valid
        try {
            array[APIContact] result = apiInstance.getBusinessPartnerContacts(id, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcabusinessPartnerApi#getBusinessPartnerContacts");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Business partner identifier
date *date = 2013-10-20; // Date for which contacts should be valid

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

// Retrieve all business partner's contacts valid to date
[apiInstance getBusinessPartnerContactsWith:id
    date:date
              completionHandler: ^(array[APIContact] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcabusinessPartnerApi()

var id = 56; // {Integer} Business partner identifier

var date = 2013-10-20; // {date} Date for which contacts should be valid


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

namespace Example
{
    public class getBusinessPartnerContactsExample
    {
        public void main()
        {
            
            var apiInstance = new CcabusinessPartnerApi();
            var id = 56;  // Integer | Business partner identifier
            var date = 2013-10-20;  // date | Date for which contacts should be valid

            try
            {
                // Retrieve all business partner's contacts valid to date
                array[APIContact] result = apiInstance.getBusinessPartnerContacts(id, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcabusinessPartnerApi.getBusinessPartnerContacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcabusinessPartnerApi();
$id = 56; // Integer | Business partner identifier
$date = 2013-10-20; // date | Date for which contacts should be valid

try {
    $result = $api_instance->getBusinessPartnerContacts($id, $date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcabusinessPartnerApi->getBusinessPartnerContacts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcabusinessPartnerApi;

my $api_instance = WWW::SwaggerClient::CcabusinessPartnerApi->new();
my $id = 56; # Integer | Business partner identifier
my $date = 2013-10-20; # date | Date for which contacts should be valid

eval { 
    my $result = $api_instance->getBusinessPartnerContacts(id => $id, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcabusinessPartnerApi->getBusinessPartnerContacts: $@\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.CcabusinessPartnerApi()
id = 56 # Integer | Business partner identifier
date = 2013-10-20 # date | Date for which contacts should be valid

try: 
    # Retrieve all business partner's contacts valid to date
    api_response = api_instance.get_business_partner_contacts(id, date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcabusinessPartnerApi->getBusinessPartnerContacts: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Business partner identifier
Required
Query parameters
Name Description
date*
date (date)
Date for which contacts should be valid
Required

Responses

Status: 200 - successful operation


getBusinessPartnerIdentifier

Map business partner registration number to identifier


/api/cca/bp/id/{bpNumber}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/cca/bp/id/{bpNumber}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcabusinessPartnerApi;

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

public class CcabusinessPartnerApiExample {

    public static void main(String[] args) {
        
        CcabusinessPartnerApi apiInstance = new CcabusinessPartnerApi();
        String bpNumber = bpNumber_example; // String | Business partner registration number
        try {
            'Integer' result = apiInstance.getBusinessPartnerIdentifier(bpNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcabusinessPartnerApi#getBusinessPartnerIdentifier");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcabusinessPartnerApi;

public class CcabusinessPartnerApiExample {

    public static void main(String[] args) {
        CcabusinessPartnerApi apiInstance = new CcabusinessPartnerApi();
        String bpNumber = bpNumber_example; // String | Business partner registration number
        try {
            'Integer' result = apiInstance.getBusinessPartnerIdentifier(bpNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcabusinessPartnerApi#getBusinessPartnerIdentifier");
            e.printStackTrace();
        }
    }
}
String *bpNumber = bpNumber_example; // Business partner registration number

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

// Map business partner registration number to identifier
[apiInstance getBusinessPartnerIdentifierWith:bpNumber
              completionHandler: ^('Integer' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcabusinessPartnerApi()

var bpNumber = bpNumber_example; // {String} Business partner registration number


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

namespace Example
{
    public class getBusinessPartnerIdentifierExample
    {
        public void main()
        {
            
            var apiInstance = new CcabusinessPartnerApi();
            var bpNumber = bpNumber_example;  // String | Business partner registration number

            try
            {
                // Map business partner registration number to identifier
                'Integer' result = apiInstance.getBusinessPartnerIdentifier(bpNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcabusinessPartnerApi.getBusinessPartnerIdentifier: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcabusinessPartnerApi();
$bpNumber = bpNumber_example; // String | Business partner registration number

try {
    $result = $api_instance->getBusinessPartnerIdentifier($bpNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcabusinessPartnerApi->getBusinessPartnerIdentifier: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcabusinessPartnerApi;

my $api_instance = WWW::SwaggerClient::CcabusinessPartnerApi->new();
my $bpNumber = bpNumber_example; # String | Business partner registration number

eval { 
    my $result = $api_instance->getBusinessPartnerIdentifier(bpNumber => $bpNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcabusinessPartnerApi->getBusinessPartnerIdentifier: $@\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.CcabusinessPartnerApi()
bpNumber = bpNumber_example # String | Business partner registration number

try: 
    # Map business partner registration number to identifier
    api_response = api_instance.get_business_partner_identifier(bpNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcabusinessPartnerApi->getBusinessPartnerIdentifier: %s\n" % e)

Parameters

Path parameters
Name Description
bpNumber*
String
Business partner registration number
Required

Responses

Status: 200 - successful operation


Ccacalendar

addWorkDays

Add specified number of working days to date from


/api/cca/calendar/addWorkDays

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/cca/calendar/addWorkDays?from=&days2add="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcacalendarApi;

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

public class CcacalendarApiExample {

    public static void main(String[] args) {
        
        CcacalendarApi apiInstance = new CcacalendarApi();
        date from = 2013-10-20; // date | Start date
        Integer days2add = 56; // Integer | Number of working days to add
        try {
            'Date' result = apiInstance.addWorkDays(from, days2add);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcacalendarApi#addWorkDays");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcacalendarApi;

public class CcacalendarApiExample {

    public static void main(String[] args) {
        CcacalendarApi apiInstance = new CcacalendarApi();
        date from = 2013-10-20; // date | Start date
        Integer days2add = 56; // Integer | Number of working days to add
        try {
            'Date' result = apiInstance.addWorkDays(from, days2add);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcacalendarApi#addWorkDays");
            e.printStackTrace();
        }
    }
}
date *from = 2013-10-20; // Start date
Integer *days2add = 56; // Number of working days to add

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

// Add specified number of working days to date from
[apiInstance addWorkDaysWith:from
    days2add:days2add
              completionHandler: ^('Date' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcacalendarApi()

var from = 2013-10-20; // {date} Start date

var days2add = 56; // {Integer} Number of working days to add


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

namespace Example
{
    public class addWorkDaysExample
    {
        public void main()
        {
            
            var apiInstance = new CcacalendarApi();
            var from = 2013-10-20;  // date | Start date
            var days2add = 56;  // Integer | Number of working days to add

            try
            {
                // Add specified number of working days to date from
                'Date' result = apiInstance.addWorkDays(from, days2add);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcacalendarApi.addWorkDays: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcacalendarApi();
$from = 2013-10-20; // date | Start date
$days2add = 56; // Integer | Number of working days to add

try {
    $result = $api_instance->addWorkDays($from, $days2add);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcacalendarApi->addWorkDays: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcacalendarApi;

my $api_instance = WWW::SwaggerClient::CcacalendarApi->new();
my $from = 2013-10-20; # date | Start date
my $days2add = 56; # Integer | Number of working days to add

eval { 
    my $result = $api_instance->addWorkDays(from => $from, days2add => $days2add);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcacalendarApi->addWorkDays: $@\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.CcacalendarApi()
from = 2013-10-20 # date | Start date
days2add = 56 # Integer | Number of working days to add

try: 
    # Add specified number of working days to date from
    api_response = api_instance.add_work_days(from, days2add)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcacalendarApi->addWorkDays: %s\n" % e)

Parameters

Query parameters
Name Description
from*
date (date)
Start date
Required
days2add*
Integer (int32)
Number of working days to add
Required

Responses

Status: 200 - successful operation


Ccaevents

registerEvent

Register event for subsequent processing


/api/cca/events/register

Usage and SDK Samples

curl -X POST "https://localhost/core/services/rest/core/api/cca/events/register"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaeventsApi;

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

public class CcaeventsApiExample {

    public static void main(String[] args) {
        
        CcaeventsApi apiInstance = new CcaeventsApi();
        APIEvent body = ; // APIEvent | Event to be registered
        try {
            apiInstance.registerEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaeventsApi#registerEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaeventsApi;

public class CcaeventsApiExample {

    public static void main(String[] args) {
        CcaeventsApi apiInstance = new CcaeventsApi();
        APIEvent body = ; // APIEvent | Event to be registered
        try {
            apiInstance.registerEvent(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaeventsApi#registerEvent");
            e.printStackTrace();
        }
    }
}
APIEvent *body = ; // Event to be registered (optional)

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

// Register event for subsequent processing
[apiInstance registerEventWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaeventsApi()

var opts = { 
  'body':  // {APIEvent} Event to be registered
};

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

namespace Example
{
    public class registerEventExample
    {
        public void main()
        {
            
            var apiInstance = new CcaeventsApi();
            var body = new APIEvent(); // APIEvent | Event to be registered (optional) 

            try
            {
                // Register event for subsequent processing
                apiInstance.registerEvent(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaeventsApi.registerEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaeventsApi();
$body = ; // APIEvent | Event to be registered

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

my $api_instance = WWW::SwaggerClient::CcaeventsApi->new();
my $body = WWW::SwaggerClient::Object::APIEvent->new(); # APIEvent | Event to be registered

eval { 
    $api_instance->registerEvent(body => $body);
};
if ($@) {
    warn "Exception when calling CcaeventsApi->registerEvent: $@\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.CcaeventsApi()
body =  # APIEvent | Event to be registered (optional)

try: 
    # Register event for subsequent processing
    api_instance.register_event(body=body)
except ApiException as e:
    print("Exception when calling CcaeventsApi->registerEvent: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: default - successful operation


Ccaprincipals

getPrincipal

Retrieve principal of specified identifier


/api/cca/principals/principal/{id}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/cca/principals/principal/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaprincipalsApi;

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

public class CcaprincipalsApiExample {

    public static void main(String[] args) {
        
        CcaprincipalsApi apiInstance = new CcaprincipalsApi();
        Integer id = 56; // Integer | Principal identifier
        try {
            APIPrincipal result = apiInstance.getPrincipal(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaprincipalsApi#getPrincipal");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaprincipalsApi;

public class CcaprincipalsApiExample {

    public static void main(String[] args) {
        CcaprincipalsApi apiInstance = new CcaprincipalsApi();
        Integer id = 56; // Integer | Principal identifier
        try {
            APIPrincipal result = apiInstance.getPrincipal(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaprincipalsApi#getPrincipal");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Principal identifier

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

// Retrieve principal of specified identifier
[apiInstance getPrincipalWith:id
              completionHandler: ^(APIPrincipal output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaprincipalsApi()

var id = 56; // {Integer} Principal identifier


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

namespace Example
{
    public class getPrincipalExample
    {
        public void main()
        {
            
            var apiInstance = new CcaprincipalsApi();
            var id = 56;  // Integer | Principal identifier

            try
            {
                // Retrieve principal of specified identifier
                APIPrincipal result = apiInstance.getPrincipal(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaprincipalsApi.getPrincipal: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaprincipalsApi();
$id = 56; // Integer | Principal identifier

try {
    $result = $api_instance->getPrincipal($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaprincipalsApi->getPrincipal: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaprincipalsApi;

my $api_instance = WWW::SwaggerClient::CcaprincipalsApi->new();
my $id = 56; # Integer | Principal identifier

eval { 
    my $result = $api_instance->getPrincipal(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaprincipalsApi->getPrincipal: $@\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.CcaprincipalsApi()
id = 56 # Integer | Principal identifier

try: 
    # Retrieve principal of specified identifier
    api_response = api_instance.get_principal(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaprincipalsApi->getPrincipal: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Principal identifier
Required

Responses

Status: 200 - successful operation


getPrincipals

Retrieve principal of speficied type valid for date


/api/cca/principals/principals/{type}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/cca/principals/principals/{type}?date="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaprincipalsApi;

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

public class CcaprincipalsApiExample {

    public static void main(String[] args) {
        
        CcaprincipalsApi apiInstance = new CcaprincipalsApi();
        String type = type_example; // String | Principal type (one of USER, ROLE)
        date date = 2013-10-20; // date | Validity date
        try {
            array[APIPrincipal] result = apiInstance.getPrincipals(type, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaprincipalsApi#getPrincipals");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaprincipalsApi;

public class CcaprincipalsApiExample {

    public static void main(String[] args) {
        CcaprincipalsApi apiInstance = new CcaprincipalsApi();
        String type = type_example; // String | Principal type (one of USER, ROLE)
        date date = 2013-10-20; // date | Validity date
        try {
            array[APIPrincipal] result = apiInstance.getPrincipals(type, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaprincipalsApi#getPrincipals");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // Principal type (one of USER, ROLE)
date *date = 2013-10-20; // Validity date

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

// Retrieve principal of speficied type valid for date
[apiInstance getPrincipalsWith:type
    date:date
              completionHandler: ^(array[APIPrincipal] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaprincipalsApi()

var type = type_example; // {String} Principal type (one of USER, ROLE)

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


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

namespace Example
{
    public class getPrincipalsExample
    {
        public void main()
        {
            
            var apiInstance = new CcaprincipalsApi();
            var type = type_example;  // String | Principal type (one of USER, ROLE)
            var date = 2013-10-20;  // date | Validity date

            try
            {
                // Retrieve principal of speficied type valid for date
                array[APIPrincipal] result = apiInstance.getPrincipals(type, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaprincipalsApi.getPrincipals: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaprincipalsApi();
$type = type_example; // String | Principal type (one of USER, ROLE)
$date = 2013-10-20; // date | Validity date

try {
    $result = $api_instance->getPrincipals($type, $date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaprincipalsApi->getPrincipals: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaprincipalsApi;

my $api_instance = WWW::SwaggerClient::CcaprincipalsApi->new();
my $type = type_example; # String | Principal type (one of USER, ROLE)
my $date = 2013-10-20; # date | Validity date

eval { 
    my $result = $api_instance->getPrincipals(type => $type, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaprincipalsApi->getPrincipals: $@\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.CcaprincipalsApi()
type = type_example # String | Principal type (one of USER, ROLE)
date = 2013-10-20 # date | Validity date

try: 
    # Retrieve principal of speficied type valid for date
    api_response = api_instance.get_principals(type, date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaprincipalsApi->getPrincipals: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Principal type (one of USER, ROLE)
Required
Query parameters
Name Description
date*
date (date)
Validity date
Required

Responses

Status: 200 - successful operation


getUserInfo

Retrieve user info for specified login


/api/cca/principals/userInfo/{userLogin}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/cca/principals/userInfo/{userLogin}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaprincipalsApi;

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

public class CcaprincipalsApiExample {

    public static void main(String[] args) {
        
        CcaprincipalsApi apiInstance = new CcaprincipalsApi();
        String userLogin = userLogin_example; // String | User login
        try {
            APIUserInfo result = apiInstance.getUserInfo(userLogin);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaprincipalsApi#getUserInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaprincipalsApi;

public class CcaprincipalsApiExample {

    public static void main(String[] args) {
        CcaprincipalsApi apiInstance = new CcaprincipalsApi();
        String userLogin = userLogin_example; // String | User login
        try {
            APIUserInfo result = apiInstance.getUserInfo(userLogin);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaprincipalsApi#getUserInfo");
            e.printStackTrace();
        }
    }
}
String *userLogin = userLogin_example; // User login

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

// Retrieve user info for specified login
[apiInstance getUserInfoWith:userLogin
              completionHandler: ^(APIUserInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaprincipalsApi()

var userLogin = userLogin_example; // {String} User login


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

namespace Example
{
    public class getUserInfoExample
    {
        public void main()
        {
            
            var apiInstance = new CcaprincipalsApi();
            var userLogin = userLogin_example;  // String | User login

            try
            {
                // Retrieve user info for specified login
                APIUserInfo result = apiInstance.getUserInfo(userLogin);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaprincipalsApi.getUserInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaprincipalsApi();
$userLogin = userLogin_example; // String | User login

try {
    $result = $api_instance->getUserInfo($userLogin);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaprincipalsApi->getUserInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaprincipalsApi;

my $api_instance = WWW::SwaggerClient::CcaprincipalsApi->new();
my $userLogin = userLogin_example; # String | User login

eval { 
    my $result = $api_instance->getUserInfo(userLogin => $userLogin);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaprincipalsApi->getUserInfo: $@\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.CcaprincipalsApi()
userLogin = userLogin_example # String | User login

try: 
    # Retrieve user info for specified login
    api_response = api_instance.get_user_info(userLogin)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaprincipalsApi->getUserInfo: %s\n" % e)

Parameters

Path parameters
Name Description
userLogin*
String
User login
Required

Responses

Status: 200 - successful operation


resolveUsers

Retrieve logins for users having specified principal type with base object identifier


/api/cca/principals/users/{type}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/cca/principals/users/{type}?baseObjIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaprincipalsApi;

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

public class CcaprincipalsApiExample {

    public static void main(String[] args) {
        
        CcaprincipalsApi apiInstance = new CcaprincipalsApi();
        String type = type_example; // String | Principal type (one of USER, ROLE)
        array[Integer] baseObjIds = ; // array[Integer] | Base object (user or role) identifier
        try {
            array['String'] result = apiInstance.resolveUsers(type, baseObjIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaprincipalsApi#resolveUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaprincipalsApi;

public class CcaprincipalsApiExample {

    public static void main(String[] args) {
        CcaprincipalsApi apiInstance = new CcaprincipalsApi();
        String type = type_example; // String | Principal type (one of USER, ROLE)
        array[Integer] baseObjIds = ; // array[Integer] | Base object (user or role) identifier
        try {
            array['String'] result = apiInstance.resolveUsers(type, baseObjIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaprincipalsApi#resolveUsers");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // Principal type (one of USER, ROLE)
array[Integer] *baseObjIds = ; // Base object (user or role) identifier

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

// Retrieve logins for users having specified principal type with base object identifier
[apiInstance resolveUsersWith:type
    baseObjIds:baseObjIds
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaprincipalsApi()

var type = type_example; // {String} Principal type (one of USER, ROLE)

var baseObjIds = ; // {array[Integer]} Base object (user or role) identifier


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

namespace Example
{
    public class resolveUsersExample
    {
        public void main()
        {
            
            var apiInstance = new CcaprincipalsApi();
            var type = type_example;  // String | Principal type (one of USER, ROLE)
            var baseObjIds = new array[Integer](); // array[Integer] | Base object (user or role) identifier

            try
            {
                // Retrieve logins for users having specified principal type with base object identifier
                array['String'] result = apiInstance.resolveUsers(type, baseObjIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaprincipalsApi.resolveUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaprincipalsApi();
$type = type_example; // String | Principal type (one of USER, ROLE)
$baseObjIds = ; // array[Integer] | Base object (user or role) identifier

try {
    $result = $api_instance->resolveUsers($type, $baseObjIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaprincipalsApi->resolveUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaprincipalsApi;

my $api_instance = WWW::SwaggerClient::CcaprincipalsApi->new();
my $type = type_example; # String | Principal type (one of USER, ROLE)
my $baseObjIds = []; # array[Integer] | Base object (user or role) identifier

eval { 
    my $result = $api_instance->resolveUsers(type => $type, baseObjIds => $baseObjIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaprincipalsApi->resolveUsers: $@\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.CcaprincipalsApi()
type = type_example # String | Principal type (one of USER, ROLE)
baseObjIds =  # array[Integer] | Base object (user or role) identifier

try: 
    # Retrieve logins for users having specified principal type with base object identifier
    api_response = api_instance.resolve_users(type, baseObjIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaprincipalsApi->resolveUsers: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Principal type (one of USER, ROLE)
Required
Query parameters
Name Description
baseObjIds*
array[Integer] (int32)
Base object (user or role) identifier
Required

Responses

Status: 200 - successful operation


Ccarequests

changeClaimRequestData

Change data on subject request


/api/cca/requests/{requestId}/change

Usage and SDK Samples

curl -X PUT "https://localhost/core/services/rest/core/api/cca/requests/{requestId}/change?bpNumber=&status=&statement=&resolvingType=&changedValues="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcarequestsApi;

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

public class CcarequestsApiExample {

    public static void main(String[] args) {
        
        CcarequestsApi apiInstance = new CcarequestsApi();
        Integer requestId = 56; // Integer | Request identifier
        String bpNumber = bpNumber_example; // String | Business partner registration number
        String status = status_example; // String | New status for subject request
        String statement = statement_example; // String | Statement for status change
        String resolvingType = resolvingType_example; // String | Type of request resolving
        Boolean changedValues = true; // Boolean | Flag if request should be returned after performing changes
        try {
            APIClaimRequest result = apiInstance.changeClaimRequestData(requestId, bpNumber, status, statement, resolvingType, changedValues);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcarequestsApi#changeClaimRequestData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcarequestsApi;

public class CcarequestsApiExample {

    public static void main(String[] args) {
        CcarequestsApi apiInstance = new CcarequestsApi();
        Integer requestId = 56; // Integer | Request identifier
        String bpNumber = bpNumber_example; // String | Business partner registration number
        String status = status_example; // String | New status for subject request
        String statement = statement_example; // String | Statement for status change
        String resolvingType = resolvingType_example; // String | Type of request resolving
        Boolean changedValues = true; // Boolean | Flag if request should be returned after performing changes
        try {
            APIClaimRequest result = apiInstance.changeClaimRequestData(requestId, bpNumber, status, statement, resolvingType, changedValues);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcarequestsApi#changeClaimRequestData");
            e.printStackTrace();
        }
    }
}
Integer *requestId = 56; // Request identifier
String *bpNumber = bpNumber_example; // Business partner registration number
String *status = status_example; // New status for subject request
String *statement = statement_example; // Statement for status change (optional)
String *resolvingType = resolvingType_example; // Type of request resolving (optional)
Boolean *changedValues = true; // Flag if request should be returned after performing changes (optional)

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

// Change data on subject request
[apiInstance changeClaimRequestDataWith:requestId
    bpNumber:bpNumber
    status:status
    statement:statement
    resolvingType:resolvingType
    changedValues:changedValues
              completionHandler: ^(APIClaimRequest output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcarequestsApi()

var requestId = 56; // {Integer} Request identifier

var bpNumber = bpNumber_example; // {String} Business partner registration number

var status = status_example; // {String} New status for subject request

var opts = { 
  'statement': statement_example, // {String} Statement for status change
  'resolvingType': resolvingType_example, // {String} Type of request resolving
  'changedValues': true // {Boolean} Flag if request should be returned after performing changes
};

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

namespace Example
{
    public class changeClaimRequestDataExample
    {
        public void main()
        {
            
            var apiInstance = new CcarequestsApi();
            var requestId = 56;  // Integer | Request identifier
            var bpNumber = bpNumber_example;  // String | Business partner registration number
            var status = status_example;  // String | New status for subject request
            var statement = statement_example;  // String | Statement for status change (optional) 
            var resolvingType = resolvingType_example;  // String | Type of request resolving (optional) 
            var changedValues = true;  // Boolean | Flag if request should be returned after performing changes (optional) 

            try
            {
                // Change data on subject request
                APIClaimRequest result = apiInstance.changeClaimRequestData(requestId, bpNumber, status, statement, resolvingType, changedValues);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcarequestsApi.changeClaimRequestData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcarequestsApi();
$requestId = 56; // Integer | Request identifier
$bpNumber = bpNumber_example; // String | Business partner registration number
$status = status_example; // String | New status for subject request
$statement = statement_example; // String | Statement for status change
$resolvingType = resolvingType_example; // String | Type of request resolving
$changedValues = true; // Boolean | Flag if request should be returned after performing changes

try {
    $result = $api_instance->changeClaimRequestData($requestId, $bpNumber, $status, $statement, $resolvingType, $changedValues);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcarequestsApi->changeClaimRequestData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcarequestsApi;

my $api_instance = WWW::SwaggerClient::CcarequestsApi->new();
my $requestId = 56; # Integer | Request identifier
my $bpNumber = bpNumber_example; # String | Business partner registration number
my $status = status_example; # String | New status for subject request
my $statement = statement_example; # String | Statement for status change
my $resolvingType = resolvingType_example; # String | Type of request resolving
my $changedValues = true; # Boolean | Flag if request should be returned after performing changes

eval { 
    my $result = $api_instance->changeClaimRequestData(requestId => $requestId, bpNumber => $bpNumber, status => $status, statement => $statement, resolvingType => $resolvingType, changedValues => $changedValues);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcarequestsApi->changeClaimRequestData: $@\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.CcarequestsApi()
requestId = 56 # Integer | Request identifier
bpNumber = bpNumber_example # String | Business partner registration number
status = status_example # String | New status for subject request
statement = statement_example # String | Statement for status change (optional)
resolvingType = resolvingType_example # String | Type of request resolving (optional)
changedValues = true # Boolean | Flag if request should be returned after performing changes (optional)

try: 
    # Change data on subject request
    api_response = api_instance.change_claim_request_data(requestId, bpNumber, status, statement=statement, resolvingType=resolvingType, changedValues=changedValues)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcarequestsApi->changeClaimRequestData: %s\n" % e)

Parameters

Path parameters
Name Description
requestId*
Integer (int32)
Request identifier
Required
Query parameters
Name Description
bpNumber*
String
Business partner registration number
Required
status*
String
New status for subject request
Required
statement
String
Statement for status change
resolvingType
String
Type of request resolving
changedValues
Boolean
Flag if request should be returned after performing changes

Responses

Status: 200 - successful operation


getClaimRequest

Retrieve information about claim request and business partner

Retrieve basic information about claim request and business partner (e.g. name, surname, company name)


/api/cca/requests/{requestId}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/cca/requests/{requestId}?bpNumber="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcarequestsApi;

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

public class CcarequestsApiExample {

    public static void main(String[] args) {
        
        CcarequestsApi apiInstance = new CcarequestsApi();
        Integer requestId = 56; // Integer | Claim request identifier
        String bpNumber = bpNumber_example; // String | Business partner registration number
        try {
            APIClaimRequest result = apiInstance.getClaimRequest(requestId, bpNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcarequestsApi#getClaimRequest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcarequestsApi;

public class CcarequestsApiExample {

    public static void main(String[] args) {
        CcarequestsApi apiInstance = new CcarequestsApi();
        Integer requestId = 56; // Integer | Claim request identifier
        String bpNumber = bpNumber_example; // String | Business partner registration number
        try {
            APIClaimRequest result = apiInstance.getClaimRequest(requestId, bpNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcarequestsApi#getClaimRequest");
            e.printStackTrace();
        }
    }
}
Integer *requestId = 56; // Claim request identifier
String *bpNumber = bpNumber_example; // Business partner registration number

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

// Retrieve information about claim request and business partner
[apiInstance getClaimRequestWith:requestId
    bpNumber:bpNumber
              completionHandler: ^(APIClaimRequest output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcarequestsApi()

var requestId = 56; // {Integer} Claim request identifier

var bpNumber = bpNumber_example; // {String} Business partner registration number


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

namespace Example
{
    public class getClaimRequestExample
    {
        public void main()
        {
            
            var apiInstance = new CcarequestsApi();
            var requestId = 56;  // Integer | Claim request identifier
            var bpNumber = bpNumber_example;  // String | Business partner registration number

            try
            {
                // Retrieve information about claim request and business partner
                APIClaimRequest result = apiInstance.getClaimRequest(requestId, bpNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcarequestsApi.getClaimRequest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcarequestsApi();
$requestId = 56; // Integer | Claim request identifier
$bpNumber = bpNumber_example; // String | Business partner registration number

try {
    $result = $api_instance->getClaimRequest($requestId, $bpNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcarequestsApi->getClaimRequest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcarequestsApi;

my $api_instance = WWW::SwaggerClient::CcarequestsApi->new();
my $requestId = 56; # Integer | Claim request identifier
my $bpNumber = bpNumber_example; # String | Business partner registration number

eval { 
    my $result = $api_instance->getClaimRequest(requestId => $requestId, bpNumber => $bpNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcarequestsApi->getClaimRequest: $@\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.CcarequestsApi()
requestId = 56 # Integer | Claim request identifier
bpNumber = bpNumber_example # String | Business partner registration number

try: 
    # Retrieve information about claim request and business partner
    api_response = api_instance.get_claim_request(requestId, bpNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcarequestsApi->getClaimRequest: %s\n" % e)

Parameters

Path parameters
Name Description
requestId*
Integer (int32)
Claim request identifier
Required
Query parameters
Name Description
bpNumber*
String
Business partner registration number
Required

Responses

Status: 200 - successful operation


getInvoice

Retrieve invoice information


/api/cca/invoices/{invoiceId}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/cca/invoices/{invoiceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcarequestsApi;

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

public class CcarequestsApiExample {

    public static void main(String[] args) {
        
        CcarequestsApi apiInstance = new CcarequestsApi();
        Integer invoiceId = 56; // Integer | Invoice identifier
        try {
            array[APIInvoiceContractObject] result = apiInstance.getInvoice(invoiceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcarequestsApi#getInvoice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcarequestsApi;

public class CcarequestsApiExample {

    public static void main(String[] args) {
        CcarequestsApi apiInstance = new CcarequestsApi();
        Integer invoiceId = 56; // Integer | Invoice identifier
        try {
            array[APIInvoiceContractObject] result = apiInstance.getInvoice(invoiceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcarequestsApi#getInvoice");
            e.printStackTrace();
        }
    }
}
Integer *invoiceId = 56; // Invoice identifier

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

// Retrieve invoice information
[apiInstance getInvoiceWith:invoiceId
              completionHandler: ^(array[APIInvoiceContractObject] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcarequestsApi()

var invoiceId = 56; // {Integer} Invoice identifier


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

namespace Example
{
    public class getInvoiceExample
    {
        public void main()
        {
            
            var apiInstance = new CcarequestsApi();
            var invoiceId = 56;  // Integer | Invoice identifier

            try
            {
                // Retrieve invoice information
                array[APIInvoiceContractObject] result = apiInstance.getInvoice(invoiceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcarequestsApi.getInvoice: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcarequestsApi();
$invoiceId = 56; // Integer | Invoice identifier

try {
    $result = $api_instance->getInvoice($invoiceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcarequestsApi->getInvoice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcarequestsApi;

my $api_instance = WWW::SwaggerClient::CcarequestsApi->new();
my $invoiceId = 56; # Integer | Invoice identifier

eval { 
    my $result = $api_instance->getInvoice(invoiceId => $invoiceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcarequestsApi->getInvoice: $@\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.CcarequestsApi()
invoiceId = 56 # Integer | Invoice identifier

try: 
    # Retrieve invoice information
    api_response = api_instance.get_invoice(invoiceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcarequestsApi->getInvoice: %s\n" % e)

Parameters

Path parameters
Name Description
invoiceId*
Integer (int32)
Invoice identifier
Required

Responses

Status: 200 - successful operation


Ccasld

getPostingDocuments

Retrieve posting documents according to incoming filter. If returned value flag existsNext is TRUE, then not all documents were returned due to limit and another call should be taken.


/api/sld/postingDocs

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/sld/postingDocs?reconciliationKey=&glAccount=&postingDate=&costCentre=&creditDebit=&idLast=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcasldApi;

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

public class CcasldApiExample {

    public static void main(String[] args) {
        
        CcasldApi apiInstance = new CcasldApi();
        String reconciliationKey = reconciliationKey_example; // String | Filter for posting documents
        String glAccount = glAccount_example; // String | Filter for posting documents
        date postingDate = 2013-10-20; // date | Filter for posting documents
        String costCentre = costCentre_example; // String | Filter for posting documents
        String creditDebit = creditDebit_example; // String | Filter for posting documents
        Integer idLast = 56; // Integer | Identifier of last document returned by previous call. First call should have this parameter as NULL.
        Integer limit = 56; // Integer | Limit for number of retrieved documents. If NULL, then maximum limit of 200 documents will be applied.
        try {
            APIPostingDocuments result = apiInstance.getPostingDocuments(reconciliationKey, glAccount, postingDate, costCentre, creditDebit, idLast, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcasldApi#getPostingDocuments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcasldApi;

public class CcasldApiExample {

    public static void main(String[] args) {
        CcasldApi apiInstance = new CcasldApi();
        String reconciliationKey = reconciliationKey_example; // String | Filter for posting documents
        String glAccount = glAccount_example; // String | Filter for posting documents
        date postingDate = 2013-10-20; // date | Filter for posting documents
        String costCentre = costCentre_example; // String | Filter for posting documents
        String creditDebit = creditDebit_example; // String | Filter for posting documents
        Integer idLast = 56; // Integer | Identifier of last document returned by previous call. First call should have this parameter as NULL.
        Integer limit = 56; // Integer | Limit for number of retrieved documents. If NULL, then maximum limit of 200 documents will be applied.
        try {
            APIPostingDocuments result = apiInstance.getPostingDocuments(reconciliationKey, glAccount, postingDate, costCentre, creditDebit, idLast, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcasldApi#getPostingDocuments");
            e.printStackTrace();
        }
    }
}
String *reconciliationKey = reconciliationKey_example; // Filter for posting documents
String *glAccount = glAccount_example; // Filter for posting documents (optional)
date *postingDate = 2013-10-20; // Filter for posting documents (optional)
String *costCentre = costCentre_example; // Filter for posting documents (optional)
String *creditDebit = creditDebit_example; // Filter for posting documents (optional)
Integer *idLast = 56; // Identifier of last document returned by previous call. First call should have this parameter as NULL. (optional)
Integer *limit = 56; // Limit for number of retrieved documents. If NULL, then maximum limit of 200 documents will be applied. (optional)

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

// Retrieve posting documents according to incoming filter. If returned value flag existsNext is TRUE, then not all documents were returned due to limit and another call should be taken.
[apiInstance getPostingDocumentsWith:reconciliationKey
    glAccount:glAccount
    postingDate:postingDate
    costCentre:costCentre
    creditDebit:creditDebit
    idLast:idLast
    limit:limit
              completionHandler: ^(APIPostingDocuments output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcasldApi()

var reconciliationKey = reconciliationKey_example; // {String} Filter for posting documents

var opts = { 
  'glAccount': glAccount_example, // {String} Filter for posting documents
  'postingDate': 2013-10-20, // {date} Filter for posting documents
  'costCentre': costCentre_example, // {String} Filter for posting documents
  'creditDebit': creditDebit_example, // {String} Filter for posting documents
  'idLast': 56, // {Integer} Identifier of last document returned by previous call. First call should have this parameter as NULL.
  'limit': 56 // {Integer} Limit for number of retrieved documents. If NULL, then maximum limit of 200 documents will be applied.
};

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

namespace Example
{
    public class getPostingDocumentsExample
    {
        public void main()
        {
            
            var apiInstance = new CcasldApi();
            var reconciliationKey = reconciliationKey_example;  // String | Filter for posting documents
            var glAccount = glAccount_example;  // String | Filter for posting documents (optional) 
            var postingDate = 2013-10-20;  // date | Filter for posting documents (optional) 
            var costCentre = costCentre_example;  // String | Filter for posting documents (optional) 
            var creditDebit = creditDebit_example;  // String | Filter for posting documents (optional) 
            var idLast = 56;  // Integer | Identifier of last document returned by previous call. First call should have this parameter as NULL. (optional) 
            var limit = 56;  // Integer | Limit for number of retrieved documents. If NULL, then maximum limit of 200 documents will be applied. (optional) 

            try
            {
                // Retrieve posting documents according to incoming filter. If returned value flag existsNext is TRUE, then not all documents were returned due to limit and another call should be taken.
                APIPostingDocuments result = apiInstance.getPostingDocuments(reconciliationKey, glAccount, postingDate, costCentre, creditDebit, idLast, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcasldApi.getPostingDocuments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcasldApi();
$reconciliationKey = reconciliationKey_example; // String | Filter for posting documents
$glAccount = glAccount_example; // String | Filter for posting documents
$postingDate = 2013-10-20; // date | Filter for posting documents
$costCentre = costCentre_example; // String | Filter for posting documents
$creditDebit = creditDebit_example; // String | Filter for posting documents
$idLast = 56; // Integer | Identifier of last document returned by previous call. First call should have this parameter as NULL.
$limit = 56; // Integer | Limit for number of retrieved documents. If NULL, then maximum limit of 200 documents will be applied.

try {
    $result = $api_instance->getPostingDocuments($reconciliationKey, $glAccount, $postingDate, $costCentre, $creditDebit, $idLast, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcasldApi->getPostingDocuments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcasldApi;

my $api_instance = WWW::SwaggerClient::CcasldApi->new();
my $reconciliationKey = reconciliationKey_example; # String | Filter for posting documents
my $glAccount = glAccount_example; # String | Filter for posting documents
my $postingDate = 2013-10-20; # date | Filter for posting documents
my $costCentre = costCentre_example; # String | Filter for posting documents
my $creditDebit = creditDebit_example; # String | Filter for posting documents
my $idLast = 56; # Integer | Identifier of last document returned by previous call. First call should have this parameter as NULL.
my $limit = 56; # Integer | Limit for number of retrieved documents. If NULL, then maximum limit of 200 documents will be applied.

eval { 
    my $result = $api_instance->getPostingDocuments(reconciliationKey => $reconciliationKey, glAccount => $glAccount, postingDate => $postingDate, costCentre => $costCentre, creditDebit => $creditDebit, idLast => $idLast, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcasldApi->getPostingDocuments: $@\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.CcasldApi()
reconciliationKey = reconciliationKey_example # String | Filter for posting documents
glAccount = glAccount_example # String | Filter for posting documents (optional)
postingDate = 2013-10-20 # date | Filter for posting documents (optional)
costCentre = costCentre_example # String | Filter for posting documents (optional)
creditDebit = creditDebit_example # String | Filter for posting documents (optional)
idLast = 56 # Integer | Identifier of last document returned by previous call. First call should have this parameter as NULL. (optional)
limit = 56 # Integer | Limit for number of retrieved documents. If NULL, then maximum limit of 200 documents will be applied. (optional)

try: 
    # Retrieve posting documents according to incoming filter. If returned value flag existsNext is TRUE, then not all documents were returned due to limit and another call should be taken.
    api_response = api_instance.get_posting_documents(reconciliationKey, glAccount=glAccount, postingDate=postingDate, costCentre=costCentre, creditDebit=creditDebit, idLast=idLast, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcasldApi->getPostingDocuments: %s\n" % e)

Parameters

Query parameters
Name Description
reconciliationKey*
String
Filter for posting documents
Required
glAccount
String
Filter for posting documents
postingDate
date (date)
Filter for posting documents
costCentre
String
Filter for posting documents
creditDebit
String
Filter for posting documents
idLast
Integer (int32)
Identifier of last document returned by previous call. First call should have this parameter as NULL.
limit
Integer (int32)
Limit for number of retrieved documents. If NULL, then maximum limit of 200 documents will be applied.

Responses

Status: 200 - successful operation


getPostingDocumentsCount

Retrieve count of posting documents according to incoming filter.


/api/sld/postingDocsCount

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/sld/postingDocsCount?reconciliationKey=&glAccount=&postingDate=&costCentre=&creditDebit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcasldApi;

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

public class CcasldApiExample {

    public static void main(String[] args) {
        
        CcasldApi apiInstance = new CcasldApi();
        String reconciliationKey = reconciliationKey_example; // String | Filter for posting documents
        String glAccount = glAccount_example; // String | Filter for posting documents
        date postingDate = 2013-10-20; // date | Filter for posting documents
        String costCentre = costCentre_example; // String | Filter for posting documents
        String creditDebit = creditDebit_example; // String | Filter for posting documents
        try {
            'Integer' result = apiInstance.getPostingDocumentsCount(reconciliationKey, glAccount, postingDate, costCentre, creditDebit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcasldApi#getPostingDocumentsCount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcasldApi;

public class CcasldApiExample {

    public static void main(String[] args) {
        CcasldApi apiInstance = new CcasldApi();
        String reconciliationKey = reconciliationKey_example; // String | Filter for posting documents
        String glAccount = glAccount_example; // String | Filter for posting documents
        date postingDate = 2013-10-20; // date | Filter for posting documents
        String costCentre = costCentre_example; // String | Filter for posting documents
        String creditDebit = creditDebit_example; // String | Filter for posting documents
        try {
            'Integer' result = apiInstance.getPostingDocumentsCount(reconciliationKey, glAccount, postingDate, costCentre, creditDebit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcasldApi#getPostingDocumentsCount");
            e.printStackTrace();
        }
    }
}
String *reconciliationKey = reconciliationKey_example; // Filter for posting documents
String *glAccount = glAccount_example; // Filter for posting documents (optional)
date *postingDate = 2013-10-20; // Filter for posting documents (optional)
String *costCentre = costCentre_example; // Filter for posting documents (optional)
String *creditDebit = creditDebit_example; // Filter for posting documents (optional)

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

// Retrieve count of posting documents according to incoming filter.
[apiInstance getPostingDocumentsCountWith:reconciliationKey
    glAccount:glAccount
    postingDate:postingDate
    costCentre:costCentre
    creditDebit:creditDebit
              completionHandler: ^('Integer' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcasldApi()

var reconciliationKey = reconciliationKey_example; // {String} Filter for posting documents

var opts = { 
  'glAccount': glAccount_example, // {String} Filter for posting documents
  'postingDate': 2013-10-20, // {date} Filter for posting documents
  'costCentre': costCentre_example, // {String} Filter for posting documents
  'creditDebit': creditDebit_example // {String} Filter for posting documents
};

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

namespace Example
{
    public class getPostingDocumentsCountExample
    {
        public void main()
        {
            
            var apiInstance = new CcasldApi();
            var reconciliationKey = reconciliationKey_example;  // String | Filter for posting documents
            var glAccount = glAccount_example;  // String | Filter for posting documents (optional) 
            var postingDate = 2013-10-20;  // date | Filter for posting documents (optional) 
            var costCentre = costCentre_example;  // String | Filter for posting documents (optional) 
            var creditDebit = creditDebit_example;  // String | Filter for posting documents (optional) 

            try
            {
                // Retrieve count of posting documents according to incoming filter.
                'Integer' result = apiInstance.getPostingDocumentsCount(reconciliationKey, glAccount, postingDate, costCentre, creditDebit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcasldApi.getPostingDocumentsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcasldApi();
$reconciliationKey = reconciliationKey_example; // String | Filter for posting documents
$glAccount = glAccount_example; // String | Filter for posting documents
$postingDate = 2013-10-20; // date | Filter for posting documents
$costCentre = costCentre_example; // String | Filter for posting documents
$creditDebit = creditDebit_example; // String | Filter for posting documents

try {
    $result = $api_instance->getPostingDocumentsCount($reconciliationKey, $glAccount, $postingDate, $costCentre, $creditDebit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcasldApi->getPostingDocumentsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcasldApi;

my $api_instance = WWW::SwaggerClient::CcasldApi->new();
my $reconciliationKey = reconciliationKey_example; # String | Filter for posting documents
my $glAccount = glAccount_example; # String | Filter for posting documents
my $postingDate = 2013-10-20; # date | Filter for posting documents
my $costCentre = costCentre_example; # String | Filter for posting documents
my $creditDebit = creditDebit_example; # String | Filter for posting documents

eval { 
    my $result = $api_instance->getPostingDocumentsCount(reconciliationKey => $reconciliationKey, glAccount => $glAccount, postingDate => $postingDate, costCentre => $costCentre, creditDebit => $creditDebit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcasldApi->getPostingDocumentsCount: $@\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.CcasldApi()
reconciliationKey = reconciliationKey_example # String | Filter for posting documents
glAccount = glAccount_example # String | Filter for posting documents (optional)
postingDate = 2013-10-20 # date | Filter for posting documents (optional)
costCentre = costCentre_example # String | Filter for posting documents (optional)
creditDebit = creditDebit_example # String | Filter for posting documents (optional)

try: 
    # Retrieve count of posting documents according to incoming filter.
    api_response = api_instance.get_posting_documents_count(reconciliationKey, glAccount=glAccount, postingDate=postingDate, costCentre=costCentre, creditDebit=creditDebit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcasldApi->getPostingDocumentsCount: %s\n" % e)

Parameters

Query parameters
Name Description
reconciliationKey*
String
Filter for posting documents
Required
glAccount
String
Filter for posting documents
postingDate
date (date)
Filter for posting documents
costCentre
String
Filter for posting documents
creditDebit
String
Filter for posting documents

Responses

Status: 200 - successful operation


Ccaworkplace

changeBudgetBillingPlanItemAmount

Change amount for budget bill plan items. All items ought to be from the same budget bill plan.


/api/wp/bp/{subjectId}/bbPlan/changeAmount

Usage and SDK Samples

curl -X PUT "https://localhost/core/services/rest/core/api/wp/bp/{subjectId}/bbPlan/changeAmount?amount=&bbPlanItemIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        BigDecimal amount = 3.4; // BigDecimal | New amount for budget bill plan items.
        array[Integer] bbPlanItemIds = ; // array[Integer] | Budget bill plan items identifiers. Items must be from the same billing plan which belongs to business partner.
        try {
            apiInstance.changeBudgetBillingPlanItemAmount(subjectId, amount, bbPlanItemIds);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#changeBudgetBillingPlanItemAmount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        BigDecimal amount = 3.4; // BigDecimal | New amount for budget bill plan items.
        array[Integer] bbPlanItemIds = ; // array[Integer] | Budget bill plan items identifiers. Items must be from the same billing plan which belongs to business partner.
        try {
            apiInstance.changeBudgetBillingPlanItemAmount(subjectId, amount, bbPlanItemIds);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#changeBudgetBillingPlanItemAmount");
            e.printStackTrace();
        }
    }
}
Integer *subjectId = 56; // Business partner identifier
BigDecimal *amount = 3.4; // New amount for budget bill plan items.
array[Integer] *bbPlanItemIds = ; // Budget bill plan items identifiers. Items must be from the same billing plan which belongs to business partner.

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

// Change amount for budget bill plan items. All items ought to be from the same budget bill plan.
[apiInstance changeBudgetBillingPlanItemAmountWith:subjectId
    amount:amount
    bbPlanItemIds:bbPlanItemIds
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var subjectId = 56; // {Integer} Business partner identifier

var amount = 3.4; // {BigDecimal} New amount for budget bill plan items.

var bbPlanItemIds = ; // {array[Integer]} Budget bill plan items identifiers. Items must be from the same billing plan which belongs to business partner.


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

namespace Example
{
    public class changeBudgetBillingPlanItemAmountExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var subjectId = 56;  // Integer | Business partner identifier
            var amount = 3.4;  // BigDecimal | New amount for budget bill plan items.
            var bbPlanItemIds = new array[Integer](); // array[Integer] | Budget bill plan items identifiers. Items must be from the same billing plan which belongs to business partner.

            try
            {
                // Change amount for budget bill plan items. All items ought to be from the same budget bill plan.
                apiInstance.changeBudgetBillingPlanItemAmount(subjectId, amount, bbPlanItemIds);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.changeBudgetBillingPlanItemAmount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$subjectId = 56; // Integer | Business partner identifier
$amount = 3.4; // BigDecimal | New amount for budget bill plan items.
$bbPlanItemIds = ; // array[Integer] | Budget bill plan items identifiers. Items must be from the same billing plan which belongs to business partner.

try {
    $api_instance->changeBudgetBillingPlanItemAmount($subjectId, $amount, $bbPlanItemIds);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->changeBudgetBillingPlanItemAmount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $subjectId = 56; # Integer | Business partner identifier
my $amount = 3.4; # BigDecimal | New amount for budget bill plan items.
my $bbPlanItemIds = []; # array[Integer] | Budget bill plan items identifiers. Items must be from the same billing plan which belongs to business partner.

eval { 
    $api_instance->changeBudgetBillingPlanItemAmount(subjectId => $subjectId, amount => $amount, bbPlanItemIds => $bbPlanItemIds);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->changeBudgetBillingPlanItemAmount: $@\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.CcaworkplaceApi()
subjectId = 56 # Integer | Business partner identifier
amount = 3.4 # BigDecimal | New amount for budget bill plan items.
bbPlanItemIds =  # array[Integer] | Budget bill plan items identifiers. Items must be from the same billing plan which belongs to business partner.

try: 
    # Change amount for budget bill plan items. All items ought to be from the same budget bill plan.
    api_instance.change_budget_billing_plan_item_amount(subjectId, amount, bbPlanItemIds)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->changeBudgetBillingPlanItemAmount: %s\n" % e)

Parameters

Path parameters
Name Description
subjectId*
Integer (int32)
Business partner identifier
Required
Query parameters
Name Description
amount*
BigDecimal
New amount for budget bill plan items.
Required
bbPlanItemIds*
array[Integer] (int32)
Budget bill plan items identifiers. Items must be from the same billing plan which belongs to business partner.
Required

Responses

Status: default - successful operation


changeBusinessPartnerContacts

Change business partner email and phone contacts


/api/wp/bp/{subjectId}/contacts/change

Usage and SDK Samples

curl -X PUT "https://localhost/core/services/rest/core/api/wp/bp/{subjectId}/contacts/change?email=&fax=&mobile=&phone="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        String email = email_example; // String | New email, if NULL then no change will be done.
        String fax = fax_example; // String | New fax number, if NULL then no change will be done.
        String mobile = mobile_example; // String | New mobile phone number, if NULL then no change will be done.
        String phone = phone_example; // String | New phone number, if NULL then no change will be done.
        try {
            apiInstance.changeBusinessPartnerContacts(subjectId, email, fax, mobile, phone);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#changeBusinessPartnerContacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        String email = email_example; // String | New email, if NULL then no change will be done.
        String fax = fax_example; // String | New fax number, if NULL then no change will be done.
        String mobile = mobile_example; // String | New mobile phone number, if NULL then no change will be done.
        String phone = phone_example; // String | New phone number, if NULL then no change will be done.
        try {
            apiInstance.changeBusinessPartnerContacts(subjectId, email, fax, mobile, phone);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#changeBusinessPartnerContacts");
            e.printStackTrace();
        }
    }
}
Integer *subjectId = 56; // Business partner identifier
String *email = email_example; // New email, if NULL then no change will be done. (optional)
String *fax = fax_example; // New fax number, if NULL then no change will be done. (optional)
String *mobile = mobile_example; // New mobile phone number, if NULL then no change will be done. (optional)
String *phone = phone_example; // New phone number, if NULL then no change will be done. (optional)

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

// Change business partner email and phone contacts
[apiInstance changeBusinessPartnerContactsWith:subjectId
    email:email
    fax:fax
    mobile:mobile
    phone:phone
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var subjectId = 56; // {Integer} Business partner identifier

var opts = { 
  'email': email_example, // {String} New email, if NULL then no change will be done.
  'fax': fax_example, // {String} New fax number, if NULL then no change will be done.
  'mobile': mobile_example, // {String} New mobile phone number, if NULL then no change will be done.
  'phone': phone_example // {String} New phone number, if NULL then no change will be done.
};

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

namespace Example
{
    public class changeBusinessPartnerContactsExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var subjectId = 56;  // Integer | Business partner identifier
            var email = email_example;  // String | New email, if NULL then no change will be done. (optional) 
            var fax = fax_example;  // String | New fax number, if NULL then no change will be done. (optional) 
            var mobile = mobile_example;  // String | New mobile phone number, if NULL then no change will be done. (optional) 
            var phone = phone_example;  // String | New phone number, if NULL then no change will be done. (optional) 

            try
            {
                // Change business partner email and phone contacts
                apiInstance.changeBusinessPartnerContacts(subjectId, email, fax, mobile, phone);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.changeBusinessPartnerContacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$subjectId = 56; // Integer | Business partner identifier
$email = email_example; // String | New email, if NULL then no change will be done.
$fax = fax_example; // String | New fax number, if NULL then no change will be done.
$mobile = mobile_example; // String | New mobile phone number, if NULL then no change will be done.
$phone = phone_example; // String | New phone number, if NULL then no change will be done.

try {
    $api_instance->changeBusinessPartnerContacts($subjectId, $email, $fax, $mobile, $phone);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->changeBusinessPartnerContacts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $subjectId = 56; # Integer | Business partner identifier
my $email = email_example; # String | New email, if NULL then no change will be done.
my $fax = fax_example; # String | New fax number, if NULL then no change will be done.
my $mobile = mobile_example; # String | New mobile phone number, if NULL then no change will be done.
my $phone = phone_example; # String | New phone number, if NULL then no change will be done.

eval { 
    $api_instance->changeBusinessPartnerContacts(subjectId => $subjectId, email => $email, fax => $fax, mobile => $mobile, phone => $phone);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->changeBusinessPartnerContacts: $@\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.CcaworkplaceApi()
subjectId = 56 # Integer | Business partner identifier
email = email_example # String | New email, if NULL then no change will be done. (optional)
fax = fax_example # String | New fax number, if NULL then no change will be done. (optional)
mobile = mobile_example # String | New mobile phone number, if NULL then no change will be done. (optional)
phone = phone_example # String | New phone number, if NULL then no change will be done. (optional)

try: 
    # Change business partner email and phone contacts
    api_instance.change_business_partner_contacts(subjectId, email=email, fax=fax, mobile=mobile, phone=phone)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->changeBusinessPartnerContacts: %s\n" % e)

Parameters

Path parameters
Name Description
subjectId*
Integer (int32)
Business partner identifier
Required
Query parameters
Name Description
email
String
New email, if NULL then no change will be done.
fax
String
New fax number, if NULL then no change will be done.
mobile
String
New mobile phone number, if NULL then no change will be done.
phone
String
New phone number, if NULL then no change will be done.

Responses

Status: default - successful operation


getAccountBalanceItems

Account balance items (all or only open items).


/api/wp/bp/{subjectId}/accountBalance

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/bp/{subjectId}/accountBalance?onlyOpenItems="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        Boolean onlyOpenItems = true; // Boolean | Flag if only open items should be retrieved; otherwise (FALSE) all items are retrieved.
        try {
            array[APISLDItem] result = apiInstance.getAccountBalanceItems(subjectId, onlyOpenItems);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getAccountBalanceItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        Boolean onlyOpenItems = true; // Boolean | Flag if only open items should be retrieved; otherwise (FALSE) all items are retrieved.
        try {
            array[APISLDItem] result = apiInstance.getAccountBalanceItems(subjectId, onlyOpenItems);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getAccountBalanceItems");
            e.printStackTrace();
        }
    }
}
Integer *subjectId = 56; // Business partner identifier
Boolean *onlyOpenItems = true; // Flag if only open items should be retrieved; otherwise (FALSE) all items are retrieved.

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

// Account balance items (all or only open items).
[apiInstance getAccountBalanceItemsWith:subjectId
    onlyOpenItems:onlyOpenItems
              completionHandler: ^(array[APISLDItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var subjectId = 56; // {Integer} Business partner identifier

var onlyOpenItems = true; // {Boolean} Flag if only open items should be retrieved; otherwise (FALSE) all items are retrieved.


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

namespace Example
{
    public class getAccountBalanceItemsExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var subjectId = 56;  // Integer | Business partner identifier
            var onlyOpenItems = true;  // Boolean | Flag if only open items should be retrieved; otherwise (FALSE) all items are retrieved.

            try
            {
                // Account balance items (all or only open items).
                array[APISLDItem] result = apiInstance.getAccountBalanceItems(subjectId, onlyOpenItems);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getAccountBalanceItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$subjectId = 56; // Integer | Business partner identifier
$onlyOpenItems = true; // Boolean | Flag if only open items should be retrieved; otherwise (FALSE) all items are retrieved.

try {
    $result = $api_instance->getAccountBalanceItems($subjectId, $onlyOpenItems);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getAccountBalanceItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $subjectId = 56; # Integer | Business partner identifier
my $onlyOpenItems = true; # Boolean | Flag if only open items should be retrieved; otherwise (FALSE) all items are retrieved.

eval { 
    my $result = $api_instance->getAccountBalanceItems(subjectId => $subjectId, onlyOpenItems => $onlyOpenItems);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getAccountBalanceItems: $@\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.CcaworkplaceApi()
subjectId = 56 # Integer | Business partner identifier
onlyOpenItems = true # Boolean | Flag if only open items should be retrieved; otherwise (FALSE) all items are retrieved.

try: 
    # Account balance items (all or only open items).
    api_response = api_instance.get_account_balance_items(subjectId, onlyOpenItems)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getAccountBalanceItems: %s\n" % e)

Parameters

Path parameters
Name Description
subjectId*
Integer (int32)
Business partner identifier
Required
Query parameters
Name Description
onlyOpenItems*
Boolean
Flag if only open items should be retrieved; otherwise (FALSE) all items are retrieved.
Required

Responses

Status: 200 - successful operation


getBankAccounts

List of business partner bank accounts.


/api/wp/{subjectId}/accounts

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/{subjectId}/accounts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        try {
            array['String'] result = apiInstance.getBankAccounts(subjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getBankAccounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        try {
            array['String'] result = apiInstance.getBankAccounts(subjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getBankAccounts");
            e.printStackTrace();
        }
    }
}
Integer *subjectId = 56; // Business partner identifier

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

// List of business partner bank accounts.
[apiInstance getBankAccountsWith:subjectId
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var subjectId = 56; // {Integer} Business partner identifier


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

namespace Example
{
    public class getBankAccountsExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var subjectId = 56;  // Integer | Business partner identifier

            try
            {
                // List of business partner bank accounts.
                array['String'] result = apiInstance.getBankAccounts(subjectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getBankAccounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$subjectId = 56; // Integer | Business partner identifier

try {
    $result = $api_instance->getBankAccounts($subjectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getBankAccounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $subjectId = 56; # Integer | Business partner identifier

eval { 
    my $result = $api_instance->getBankAccounts(subjectId => $subjectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getBankAccounts: $@\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.CcaworkplaceApi()
subjectId = 56 # Integer | Business partner identifier

try: 
    # List of business partner bank accounts.
    api_response = api_instance.get_bank_accounts(subjectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getBankAccounts: %s\n" % e)

Parameters

Path parameters
Name Description
subjectId*
Integer (int32)
Business partner identifier
Required

Responses

Status: 200 - successful operation


getBudgetBillingPlan

List of actual budget billing plan items for contract object.<br>Returns NULL if there is no valid budget billing plan for contract object.


/api/wp/{contractObjectId}/bbPlanItems

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/{contractObjectId}/bbPlanItems"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer contractObjectId = 56; // Integer | Contract object identifier
        try {
            array[APIBudgetBillingPlanItem] result = apiInstance.getBudgetBillingPlan(contractObjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getBudgetBillingPlan");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer contractObjectId = 56; // Integer | Contract object identifier
        try {
            array[APIBudgetBillingPlanItem] result = apiInstance.getBudgetBillingPlan(contractObjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getBudgetBillingPlan");
            e.printStackTrace();
        }
    }
}
Integer *contractObjectId = 56; // Contract object identifier

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

// List of actual budget billing plan items for contract object.
Returns NULL if there is no valid budget billing plan for contract object. [apiInstance getBudgetBillingPlanWith:contractObjectId completionHandler: ^(array[APIBudgetBillingPlanItem] output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

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


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

namespace Example
{
    public class getBudgetBillingPlanExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var contractObjectId = 56;  // Integer | Contract object identifier

            try
            {
                // List of actual budget billing plan items for contract object.
Returns NULL if there is no valid budget billing plan for contract object. array[APIBudgetBillingPlanItem] result = apiInstance.getBudgetBillingPlan(contractObjectId); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling CcaworkplaceApi.getBudgetBillingPlan: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $result = $api_instance->getBudgetBillingPlan($contractObjectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getBudgetBillingPlan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

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

eval { 
    my $result = $api_instance->getBudgetBillingPlan(contractObjectId => $contractObjectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getBudgetBillingPlan: $@\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.CcaworkplaceApi()
contractObjectId = 56 # Integer | Contract object identifier

try: 
    # List of actual budget billing plan items for contract object.
Returns NULL if there is no valid budget billing plan for contract object. api_response = api_instance.get_budget_billing_plan(contractObjectId) pprint(api_response) except ApiException as e: print("Exception when calling CcaworkplaceApi->getBudgetBillingPlan: %s\n" % e)

Parameters

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

Responses

Status: 200 - successful operation


getBusinessPartnerDetail

Information about business partner.


/api/wp/{subjectId}/subject

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/{subjectId}/subject"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        try {
            APISubject result = apiInstance.getBusinessPartnerDetail(subjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getBusinessPartnerDetail");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        try {
            APISubject result = apiInstance.getBusinessPartnerDetail(subjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getBusinessPartnerDetail");
            e.printStackTrace();
        }
    }
}
Integer *subjectId = 56; // Business partner identifier

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

// Information about business partner.
[apiInstance getBusinessPartnerDetailWith:subjectId
              completionHandler: ^(APISubject output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var subjectId = 56; // {Integer} Business partner identifier


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

namespace Example
{
    public class getBusinessPartnerDetailExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var subjectId = 56;  // Integer | Business partner identifier

            try
            {
                // Information about business partner.
                APISubject result = apiInstance.getBusinessPartnerDetail(subjectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getBusinessPartnerDetail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$subjectId = 56; // Integer | Business partner identifier

try {
    $result = $api_instance->getBusinessPartnerDetail($subjectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getBusinessPartnerDetail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $subjectId = 56; # Integer | Business partner identifier

eval { 
    my $result = $api_instance->getBusinessPartnerDetail(subjectId => $subjectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getBusinessPartnerDetail: $@\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.CcaworkplaceApi()
subjectId = 56 # Integer | Business partner identifier

try: 
    # Information about business partner.
    api_response = api_instance.get_business_partner_detail(subjectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getBusinessPartnerDetail: %s\n" % e)

Parameters

Path parameters
Name Description
subjectId*
Integer (int32)
Business partner identifier
Required

Responses

Status: 200 - successful operation


getBusinessPartnerIdentifier1

Map business partner registration number to identifier


/api/wp/bp/id/{bpNumber}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/bp/id/{bpNumber}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        String bpNumber = bpNumber_example; // String | Business partner registration number
        try {
            'Integer' result = apiInstance.getBusinessPartnerIdentifier1(bpNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getBusinessPartnerIdentifier1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        String bpNumber = bpNumber_example; // String | Business partner registration number
        try {
            'Integer' result = apiInstance.getBusinessPartnerIdentifier1(bpNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getBusinessPartnerIdentifier1");
            e.printStackTrace();
        }
    }
}
String *bpNumber = bpNumber_example; // Business partner registration number

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

// Map business partner registration number to identifier
[apiInstance getBusinessPartnerIdentifier1With:bpNumber
              completionHandler: ^('Integer' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var bpNumber = bpNumber_example; // {String} Business partner registration number


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

namespace Example
{
    public class getBusinessPartnerIdentifier1Example
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var bpNumber = bpNumber_example;  // String | Business partner registration number

            try
            {
                // Map business partner registration number to identifier
                'Integer' result = apiInstance.getBusinessPartnerIdentifier1(bpNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getBusinessPartnerIdentifier1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$bpNumber = bpNumber_example; // String | Business partner registration number

try {
    $result = $api_instance->getBusinessPartnerIdentifier1($bpNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getBusinessPartnerIdentifier1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $bpNumber = bpNumber_example; # String | Business partner registration number

eval { 
    my $result = $api_instance->getBusinessPartnerIdentifier1(bpNumber => $bpNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getBusinessPartnerIdentifier1: $@\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.CcaworkplaceApi()
bpNumber = bpNumber_example # String | Business partner registration number

try: 
    # Map business partner registration number to identifier
    api_response = api_instance.get_business_partner_identifier1(bpNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getBusinessPartnerIdentifier1: %s\n" % e)

Parameters

Path parameters
Name Description
bpNumber*
String
Business partner registration number
Required

Responses

Status: 200 - successful operation


getBusinessPartnerPInteractions

List of registered interactions with business partner.


/api/wp/crm/interactions/bp/{id}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/crm/interactions/bp/{id}?from=&to=&maxCount="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer id = 56; // Integer | Business partner identifier
        Date from = 2013-10-20T19:20:30+01:00; // Date | Restriction for interactions starting time. Value NULL means no restriction, otherwise applies for interactions started after specified time.
        Date to = 2013-10-20T19:20:30+01:00; // Date | Restriction for interactions ending time. Value NULL means no restriction, otherwise applies for interactions ended before specified time.
        Integer maxCount = 56; // Integer | Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit.
        try {
            array[APIInteraction] result = apiInstance.getBusinessPartnerPInteractions(id, from, to, maxCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getBusinessPartnerPInteractions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer id = 56; // Integer | Business partner identifier
        Date from = 2013-10-20T19:20:30+01:00; // Date | Restriction for interactions starting time. Value NULL means no restriction, otherwise applies for interactions started after specified time.
        Date to = 2013-10-20T19:20:30+01:00; // Date | Restriction for interactions ending time. Value NULL means no restriction, otherwise applies for interactions ended before specified time.
        Integer maxCount = 56; // Integer | Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit.
        try {
            array[APIInteraction] result = apiInstance.getBusinessPartnerPInteractions(id, from, to, maxCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getBusinessPartnerPInteractions");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Business partner identifier
Date *from = 2013-10-20T19:20:30+01:00; // Restriction for interactions starting time. Value NULL means no restriction, otherwise applies for interactions started after specified time. (optional)
Date *to = 2013-10-20T19:20:30+01:00; // Restriction for interactions ending time. Value NULL means no restriction, otherwise applies for interactions ended before specified time. (optional)
Integer *maxCount = 56; // Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit. (optional)

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

// List of registered interactions with business partner.
[apiInstance getBusinessPartnerPInteractionsWith:id
    from:from
    to:to
    maxCount:maxCount
              completionHandler: ^(array[APIInteraction] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var id = 56; // {Integer} Business partner identifier

var opts = { 
  'from': 2013-10-20T19:20:30+01:00, // {Date} Restriction for interactions starting time. Value NULL means no restriction, otherwise applies for interactions started after specified time.
  'to': 2013-10-20T19:20:30+01:00, // {Date} Restriction for interactions ending time. Value NULL means no restriction, otherwise applies for interactions ended before specified time.
  'maxCount': 56 // {Integer} Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit.
};

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

namespace Example
{
    public class getBusinessPartnerPInteractionsExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var id = 56;  // Integer | Business partner identifier
            var from = 2013-10-20T19:20:30+01:00;  // Date | Restriction for interactions starting time. Value NULL means no restriction, otherwise applies for interactions started after specified time. (optional) 
            var to = 2013-10-20T19:20:30+01:00;  // Date | Restriction for interactions ending time. Value NULL means no restriction, otherwise applies for interactions ended before specified time. (optional) 
            var maxCount = 56;  // Integer | Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit. (optional) 

            try
            {
                // List of registered interactions with business partner.
                array[APIInteraction] result = apiInstance.getBusinessPartnerPInteractions(id, from, to, maxCount);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getBusinessPartnerPInteractions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$id = 56; // Integer | Business partner identifier
$from = 2013-10-20T19:20:30+01:00; // Date | Restriction for interactions starting time. Value NULL means no restriction, otherwise applies for interactions started after specified time.
$to = 2013-10-20T19:20:30+01:00; // Date | Restriction for interactions ending time. Value NULL means no restriction, otherwise applies for interactions ended before specified time.
$maxCount = 56; // Integer | Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit.

try {
    $result = $api_instance->getBusinessPartnerPInteractions($id, $from, $to, $maxCount);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getBusinessPartnerPInteractions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $id = 56; # Integer | Business partner identifier
my $from = 2013-10-20T19:20:30+01:00; # Date | Restriction for interactions starting time. Value NULL means no restriction, otherwise applies for interactions started after specified time.
my $to = 2013-10-20T19:20:30+01:00; # Date | Restriction for interactions ending time. Value NULL means no restriction, otherwise applies for interactions ended before specified time.
my $maxCount = 56; # Integer | Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit.

eval { 
    my $result = $api_instance->getBusinessPartnerPInteractions(id => $id, from => $from, to => $to, maxCount => $maxCount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getBusinessPartnerPInteractions: $@\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.CcaworkplaceApi()
id = 56 # Integer | Business partner identifier
from = 2013-10-20T19:20:30+01:00 # Date | Restriction for interactions starting time. Value NULL means no restriction, otherwise applies for interactions started after specified time. (optional)
to = 2013-10-20T19:20:30+01:00 # Date | Restriction for interactions ending time. Value NULL means no restriction, otherwise applies for interactions ended before specified time. (optional)
maxCount = 56 # Integer | Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit. (optional)

try: 
    # List of registered interactions with business partner.
    api_response = api_instance.get_business_partner_p_interactions(id, from=from, to=to, maxCount=maxCount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getBusinessPartnerPInteractions: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Business partner identifier
Required
Query parameters
Name Description
from
Date (date-time)
Restriction for interactions starting time. Value NULL means no restriction, otherwise applies for interactions started after specified time.
to
Date (date-time)
Restriction for interactions ending time. Value NULL means no restriction, otherwise applies for interactions ended before specified time.
maxCount
Integer (int32)
Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit.

Responses

Status: 200 - successful operation


getContractDocument

Contract/amendment document.


/api/wp/document/contract/{regNumber}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/document/contract/{regNumber}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        String regNumber = regNumber_example; // String | Contract/amendment registration number
        try {
            'String' result = apiInstance.getContractDocument(regNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getContractDocument");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        String regNumber = regNumber_example; // String | Contract/amendment registration number
        try {
            'String' result = apiInstance.getContractDocument(regNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getContractDocument");
            e.printStackTrace();
        }
    }
}
String *regNumber = regNumber_example; // Contract/amendment registration number

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

// Contract/amendment document.
[apiInstance getContractDocumentWith:regNumber
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var regNumber = regNumber_example; // {String} Contract/amendment registration number


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

namespace Example
{
    public class getContractDocumentExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var regNumber = regNumber_example;  // String | Contract/amendment registration number

            try
            {
                // Contract/amendment document.
                'String' result = apiInstance.getContractDocument(regNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getContractDocument: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$regNumber = regNumber_example; // String | Contract/amendment registration number

try {
    $result = $api_instance->getContractDocument($regNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getContractDocument: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $regNumber = regNumber_example; # String | Contract/amendment registration number

eval { 
    my $result = $api_instance->getContractDocument(regNumber => $regNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getContractDocument: $@\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.CcaworkplaceApi()
regNumber = regNumber_example # String | Contract/amendment registration number

try: 
    # Contract/amendment document.
    api_response = api_instance.get_contract_document(regNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getContractDocument: %s\n" % e)

Parameters

Path parameters
Name Description
regNumber*
String
Contract/amendment registration number
Required

Responses

Status: 200 - successful operation


getContractObjectsDetails

List of business partner contract objects details.


/api/wp/{subjectId}/contracts/detail

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/{subjectId}/contracts/detail?coIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        array[Integer] coIds = ; // array[Integer] | Contract objects identifiers
        try {
            array[APIContractObject] result = apiInstance.getContractObjectsDetails(subjectId, coIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getContractObjectsDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        array[Integer] coIds = ; // array[Integer] | Contract objects identifiers
        try {
            array[APIContractObject] result = apiInstance.getContractObjectsDetails(subjectId, coIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getContractObjectsDetails");
            e.printStackTrace();
        }
    }
}
Integer *subjectId = 56; // Business partner identifier
array[Integer] *coIds = ; // Contract objects identifiers (optional)

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

// List of business partner contract objects details.
[apiInstance getContractObjectsDetailsWith:subjectId
    coIds:coIds
              completionHandler: ^(array[APIContractObject] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var subjectId = 56; // {Integer} Business partner identifier

var opts = { 
  'coIds':  // {array[Integer]} Contract objects identifiers
};

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

namespace Example
{
    public class getContractObjectsDetailsExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var subjectId = 56;  // Integer | Business partner identifier
            var coIds = new array[Integer](); // array[Integer] | Contract objects identifiers (optional) 

            try
            {
                // List of business partner contract objects details.
                array[APIContractObject] result = apiInstance.getContractObjectsDetails(subjectId, coIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getContractObjectsDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$subjectId = 56; // Integer | Business partner identifier
$coIds = ; // array[Integer] | Contract objects identifiers

try {
    $result = $api_instance->getContractObjectsDetails($subjectId, $coIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getContractObjectsDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $subjectId = 56; # Integer | Business partner identifier
my $coIds = []; # array[Integer] | Contract objects identifiers

eval { 
    my $result = $api_instance->getContractObjectsDetails(subjectId => $subjectId, coIds => $coIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getContractObjectsDetails: $@\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.CcaworkplaceApi()
subjectId = 56 # Integer | Business partner identifier
coIds =  # array[Integer] | Contract objects identifiers (optional)

try: 
    # List of business partner contract objects details.
    api_response = api_instance.get_contract_objects_details(subjectId, coIds=coIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getContractObjectsDetails: %s\n" % e)

Parameters

Path parameters
Name Description
subjectId*
Integer (int32)
Business partner identifier
Required
Query parameters
Name Description
coIds
array[Integer] (int32)
Contract objects identifiers

Responses

Status: 200 - successful operation


getContracts

List of business partner contracts and amendments.


/api/wp/{subjectId}/contracts

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/{subjectId}/contracts?fillStatData=&fillProducts="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        Boolean fillStatData = true; // Boolean | Flag about filling statistic data
        Boolean fillProducts = true; // Boolean | Flag about filling products
        try {
            array[APIContractAmendment] result = apiInstance.getContracts(subjectId, fillStatData, fillProducts);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getContracts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        Boolean fillStatData = true; // Boolean | Flag about filling statistic data
        Boolean fillProducts = true; // Boolean | Flag about filling products
        try {
            array[APIContractAmendment] result = apiInstance.getContracts(subjectId, fillStatData, fillProducts);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getContracts");
            e.printStackTrace();
        }
    }
}
Integer *subjectId = 56; // Business partner identifier
Boolean *fillStatData = true; // Flag about filling statistic data (optional)
Boolean *fillProducts = true; // Flag about filling products (optional)

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

// List of business partner contracts and amendments.
[apiInstance getContractsWith:subjectId
    fillStatData:fillStatData
    fillProducts:fillProducts
              completionHandler: ^(array[APIContractAmendment] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var subjectId = 56; // {Integer} Business partner identifier

var opts = { 
  'fillStatData': true, // {Boolean} Flag about filling statistic data
  'fillProducts': true // {Boolean} Flag about filling products
};

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

namespace Example
{
    public class getContractsExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var subjectId = 56;  // Integer | Business partner identifier
            var fillStatData = true;  // Boolean | Flag about filling statistic data (optional) 
            var fillProducts = true;  // Boolean | Flag about filling products (optional) 

            try
            {
                // List of business partner contracts and amendments.
                array[APIContractAmendment] result = apiInstance.getContracts(subjectId, fillStatData, fillProducts);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getContracts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$subjectId = 56; // Integer | Business partner identifier
$fillStatData = true; // Boolean | Flag about filling statistic data
$fillProducts = true; // Boolean | Flag about filling products

try {
    $result = $api_instance->getContracts($subjectId, $fillStatData, $fillProducts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getContracts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $subjectId = 56; # Integer | Business partner identifier
my $fillStatData = true; # Boolean | Flag about filling statistic data
my $fillProducts = true; # Boolean | Flag about filling products

eval { 
    my $result = $api_instance->getContracts(subjectId => $subjectId, fillStatData => $fillStatData, fillProducts => $fillProducts);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getContracts: $@\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.CcaworkplaceApi()
subjectId = 56 # Integer | Business partner identifier
fillStatData = true # Boolean | Flag about filling statistic data (optional)
fillProducts = true # Boolean | Flag about filling products (optional)

try: 
    # List of business partner contracts and amendments.
    api_response = api_instance.get_contracts(subjectId, fillStatData=fillStatData, fillProducts=fillProducts)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getContracts: %s\n" % e)

Parameters

Path parameters
Name Description
subjectId*
Integer (int32)
Business partner identifier
Required
Query parameters
Name Description
fillStatData
Boolean
Flag about filling statistic data
fillProducts
Boolean
Flag about filling products

Responses

Status: 200 - successful operation


getDocumentContent

Retrieve content of the document


/api/wp/document/{type}/content/{number}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/document/{type}/content/{number}?exception="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        String type = type_example; // String | Object type
        String number = number_example; // String | Object number
        Boolean exception = true; // Boolean | Specifies behaviour if there is no document for specified object. If FALSE, then empty response is returned in that case.
        try {
            apiInstance.getDocumentContent(type, number, exception);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getDocumentContent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        String type = type_example; // String | Object type
        String number = number_example; // String | Object number
        Boolean exception = true; // Boolean | Specifies behaviour if there is no document for specified object. If FALSE, then empty response is returned in that case.
        try {
            apiInstance.getDocumentContent(type, number, exception);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getDocumentContent");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // Object type
String *number = number_example; // Object number
Boolean *exception = true; // Specifies behaviour if there is no document for specified object. If FALSE, then empty response is returned in that case.

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

// Retrieve content of the document
[apiInstance getDocumentContentWith:type
    number:number
    exception:exception
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var type = type_example; // {String} Object type

var number = number_example; // {String} Object number

var exception = true; // {Boolean} Specifies behaviour if there is no document for specified object. If FALSE, then empty response is returned in that case.


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

namespace Example
{
    public class getDocumentContentExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var type = type_example;  // String | Object type
            var number = number_example;  // String | Object number
            var exception = true;  // Boolean | Specifies behaviour if there is no document for specified object. If FALSE, then empty response is returned in that case.

            try
            {
                // Retrieve content of the document
                apiInstance.getDocumentContent(type, number, exception);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getDocumentContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$type = type_example; // String | Object type
$number = number_example; // String | Object number
$exception = true; // Boolean | Specifies behaviour if there is no document for specified object. If FALSE, then empty response is returned in that case.

try {
    $api_instance->getDocumentContent($type, $number, $exception);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getDocumentContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $type = type_example; # String | Object type
my $number = number_example; # String | Object number
my $exception = true; # Boolean | Specifies behaviour if there is no document for specified object. If FALSE, then empty response is returned in that case.

eval { 
    $api_instance->getDocumentContent(type => $type, number => $number, exception => $exception);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getDocumentContent: $@\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.CcaworkplaceApi()
type = type_example # String | Object type
number = number_example # String | Object number
exception = true # Boolean | Specifies behaviour if there is no document for specified object. If FALSE, then empty response is returned in that case.

try: 
    # Retrieve content of the document
    api_instance.get_document_content(type, number, exception)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getDocumentContent: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Object type
Required
number*
String
Object number
Required
Query parameters
Name Description
exception*
Boolean
Specifies behaviour if there is no document for specified object. If FALSE, then empty response is returned in that case.
Required

Responses

Status: default - successful operation


getDunningDocument

Retrieve dunning document.


/api/wp/document/reminder/{number}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/document/reminder/{number}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Long number = 789; // Long | Document identifier
        try {
            'String' result = apiInstance.getDunningDocument(number);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getDunningDocument");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Long number = 789; // Long | Document identifier
        try {
            'String' result = apiInstance.getDunningDocument(number);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getDunningDocument");
            e.printStackTrace();
        }
    }
}
Long *number = 789; // Document identifier

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

// Retrieve dunning document.
[apiInstance getDunningDocumentWith:number
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var number = 789; // {Long} Document identifier


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

namespace Example
{
    public class getDunningDocumentExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var number = 789;  // Long | Document identifier

            try
            {
                // Retrieve dunning document.
                'String' result = apiInstance.getDunningDocument(number);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getDunningDocument: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$number = 789; // Long | Document identifier

try {
    $result = $api_instance->getDunningDocument($number);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getDunningDocument: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $number = 789; # Long | Document identifier

eval { 
    my $result = $api_instance->getDunningDocument(number => $number);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getDunningDocument: $@\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.CcaworkplaceApi()
number = 789 # Long | Document identifier

try: 
    # Retrieve dunning document.
    api_response = api_instance.get_dunning_document(number)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getDunningDocument: %s\n" % e)

Parameters

Path parameters
Name Description
number*
Long (int64)
Document identifier
Required

Responses

Status: 200 - successful operation


getInvoiceDocument

Invoice document.


/api/wp/document/invoice/{number}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/document/invoice/{number}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        String number = number_example; // String | Invoice number
        try {
            'String' result = apiInstance.getInvoiceDocument(number);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getInvoiceDocument");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        String number = number_example; // String | Invoice number
        try {
            'String' result = apiInstance.getInvoiceDocument(number);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getInvoiceDocument");
            e.printStackTrace();
        }
    }
}
String *number = number_example; // Invoice number

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

// Invoice document.
[apiInstance getInvoiceDocumentWith:number
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var number = number_example; // {String} Invoice number


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

namespace Example
{
    public class getInvoiceDocumentExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var number = number_example;  // String | Invoice number

            try
            {
                // Invoice document.
                'String' result = apiInstance.getInvoiceDocument(number);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getInvoiceDocument: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$number = number_example; // String | Invoice number

try {
    $result = $api_instance->getInvoiceDocument($number);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getInvoiceDocument: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $number = number_example; # String | Invoice number

eval { 
    my $result = $api_instance->getInvoiceDocument(number => $number);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getInvoiceDocument: $@\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.CcaworkplaceApi()
number = number_example # String | Invoice number

try: 
    # Invoice document.
    api_response = api_instance.get_invoice_document(number)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getInvoiceDocument: %s\n" % e)

Parameters

Path parameters
Name Description
number*
String
Invoice number
Required

Responses

Status: 200 - successful operation


getInvoices

List of business partner invoices.


/api/wp/{subjectId}/invoices

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/{subjectId}/invoices"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        try {
            array[APIInvoice] result = apiInstance.getInvoices(subjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getInvoices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        try {
            array[APIInvoice] result = apiInstance.getInvoices(subjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getInvoices");
            e.printStackTrace();
        }
    }
}
Integer *subjectId = 56; // Business partner identifier

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

// List of business partner invoices.
[apiInstance getInvoicesWith:subjectId
              completionHandler: ^(array[APIInvoice] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var subjectId = 56; // {Integer} Business partner identifier


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

namespace Example
{
    public class getInvoicesExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var subjectId = 56;  // Integer | Business partner identifier

            try
            {
                // List of business partner invoices.
                array[APIInvoice] result = apiInstance.getInvoices(subjectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getInvoices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$subjectId = 56; // Integer | Business partner identifier

try {
    $result = $api_instance->getInvoices($subjectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getInvoices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $subjectId = 56; # Integer | Business partner identifier

eval { 
    my $result = $api_instance->getInvoices(subjectId => $subjectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getInvoices: $@\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.CcaworkplaceApi()
subjectId = 56 # Integer | Business partner identifier

try: 
    # List of business partner invoices.
    api_response = api_instance.get_invoices(subjectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getInvoices: %s\n" % e)

Parameters

Path parameters
Name Description
subjectId*
Integer (int32)
Business partner identifier
Required

Responses

Status: 200 - successful operation


getInvoicingAddresses

List of business partner invoicing addresses.


/api/wp/{subjectId}/address

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/{subjectId}/address"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        try {
            array['String'] result = apiInstance.getInvoicingAddresses(subjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getInvoicingAddresses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        try {
            array['String'] result = apiInstance.getInvoicingAddresses(subjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getInvoicingAddresses");
            e.printStackTrace();
        }
    }
}
Integer *subjectId = 56; // Business partner identifier

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

// List of business partner invoicing addresses.
[apiInstance getInvoicingAddressesWith:subjectId
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var subjectId = 56; // {Integer} Business partner identifier


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

namespace Example
{
    public class getInvoicingAddressesExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var subjectId = 56;  // Integer | Business partner identifier

            try
            {
                // List of business partner invoicing addresses.
                array['String'] result = apiInstance.getInvoicingAddresses(subjectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getInvoicingAddresses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$subjectId = 56; // Integer | Business partner identifier

try {
    $result = $api_instance->getInvoicingAddresses($subjectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getInvoicingAddresses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $subjectId = 56; # Integer | Business partner identifier

eval { 
    my $result = $api_instance->getInvoicingAddresses(subjectId => $subjectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getInvoicingAddresses: $@\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.CcaworkplaceApi()
subjectId = 56 # Integer | Business partner identifier

try: 
    # List of business partner invoicing addresses.
    api_response = api_instance.get_invoicing_addresses(subjectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getInvoicingAddresses: %s\n" % e)

Parameters

Path parameters
Name Description
subjectId*
Integer (int32)
Business partner identifier
Required

Responses

Status: 200 - successful operation


getLatestSentDocuments

List of latest documents sent to business partner.


/api/wp/{subjectId}/recent

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/{subjectId}/recent"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        try {
            array[APIDocument] result = apiInstance.getLatestSentDocuments(subjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getLatestSentDocuments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer subjectId = 56; // Integer | Business partner identifier
        try {
            array[APIDocument] result = apiInstance.getLatestSentDocuments(subjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getLatestSentDocuments");
            e.printStackTrace();
        }
    }
}
Integer *subjectId = 56; // Business partner identifier

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

// List of latest documents sent to business partner.
[apiInstance getLatestSentDocumentsWith:subjectId
              completionHandler: ^(array[APIDocument] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var subjectId = 56; // {Integer} Business partner identifier


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

namespace Example
{
    public class getLatestSentDocumentsExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var subjectId = 56;  // Integer | Business partner identifier

            try
            {
                // List of latest documents sent to business partner.
                array[APIDocument] result = apiInstance.getLatestSentDocuments(subjectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getLatestSentDocuments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$subjectId = 56; // Integer | Business partner identifier

try {
    $result = $api_instance->getLatestSentDocuments($subjectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getLatestSentDocuments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $subjectId = 56; # Integer | Business partner identifier

eval { 
    my $result = $api_instance->getLatestSentDocuments(subjectId => $subjectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getLatestSentDocuments: $@\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.CcaworkplaceApi()
subjectId = 56 # Integer | Business partner identifier

try: 
    # List of latest documents sent to business partner.
    api_response = api_instance.get_latest_sent_documents(subjectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getLatestSentDocuments: %s\n" % e)

Parameters

Path parameters
Name Description
subjectId*
Integer (int32)
Business partner identifier
Required

Responses

Status: 200 - successful operation


getProducts

List of products in contract object.


/api/wp/{contractObjectId}/products

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/{contractObjectId}/products"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer contractObjectId = 56; // Integer | Contract object identifier
        try {
            array[APIProduct] result = apiInstance.getProducts(contractObjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer contractObjectId = 56; // Integer | Contract object identifier
        try {
            array[APIProduct] result = apiInstance.getProducts(contractObjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getProducts");
            e.printStackTrace();
        }
    }
}
Integer *contractObjectId = 56; // Contract object identifier

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

// List of products in contract object.
[apiInstance getProductsWith:contractObjectId
              completionHandler: ^(array[APIProduct] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

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


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

namespace Example
{
    public class getProductsExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var contractObjectId = 56;  // Integer | Contract object identifier

            try
            {
                // List of products in contract object.
                array[APIProduct] result = apiInstance.getProducts(contractObjectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $result = $api_instance->getProducts($contractObjectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getProducts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

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

eval { 
    my $result = $api_instance->getProducts(contractObjectId => $contractObjectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getProducts: $@\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.CcaworkplaceApi()
contractObjectId = 56 # Integer | Contract object identifier

try: 
    # List of products in contract object.
    api_response = api_instance.get_products(contractObjectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getProducts: %s\n" % e)

Parameters

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

Responses

Status: 200 - successful operation


getUserInteractions

List of interactions registered by user/employee.


/api/wp/crm/interactions/user/{login}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/wp/crm/interactions/user/{login}?active=&maxCount="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        String login = login_example; // String | User/employee login
        Boolean active = true; // Boolean | Flag to retrieve only currently active interactions. If FALSE, then all interactions registered by user are retrieved.
        Integer maxCount = 56; // Integer | Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit.
        try {
            array[APIInteraction] result = apiInstance.getUserInteractions(login, active, maxCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getUserInteractions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        String login = login_example; // String | User/employee login
        Boolean active = true; // Boolean | Flag to retrieve only currently active interactions. If FALSE, then all interactions registered by user are retrieved.
        Integer maxCount = 56; // Integer | Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit.
        try {
            array[APIInteraction] result = apiInstance.getUserInteractions(login, active, maxCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#getUserInteractions");
            e.printStackTrace();
        }
    }
}
String *login = login_example; // User/employee login
Boolean *active = true; // Flag to retrieve only currently active interactions. If FALSE, then all interactions registered by user are retrieved. (optional)
Integer *maxCount = 56; // Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit. (optional)

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

// List of interactions registered by user/employee.
[apiInstance getUserInteractionsWith:login
    active:active
    maxCount:maxCount
              completionHandler: ^(array[APIInteraction] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var login = login_example; // {String} User/employee login

var opts = { 
  'active': true, // {Boolean} Flag to retrieve only currently active interactions. If FALSE, then all interactions registered by user are retrieved.
  'maxCount': 56 // {Integer} Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit.
};

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

namespace Example
{
    public class getUserInteractionsExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var login = login_example;  // String | User/employee login
            var active = true;  // Boolean | Flag to retrieve only currently active interactions. If FALSE, then all interactions registered by user are retrieved. (optional) 
            var maxCount = 56;  // Integer | Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit. (optional) 

            try
            {
                // List of interactions registered by user/employee.
                array[APIInteraction] result = apiInstance.getUserInteractions(login, active, maxCount);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.getUserInteractions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$login = login_example; // String | User/employee login
$active = true; // Boolean | Flag to retrieve only currently active interactions. If FALSE, then all interactions registered by user are retrieved.
$maxCount = 56; // Integer | Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit.

try {
    $result = $api_instance->getUserInteractions($login, $active, $maxCount);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcaworkplaceApi->getUserInteractions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcaworkplaceApi;

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $login = login_example; # String | User/employee login
my $active = true; # Boolean | Flag to retrieve only currently active interactions. If FALSE, then all interactions registered by user are retrieved.
my $maxCount = 56; # Integer | Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit.

eval { 
    my $result = $api_instance->getUserInteractions(login => $login, active => $active, maxCount => $maxCount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->getUserInteractions: $@\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.CcaworkplaceApi()
login = login_example # String | User/employee login
active = true # Boolean | Flag to retrieve only currently active interactions. If FALSE, then all interactions registered by user are retrieved. (optional)
maxCount = 56 # Integer | Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit. (optional)

try: 
    # List of interactions registered by user/employee.
    api_response = api_instance.get_user_interactions(login, active=active, maxCount=maxCount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->getUserInteractions: %s\n" % e)

Parameters

Path parameters
Name Description
login*
String
User/employee login
Required
Query parameters
Name Description
active
Boolean
Flag to retrieve only currently active interactions. If FALSE, then all interactions registered by user are retrieved.
maxCount
Integer (int32)
Limit for number of interactions. Value 0 means no restriction, otherwise number of retrieved interactions is up to the limit.

Responses

Status: 200 - successful operation


registerInteractionEnd

Register end of the interaction with business partner with the current time.


/api/wp/crm/interactions/{id}/end

Usage and SDK Samples

curl -X PUT "https://localhost/core/services/rest/core/api/wp/crm/interactions/{id}/end?notes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer id = 56; // Integer | Interaction identifier
        String notes = notes_example; // String | Notes about interaction ending. If it is null, then interaction notes remain unchanged.
        try {
            apiInstance.registerInteractionEnd(id, notes);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#registerInteractionEnd");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        Integer id = 56; // Integer | Interaction identifier
        String notes = notes_example; // String | Notes about interaction ending. If it is null, then interaction notes remain unchanged.
        try {
            apiInstance.registerInteractionEnd(id, notes);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#registerInteractionEnd");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Interaction identifier
String *notes = notes_example; // Notes about interaction ending. If it is null, then interaction notes remain unchanged. (optional)

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

// Register end of the interaction with business partner with the current time.
[apiInstance registerInteractionEndWith:id
    notes:notes
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var id = 56; // {Integer} Interaction identifier

var opts = { 
  'notes': notes_example // {String} Notes about interaction ending. If it is null, then interaction notes remain unchanged.
};

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

namespace Example
{
    public class registerInteractionEndExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var id = 56;  // Integer | Interaction identifier
            var notes = notes_example;  // String | Notes about interaction ending. If it is null, then interaction notes remain unchanged. (optional) 

            try
            {
                // Register end of the interaction with business partner with the current time.
                apiInstance.registerInteractionEnd(id, notes);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.registerInteractionEnd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$id = 56; // Integer | Interaction identifier
$notes = notes_example; // String | Notes about interaction ending. If it is null, then interaction notes remain unchanged.

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

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $id = 56; # Integer | Interaction identifier
my $notes = notes_example; # String | Notes about interaction ending. If it is null, then interaction notes remain unchanged.

eval { 
    $api_instance->registerInteractionEnd(id => $id, notes => $notes);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->registerInteractionEnd: $@\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.CcaworkplaceApi()
id = 56 # Integer | Interaction identifier
notes = notes_example # String | Notes about interaction ending. If it is null, then interaction notes remain unchanged. (optional)

try: 
    # Register end of the interaction with business partner with the current time.
    api_instance.register_interaction_end(id, notes=notes)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->registerInteractionEnd: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Interaction identifier
Required
Query parameters
Name Description
notes
String
Notes about interaction ending. If it is null, then interaction notes remain unchanged.

Responses

Status: default - successful operation


registerInteractionStart

Register start of the new interaction with business partner with the current time.


/api/wp/crm/interactions/start

Usage and SDK Samples

curl -X POST "https://localhost/core/services/rest/core/api/wp/crm/interactions/start"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcaworkplaceApi;

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

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        APIInteraction body = ; // APIInteraction | Interaction to register
        try {
            'Integer' result = apiInstance.registerInteractionStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#registerInteractionStart");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcaworkplaceApi;

public class CcaworkplaceApiExample {

    public static void main(String[] args) {
        CcaworkplaceApi apiInstance = new CcaworkplaceApi();
        APIInteraction body = ; // APIInteraction | Interaction to register
        try {
            'Integer' result = apiInstance.registerInteractionStart(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcaworkplaceApi#registerInteractionStart");
            e.printStackTrace();
        }
    }
}
APIInteraction *body = ; // Interaction to register (optional)

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

// Register start of the new interaction with business partner with the current time.
[apiInstance registerInteractionStartWith:body
              completionHandler: ^('Integer' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CcaworkplaceApi()

var opts = { 
  'body':  // {APIInteraction} Interaction to register
};

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

namespace Example
{
    public class registerInteractionStartExample
    {
        public void main()
        {
            
            var apiInstance = new CcaworkplaceApi();
            var body = new APIInteraction(); // APIInteraction | Interaction to register (optional) 

            try
            {
                // Register start of the new interaction with business partner with the current time.
                'Integer' result = apiInstance.registerInteractionStart(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcaworkplaceApi.registerInteractionStart: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CcaworkplaceApi();
$body = ; // APIInteraction | Interaction to register

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

my $api_instance = WWW::SwaggerClient::CcaworkplaceApi->new();
my $body = WWW::SwaggerClient::Object::APIInteraction->new(); # APIInteraction | Interaction to register

eval { 
    my $result = $api_instance->registerInteractionStart(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcaworkplaceApi->registerInteractionStart: $@\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.CcaworkplaceApi()
body =  # APIInteraction | Interaction to register (optional)

try: 
    # Register start of the new interaction with business partner with the current time.
    api_response = api_instance.register_interaction_start(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcaworkplaceApi->registerInteractionStart: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - successful operation


Commoditiescore

activateContract

Activate contract attributes


/api/comm/contract/activate/{requestNumber}

Usage and SDK Samples

curl -X PUT "https://localhost/core/services/rest/core/api/comm/contract/activate/{requestNumber}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommoditiescoreApi;

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

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String requestNumber = requestNumber_example; // String | MCT request number
        APISupplyInfo body = ; // APISupplyInfo | Delivery point data
        try {
            apiInstance.activateContract(requestNumber, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#activateContract");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommoditiescoreApi;

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String requestNumber = requestNumber_example; // String | MCT request number
        APISupplyInfo body = ; // APISupplyInfo | Delivery point data
        try {
            apiInstance.activateContract(requestNumber, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#activateContract");
            e.printStackTrace();
        }
    }
}
String *requestNumber = requestNumber_example; // MCT request number
APISupplyInfo *body = ; // Delivery point data (optional)

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

// Activate contract attributes
[apiInstance activateContractWith:requestNumber
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CommoditiescoreApi()

var requestNumber = requestNumber_example; // {String} MCT request number

var opts = { 
  'body':  // {APISupplyInfo} Delivery point data
};

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

namespace Example
{
    public class activateContractExample
    {
        public void main()
        {
            
            var apiInstance = new CommoditiescoreApi();
            var requestNumber = requestNumber_example;  // String | MCT request number
            var body = new APISupplyInfo(); // APISupplyInfo | Delivery point data (optional) 

            try
            {
                // Activate contract attributes
                apiInstance.activateContract(requestNumber, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommoditiescoreApi.activateContract: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CommoditiescoreApi();
$requestNumber = requestNumber_example; // String | MCT request number
$body = ; // APISupplyInfo | Delivery point data

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

my $api_instance = WWW::SwaggerClient::CommoditiescoreApi->new();
my $requestNumber = requestNumber_example; # String | MCT request number
my $body = WWW::SwaggerClient::Object::APISupplyInfo->new(); # APISupplyInfo | Delivery point data

eval { 
    $api_instance->activateContract(requestNumber => $requestNumber, body => $body);
};
if ($@) {
    warn "Exception when calling CommoditiescoreApi->activateContract: $@\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.CommoditiescoreApi()
requestNumber = requestNumber_example # String | MCT request number
body =  # APISupplyInfo | Delivery point data (optional)

try: 
    # Activate contract attributes
    api_instance.activate_contract(requestNumber, body=body)
except ApiException as e:
    print("Exception when calling CommoditiescoreApi->activateContract: %s\n" % e)

Parameters

Path parameters
Name Description
requestNumber*
String
MCT request number
Required
Body parameters
Name Description
body

Responses

Status: default - successful operation


activateTerminateSupply

Activate supply termination


/api/comm/activateTerminateSupply/{requestNumber}

Usage and SDK Samples

curl -X POST "https://localhost/core/services/rest/core/api/comm/activateTerminateSupply/{requestNumber}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommoditiescoreApi;

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

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String requestNumber = requestNumber_example; // String | MCT request number
        try {
            apiInstance.activateTerminateSupply(requestNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#activateTerminateSupply");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommoditiescoreApi;

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String requestNumber = requestNumber_example; // String | MCT request number
        try {
            apiInstance.activateTerminateSupply(requestNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#activateTerminateSupply");
            e.printStackTrace();
        }
    }
}
String *requestNumber = requestNumber_example; // MCT request number

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

// Activate supply termination
[apiInstance activateTerminateSupplyWith:requestNumber
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CommoditiescoreApi()

var requestNumber = requestNumber_example; // {String} MCT request number


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

namespace Example
{
    public class activateTerminateSupplyExample
    {
        public void main()
        {
            
            var apiInstance = new CommoditiescoreApi();
            var requestNumber = requestNumber_example;  // String | MCT request number

            try
            {
                // Activate supply termination
                apiInstance.activateTerminateSupply(requestNumber);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommoditiescoreApi.activateTerminateSupply: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CommoditiescoreApi();
$requestNumber = requestNumber_example; // String | MCT request number

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

my $api_instance = WWW::SwaggerClient::CommoditiescoreApi->new();
my $requestNumber = requestNumber_example; # String | MCT request number

eval { 
    $api_instance->activateTerminateSupply(requestNumber => $requestNumber);
};
if ($@) {
    warn "Exception when calling CommoditiescoreApi->activateTerminateSupply: $@\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.CommoditiescoreApi()
requestNumber = requestNumber_example # String | MCT request number

try: 
    # Activate supply termination
    api_instance.activate_terminate_supply(requestNumber)
except ApiException as e:
    print("Exception when calling CommoditiescoreApi->activateTerminateSupply: %s\n" % e)

Parameters

Path parameters
Name Description
requestNumber*
String
MCT request number
Required

Responses

Status: default - successful operation


cancelContract

Cancel contract


/api/comm/contract/cancel/{requestNumber}

Usage and SDK Samples

curl -X PUT "https://localhost/core/services/rest/core/api/comm/contract/cancel/{requestNumber}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommoditiescoreApi;

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

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String requestNumber = requestNumber_example; // String | MCT request number
        try {
            apiInstance.cancelContract(requestNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#cancelContract");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommoditiescoreApi;

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String requestNumber = requestNumber_example; // String | MCT request number
        try {
            apiInstance.cancelContract(requestNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#cancelContract");
            e.printStackTrace();
        }
    }
}
String *requestNumber = requestNumber_example; // MCT request number

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

// Cancel contract
[apiInstance cancelContractWith:requestNumber
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CommoditiescoreApi()

var requestNumber = requestNumber_example; // {String} MCT request number


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

namespace Example
{
    public class cancelContractExample
    {
        public void main()
        {
            
            var apiInstance = new CommoditiescoreApi();
            var requestNumber = requestNumber_example;  // String | MCT request number

            try
            {
                // Cancel contract
                apiInstance.cancelContract(requestNumber);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommoditiescoreApi.cancelContract: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CommoditiescoreApi();
$requestNumber = requestNumber_example; // String | MCT request number

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

my $api_instance = WWW::SwaggerClient::CommoditiescoreApi->new();
my $requestNumber = requestNumber_example; # String | MCT request number

eval { 
    $api_instance->cancelContract(requestNumber => $requestNumber);
};
if ($@) {
    warn "Exception when calling CommoditiescoreApi->cancelContract: $@\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.CommoditiescoreApi()
requestNumber = requestNumber_example # String | MCT request number

try: 
    # Cancel contract
    api_instance.cancel_contract(requestNumber)
except ApiException as e:
    print("Exception when calling CommoditiescoreApi->cancelContract: %s\n" % e)

Parameters

Path parameters
Name Description
requestNumber*
String
MCT request number
Required

Responses

Status: default - successful operation


cancelTerminateSupply

Cancel supply termination


/api/comm/cancelTerminateSupply/{requestNumber}

Usage and SDK Samples

curl -X POST "https://localhost/core/services/rest/core/api/comm/cancelTerminateSupply/{requestNumber}?reason="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommoditiescoreApi;

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

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String requestNumber = requestNumber_example; // String | MCT request number
        String reason = reason_example; // String | Rejection reason
        try {
            apiInstance.cancelTerminateSupply(requestNumber, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#cancelTerminateSupply");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommoditiescoreApi;

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String requestNumber = requestNumber_example; // String | MCT request number
        String reason = reason_example; // String | Rejection reason
        try {
            apiInstance.cancelTerminateSupply(requestNumber, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#cancelTerminateSupply");
            e.printStackTrace();
        }
    }
}
String *requestNumber = requestNumber_example; // MCT request number
String *reason = reason_example; // Rejection reason

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

// Cancel supply termination
[apiInstance cancelTerminateSupplyWith:requestNumber
    reason:reason
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CommoditiescoreApi()

var requestNumber = requestNumber_example; // {String} MCT request number

var reason = reason_example; // {String} Rejection reason


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

namespace Example
{
    public class cancelTerminateSupplyExample
    {
        public void main()
        {
            
            var apiInstance = new CommoditiescoreApi();
            var requestNumber = requestNumber_example;  // String | MCT request number
            var reason = reason_example;  // String | Rejection reason

            try
            {
                // Cancel supply termination
                apiInstance.cancelTerminateSupply(requestNumber, reason);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommoditiescoreApi.cancelTerminateSupply: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CommoditiescoreApi();
$requestNumber = requestNumber_example; // String | MCT request number
$reason = reason_example; // String | Rejection reason

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

my $api_instance = WWW::SwaggerClient::CommoditiescoreApi->new();
my $requestNumber = requestNumber_example; # String | MCT request number
my $reason = reason_example; # String | Rejection reason

eval { 
    $api_instance->cancelTerminateSupply(requestNumber => $requestNumber, reason => $reason);
};
if ($@) {
    warn "Exception when calling CommoditiescoreApi->cancelTerminateSupply: $@\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.CommoditiescoreApi()
requestNumber = requestNumber_example # String | MCT request number
reason = reason_example # String | Rejection reason

try: 
    # Cancel supply termination
    api_instance.cancel_terminate_supply(requestNumber, reason)
except ApiException as e:
    print("Exception when calling CommoditiescoreApi->cancelTerminateSupply: %s\n" % e)

Parameters

Path parameters
Name Description
requestNumber*
String
MCT request number
Required
Query parameters
Name Description
reason*
String
Rejection reason
Required

Responses

Status: default - successful operation


getBusinessPartnersWithContractObjects

Retrieve business partners with contract objects


/api/comm/businessPartnersWithCO

Usage and SDK Samples

curl -X POST "https://localhost/core/services/rest/core/api/comm/businessPartnersWithCO?limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommoditiescoreApi;

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

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        Integer limit = 56; // Integer | Restriction for records number; 0 means no restriction. If returning records number =(countLimit+1), then filter should be more specific, because there is bigger number of records
        APIBusinessPartnerFilter body = ; // APIBusinessPartnerFilter | Filter of business partners and contract objects
        try {
            array[APIBusinessPartner] result = apiInstance.getBusinessPartnersWithContractObjects(limit, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#getBusinessPartnersWithContractObjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommoditiescoreApi;

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        Integer limit = 56; // Integer | Restriction for records number; 0 means no restriction. If returning records number =(countLimit+1), then filter should be more specific, because there is bigger number of records
        APIBusinessPartnerFilter body = ; // APIBusinessPartnerFilter | Filter of business partners and contract objects
        try {
            array[APIBusinessPartner] result = apiInstance.getBusinessPartnersWithContractObjects(limit, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#getBusinessPartnersWithContractObjects");
            e.printStackTrace();
        }
    }
}
Integer *limit = 56; // Restriction for records number; 0 means no restriction. If returning records number =(countLimit+1), then filter should be more specific, because there is bigger number of records
APIBusinessPartnerFilter *body = ; // Filter of business partners and contract objects (optional)

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

// Retrieve business partners with contract objects
[apiInstance getBusinessPartnersWithContractObjectsWith:limit
    body:body
              completionHandler: ^(array[APIBusinessPartner] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CommoditiescoreApi()

var limit = 56; // {Integer} Restriction for records number; 0 means no restriction. If returning records number =(countLimit+1), then filter should be more specific, because there is bigger number of records

var opts = { 
  'body':  // {APIBusinessPartnerFilter} Filter of business partners and contract objects
};

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

namespace Example
{
    public class getBusinessPartnersWithContractObjectsExample
    {
        public void main()
        {
            
            var apiInstance = new CommoditiescoreApi();
            var limit = 56;  // Integer | Restriction for records number; 0 means no restriction. If returning records number =(countLimit+1), then filter should be more specific, because there is bigger number of records
            var body = new APIBusinessPartnerFilter(); // APIBusinessPartnerFilter | Filter of business partners and contract objects (optional) 

            try
            {
                // Retrieve business partners with contract objects
                array[APIBusinessPartner] result = apiInstance.getBusinessPartnersWithContractObjects(limit, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommoditiescoreApi.getBusinessPartnersWithContractObjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CommoditiescoreApi();
$limit = 56; // Integer | Restriction for records number; 0 means no restriction. If returning records number =(countLimit+1), then filter should be more specific, because there is bigger number of records
$body = ; // APIBusinessPartnerFilter | Filter of business partners and contract objects

try {
    $result = $api_instance->getBusinessPartnersWithContractObjects($limit, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommoditiescoreApi->getBusinessPartnersWithContractObjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommoditiescoreApi;

my $api_instance = WWW::SwaggerClient::CommoditiescoreApi->new();
my $limit = 56; # Integer | Restriction for records number; 0 means no restriction. If returning records number =(countLimit+1), then filter should be more specific, because there is bigger number of records
my $body = WWW::SwaggerClient::Object::APIBusinessPartnerFilter->new(); # APIBusinessPartnerFilter | Filter of business partners and contract objects

eval { 
    my $result = $api_instance->getBusinessPartnersWithContractObjects(limit => $limit, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommoditiescoreApi->getBusinessPartnersWithContractObjects: $@\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.CommoditiescoreApi()
limit = 56 # Integer | Restriction for records number; 0 means no restriction. If returning records number =(countLimit+1), then filter should be more specific, because there is bigger number of records
body =  # APIBusinessPartnerFilter | Filter of business partners and contract objects (optional)

try: 
    # Retrieve business partners with contract objects
    api_response = api_instance.get_business_partners_with_contract_objects(limit, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommoditiescoreApi->getBusinessPartnersWithContractObjects: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
limit*
Integer (int32)
Restriction for records number; 0 means no restriction. If returning records number =(countLimit+1), then filter should be more specific, because there is bigger number of records
Required

Responses

Status: 200 - successful operation


getListOfCTDs

Retrieve consumption type diagrams valid during date interval


/api/comm/listOfCTDs/{idCO}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/comm/listOfCTDs/{idCO}?dateFrom=&dateTo="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommoditiescoreApi;

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

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        Integer idCO = 56; // Integer | Contract object identifier
        date dateFrom = 2013-10-20; // date | Validity start date
        date dateTo = 2013-10-20; // date | Validity end date
        try {
            array[APIConsumptionTypeDiagram] result = apiInstance.getListOfCTDs(idCO, dateFrom, dateTo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#getListOfCTDs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommoditiescoreApi;

public class CommoditiescoreApiExample {

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

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

// Retrieve consumption type diagrams valid during date interval
[apiInstance getListOfCTDsWith:idCO
    dateFrom:dateFrom
    dateTo:dateTo
              completionHandler: ^(array[APIConsumptionTypeDiagram] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CommoditiescoreApi()

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

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

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


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

namespace Example
{
    public class getListOfCTDsExample
    {
        public void main()
        {
            
            var apiInstance = new CommoditiescoreApi();
            var idCO = 56;  // Integer | Contract object identifier
            var dateFrom = 2013-10-20;  // date | Validity start date
            var dateTo = 2013-10-20;  // date | Validity end date

            try
            {
                // Retrieve consumption type diagrams valid during date interval
                array[APIConsumptionTypeDiagram] result = apiInstance.getListOfCTDs(idCO, dateFrom, dateTo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommoditiescoreApi.getListOfCTDs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CommoditiescoreApi();
$idCO = 56; // Integer | Contract object identifier
$dateFrom = 2013-10-20; // date | Validity start date
$dateTo = 2013-10-20; // date | Validity end date

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

my $api_instance = WWW::SwaggerClient::CommoditiescoreApi->new();
my $idCO = 56; # Integer | Contract object identifier
my $dateFrom = 2013-10-20; # date | Validity start date
my $dateTo = 2013-10-20; # date | Validity end date

eval { 
    my $result = $api_instance->getListOfCTDs(idCO => $idCO, dateFrom => $dateFrom, dateTo => $dateTo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommoditiescoreApi->getListOfCTDs: $@\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.CommoditiescoreApi()
idCO = 56 # Integer | Contract object identifier
dateFrom = 2013-10-20 # date | Validity start date
dateTo = 2013-10-20 # date | Validity end date

try: 
    # Retrieve consumption type diagrams valid during date interval
    api_response = api_instance.get_list_of_ct_ds(idCO, dateFrom, dateTo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommoditiescoreApi->getListOfCTDs: %s\n" % e)

Parameters

Path parameters
Name Description
idCO*
Integer (int32)
Contract object identifier
Required
Query parameters
Name Description
dateFrom*
date (date)
Validity start date
Required
dateTo*
date (date)
Validity end date
Required

Responses

Status: 200 - successful operation


getSupplyInfo

Retrieve information about delivery point.


/api/comm/supply/{eic}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/comm/supply/{eic}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommoditiescoreApi;

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

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String eic = eic_example; // String | EIC code of point of delivery
        try {
            APISupplyInfo result = apiInstance.getSupplyInfo(eic);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#getSupplyInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommoditiescoreApi;

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String eic = eic_example; // String | EIC code of point of delivery
        try {
            APISupplyInfo result = apiInstance.getSupplyInfo(eic);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#getSupplyInfo");
            e.printStackTrace();
        }
    }
}
String *eic = eic_example; // EIC code of point of delivery

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

// Retrieve information about delivery point.
[apiInstance getSupplyInfoWith:eic
              completionHandler: ^(APISupplyInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CommoditiescoreApi()

var eic = eic_example; // {String} EIC code of point of delivery


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

namespace Example
{
    public class getSupplyInfoExample
    {
        public void main()
        {
            
            var apiInstance = new CommoditiescoreApi();
            var eic = eic_example;  // String | EIC code of point of delivery

            try
            {
                // Retrieve information about delivery point.
                APISupplyInfo result = apiInstance.getSupplyInfo(eic);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommoditiescoreApi.getSupplyInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CommoditiescoreApi();
$eic = eic_example; // String | EIC code of point of delivery

try {
    $result = $api_instance->getSupplyInfo($eic);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommoditiescoreApi->getSupplyInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommoditiescoreApi;

my $api_instance = WWW::SwaggerClient::CommoditiescoreApi->new();
my $eic = eic_example; # String | EIC code of point of delivery

eval { 
    my $result = $api_instance->getSupplyInfo(eic => $eic);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommoditiescoreApi->getSupplyInfo: $@\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.CommoditiescoreApi()
eic = eic_example # String | EIC code of point of delivery

try: 
    # Retrieve information about delivery point.
    api_response = api_instance.get_supply_info(eic)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommoditiescoreApi->getSupplyInfo: %s\n" % e)

Parameters

Path parameters
Name Description
eic*
String
EIC code of point of delivery
Required

Responses

Status: 200 - successful operation


registerBillingBasisRecords

Register billing basis records


/api/comm/registerBBRecords/{idCO}

Usage and SDK Samples

curl -X POST "https://localhost/core/services/rest/core/api/comm/registerBBRecords/{idCO}?sourceType=&author="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommoditiescoreApi;

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

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        Integer idCO = 56; // Integer | Contract object identifier
        String sourceType = sourceType_example; // String | External source type
        String author = author_example; // String | Registrator
        array[APIBillingBasisRecord] body = ; // array[APIBillingBasisRecord] | Billing basis records
        try {
            apiInstance.registerBillingBasisRecords(idCO, sourceType, author, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#registerBillingBasisRecords");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommoditiescoreApi;

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        Integer idCO = 56; // Integer | Contract object identifier
        String sourceType = sourceType_example; // String | External source type
        String author = author_example; // String | Registrator
        array[APIBillingBasisRecord] body = ; // array[APIBillingBasisRecord] | Billing basis records
        try {
            apiInstance.registerBillingBasisRecords(idCO, sourceType, author, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#registerBillingBasisRecords");
            e.printStackTrace();
        }
    }
}
Integer *idCO = 56; // Contract object identifier
String *sourceType = sourceType_example; // External source type
String *author = author_example; // Registrator
array[APIBillingBasisRecord] *body = ; // Billing basis records (optional)

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

// Register billing basis records
[apiInstance registerBillingBasisRecordsWith:idCO
    sourceType:sourceType
    author:author
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CommoditiescoreApi()

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

var sourceType = sourceType_example; // {String} External source type

var author = author_example; // {String} Registrator

var opts = { 
  'body':  // {array[APIBillingBasisRecord]} Billing basis records
};

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

namespace Example
{
    public class registerBillingBasisRecordsExample
    {
        public void main()
        {
            
            var apiInstance = new CommoditiescoreApi();
            var idCO = 56;  // Integer | Contract object identifier
            var sourceType = sourceType_example;  // String | External source type
            var author = author_example;  // String | Registrator
            var body = new array[APIBillingBasisRecord](); // array[APIBillingBasisRecord] | Billing basis records (optional) 

            try
            {
                // Register billing basis records
                apiInstance.registerBillingBasisRecords(idCO, sourceType, author, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommoditiescoreApi.registerBillingBasisRecords: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CommoditiescoreApi();
$idCO = 56; // Integer | Contract object identifier
$sourceType = sourceType_example; // String | External source type
$author = author_example; // String | Registrator
$body = ; // array[APIBillingBasisRecord] | Billing basis records

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

my $api_instance = WWW::SwaggerClient::CommoditiescoreApi->new();
my $idCO = 56; # Integer | Contract object identifier
my $sourceType = sourceType_example; # String | External source type
my $author = author_example; # String | Registrator
my $body = [WWW::SwaggerClient::Object::array[APIBillingBasisRecord]->new()]; # array[APIBillingBasisRecord] | Billing basis records

eval { 
    $api_instance->registerBillingBasisRecords(idCO => $idCO, sourceType => $sourceType, author => $author, body => $body);
};
if ($@) {
    warn "Exception when calling CommoditiescoreApi->registerBillingBasisRecords: $@\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.CommoditiescoreApi()
idCO = 56 # Integer | Contract object identifier
sourceType = sourceType_example # String | External source type
author = author_example # String | Registrator
body =  # array[APIBillingBasisRecord] | Billing basis records (optional)

try: 
    # Register billing basis records
    api_instance.register_billing_basis_records(idCO, sourceType, author, body=body)
except ApiException as e:
    print("Exception when calling CommoditiescoreApi->registerBillingBasisRecords: %s\n" % e)

Parameters

Path parameters
Name Description
idCO*
Integer (int32)
Contract object identifier
Required
Body parameters
Name Description
body
Query parameters
Name Description
sourceType*
String
External source type
Required
author*
String
Registrator
Required

Responses

Status: default - successful operation


rejectContract

Reject contract


/api/comm/contract/reject/{requestNumber}

Usage and SDK Samples

curl -X PUT "https://localhost/core/services/rest/core/api/comm/contract/reject/{requestNumber}?reason="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommoditiescoreApi;

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

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String requestNumber = requestNumber_example; // String | MCT request number
        String reason = reason_example; // String | Rejection reason
        try {
            apiInstance.rejectContract(requestNumber, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#rejectContract");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommoditiescoreApi;

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String requestNumber = requestNumber_example; // String | MCT request number
        String reason = reason_example; // String | Rejection reason
        try {
            apiInstance.rejectContract(requestNumber, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#rejectContract");
            e.printStackTrace();
        }
    }
}
String *requestNumber = requestNumber_example; // MCT request number
String *reason = reason_example; // Rejection reason

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

// Reject contract
[apiInstance rejectContractWith:requestNumber
    reason:reason
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CommoditiescoreApi()

var requestNumber = requestNumber_example; // {String} MCT request number

var reason = reason_example; // {String} Rejection reason


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

namespace Example
{
    public class rejectContractExample
    {
        public void main()
        {
            
            var apiInstance = new CommoditiescoreApi();
            var requestNumber = requestNumber_example;  // String | MCT request number
            var reason = reason_example;  // String | Rejection reason

            try
            {
                // Reject contract
                apiInstance.rejectContract(requestNumber, reason);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommoditiescoreApi.rejectContract: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CommoditiescoreApi();
$requestNumber = requestNumber_example; // String | MCT request number
$reason = reason_example; // String | Rejection reason

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

my $api_instance = WWW::SwaggerClient::CommoditiescoreApi->new();
my $requestNumber = requestNumber_example; # String | MCT request number
my $reason = reason_example; # String | Rejection reason

eval { 
    $api_instance->rejectContract(requestNumber => $requestNumber, reason => $reason);
};
if ($@) {
    warn "Exception when calling CommoditiescoreApi->rejectContract: $@\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.CommoditiescoreApi()
requestNumber = requestNumber_example # String | MCT request number
reason = reason_example # String | Rejection reason

try: 
    # Reject contract
    api_instance.reject_contract(requestNumber, reason)
except ApiException as e:
    print("Exception when calling CommoditiescoreApi->rejectContract: %s\n" % e)

Parameters

Path parameters
Name Description
requestNumber*
String
MCT request number
Required
Query parameters
Name Description
reason*
String
Rejection reason
Required

Responses

Status: default - successful operation


rejectContractCancellation

Reject contract cancellation


/api/comm/contract/rejectCancellation/{requestNumber}

Usage and SDK Samples

curl -X PUT "https://localhost/core/services/rest/core/api/comm/contract/rejectCancellation/{requestNumber}?reason="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommoditiescoreApi;

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

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String requestNumber = requestNumber_example; // String | MCT request number
        String reason = reason_example; // String | Rejection reason
        try {
            apiInstance.rejectContractCancellation(requestNumber, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#rejectContractCancellation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommoditiescoreApi;

public class CommoditiescoreApiExample {

    public static void main(String[] args) {
        CommoditiescoreApi apiInstance = new CommoditiescoreApi();
        String requestNumber = requestNumber_example; // String | MCT request number
        String reason = reason_example; // String | Rejection reason
        try {
            apiInstance.rejectContractCancellation(requestNumber, reason);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiescoreApi#rejectContractCancellation");
            e.printStackTrace();
        }
    }
}
String *requestNumber = requestNumber_example; // MCT request number
String *reason = reason_example; // Rejection reason

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

// Reject contract cancellation
[apiInstance rejectContractCancellationWith:requestNumber
    reason:reason
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CommoditiescoreApi()

var requestNumber = requestNumber_example; // {String} MCT request number

var reason = reason_example; // {String} Rejection reason


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

namespace Example
{
    public class rejectContractCancellationExample
    {
        public void main()
        {
            
            var apiInstance = new CommoditiescoreApi();
            var requestNumber = requestNumber_example;  // String | MCT request number
            var reason = reason_example;  // String | Rejection reason

            try
            {
                // Reject contract cancellation
                apiInstance.rejectContractCancellation(requestNumber, reason);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommoditiescoreApi.rejectContractCancellation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CommoditiescoreApi();
$requestNumber = requestNumber_example; // String | MCT request number
$reason = reason_example; // String | Rejection reason

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

my $api_instance = WWW::SwaggerClient::CommoditiescoreApi->new();
my $requestNumber = requestNumber_example; # String | MCT request number
my $reason = reason_example; # String | Rejection reason

eval { 
    $api_instance->rejectContractCancellation(requestNumber => $requestNumber, reason => $reason);
};
if ($@) {
    warn "Exception when calling CommoditiescoreApi->rejectContractCancellation: $@\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.CommoditiescoreApi()
requestNumber = requestNumber_example # String | MCT request number
reason = reason_example # String | Rejection reason

try: 
    # Reject contract cancellation
    api_instance.reject_contract_cancellation(requestNumber, reason)
except ApiException as e:
    print("Exception when calling CommoditiescoreApi->rejectContractCancellation: %s\n" % e)

Parameters

Path parameters
Name Description
requestNumber*
String
MCT request number
Required
Query parameters
Name Description
reason*
String
Rejection reason
Required

Responses

Status: default - successful operation


Commoditiesworkplace

getBusinessPartnerMCTRequests

List of business partner MCT requests (with messages).


/api/commwp/mct/requests/{bpId}

Usage and SDK Samples

curl -X GET "https://localhost/core/services/rest/core/api/commwp/mct/requests/{bpId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommoditiesworkplaceApi;

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

public class CommoditiesworkplaceApiExample {

    public static void main(String[] args) {
        
        CommoditiesworkplaceApi apiInstance = new CommoditiesworkplaceApi();
        Integer bpId = 56; // Integer | Business partner identifier
        try {
            array[APIMCTRequest] result = apiInstance.getBusinessPartnerMCTRequests(bpId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiesworkplaceApi#getBusinessPartnerMCTRequests");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommoditiesworkplaceApi;

public class CommoditiesworkplaceApiExample {

    public static void main(String[] args) {
        CommoditiesworkplaceApi apiInstance = new CommoditiesworkplaceApi();
        Integer bpId = 56; // Integer | Business partner identifier
        try {
            array[APIMCTRequest] result = apiInstance.getBusinessPartnerMCTRequests(bpId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommoditiesworkplaceApi#getBusinessPartnerMCTRequests");
            e.printStackTrace();
        }
    }
}
Integer *bpId = 56; // Business partner identifier

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

// List of business partner MCT requests (with messages).
[apiInstance getBusinessPartnerMCTRequestsWith:bpId
              completionHandler: ^(array[APIMCTRequest] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EmpiricaCoreApi = require('empirica_core_api');

var api = new EmpiricaCoreApi.CommoditiesworkplaceApi()

var bpId = 56; // {Integer} Business partner identifier


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

namespace Example
{
    public class getBusinessPartnerMCTRequestsExample
    {
        public void main()
        {
            
            var apiInstance = new CommoditiesworkplaceApi();
            var bpId = 56;  // Integer | Business partner identifier

            try
            {
                // List of business partner MCT requests (with messages).
                array[APIMCTRequest] result = apiInstance.getBusinessPartnerMCTRequests(bpId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommoditiesworkplaceApi.getBusinessPartnerMCTRequests: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\CommoditiesworkplaceApi();
$bpId = 56; // Integer | Business partner identifier

try {
    $result = $api_instance->getBusinessPartnerMCTRequests($bpId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommoditiesworkplaceApi->getBusinessPartnerMCTRequests: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommoditiesworkplaceApi;

my $api_instance = WWW::SwaggerClient::CommoditiesworkplaceApi->new();
my $bpId = 56; # Integer | Business partner identifier

eval { 
    my $result = $api_instance->getBusinessPartnerMCTRequests(bpId => $bpId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommoditiesworkplaceApi->getBusinessPartnerMCTRequests: $@\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.CommoditiesworkplaceApi()
bpId = 56 # Integer | Business partner identifier

try: 
    # List of business partner MCT requests (with messages).
    api_response = api_instance.get_business_partner_mct_requests(bpId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommoditiesworkplaceApi->getBusinessPartnerMCTRequests: %s\n" % e)

Parameters

Path parameters
Name Description
bpId*
Integer (int32)
Business partner identifier
Required

Responses

Status: 200 - successful operation


Generated 2017-11-15T06:26:54.409Z