IF Technology API

Addresses

getCities

Retrieves a specific list of cities based on the query parameters

In case of a successful request, the system will return a list of cities and status code 200.


/api/Addresses/GetCities

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Addresses/GetCities?searchFilter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressesApi;

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

public class AddressesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        AddressesApi apiInstance = new AddressesApi();
        String searchFilter = searchFilter_example; // String | 
        try {
            CityModelArrayQueryDispatchResult result = apiInstance.getCities(searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#getCities");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressesApi;

public class AddressesApiExample {

    public static void main(String[] args) {
        AddressesApi apiInstance = new AddressesApi();
        String searchFilter = searchFilter_example; // String | 
        try {
            CityModelArrayQueryDispatchResult result = apiInstance.getCities(searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressesApi#getCities");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *searchFilter = searchFilter_example; //  (optional)

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

// Retrieves a specific list of cities based on the query parameters
[apiInstance getCitiesWith:searchFilter
              completionHandler: ^(CityModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.AddressesApi()
var opts = { 
  'searchFilter': searchFilter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCities(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AddressesApi();
            var searchFilter = searchFilter_example;  // String |  (optional) 

            try
            {
                // Retrieves a specific list of cities based on the query parameters
                CityModelArrayQueryDispatchResult result = apiInstance.getCities(searchFilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressesApi.getCities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAddressesApi();
$searchFilter = searchFilter_example; // String | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AddressesApi->new();
my $searchFilter = searchFilter_example; # String | 

eval { 
    my $result = $api_instance->getCities(searchFilter => $searchFilter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressesApi->getCities: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AddressesApi()
searchFilter = searchFilter_example # String |  (optional)

try: 
    # Retrieves a specific list of cities based on the query parameters
    api_response = api_instance.get_cities(searchFilter=searchFilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressesApi->getCities: %s\n" % e)

Parameters

Query parameters
Name Description
searchFilter
String

Responses

Status: 200 - List of cities retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the cities list!


BoreholeStatuses

getBoreholeStatuses

Retrieves a list of borehole statuses

In case of a successful request, the system will return the existing borehole statuses and status code 200.


/api/BoreholeStatuses/GetBoreholeStatuses

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/BoreholeStatuses/GetBoreholeStatuses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BoreholeStatusesApi;

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

public class BoreholeStatusesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        BoreholeStatusesApi apiInstance = new BoreholeStatusesApi();
        try {
            LookupModelArrayQueryDispatchResult result = apiInstance.getBoreholeStatuses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoreholeStatusesApi#getBoreholeStatuses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BoreholeStatusesApi;

public class BoreholeStatusesApiExample {

    public static void main(String[] args) {
        BoreholeStatusesApi apiInstance = new BoreholeStatusesApi();
        try {
            LookupModelArrayQueryDispatchResult result = apiInstance.getBoreholeStatuses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoreholeStatusesApi#getBoreholeStatuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of borehole statuses
[apiInstance getBoreholeStatusesWithCompletionHandler: 
              ^(LookupModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BoreholeStatusesApi();

            try
            {
                // Retrieves a list of borehole statuses
                LookupModelArrayQueryDispatchResult result = apiInstance.getBoreholeStatuses();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BoreholeStatusesApi.getBoreholeStatuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBoreholeStatusesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BoreholeStatusesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BoreholeStatusesApi()

try: 
    # Retrieves a list of borehole statuses
    api_response = api_instance.get_borehole_statuses()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BoreholeStatusesApi->getBoreholeStatuses: %s\n" % e)

Parameters

Responses

Status: 200 - Borehole statuses retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the borehole statuses list!


Companies

getCompanies

Retrieves a specific list of companies, to which the current user has access to, based on the request parameters

In case of a successful request, the system will return the existing total number of records and a list of companies sorted default by name and status code 200.


/api/Companies/GetCompanies

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Companies/GetCompanies?skip=&take=&orderBy=&searchFilter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompaniesApi;

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

public class CompaniesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        CompaniesApi apiInstance = new CompaniesApi();
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        String orderBy = orderBy_example; // String | 
        String searchFilter = searchFilter_example; // String | 
        try {
            CompanyModelPagedQueryResult result = apiInstance.getCompanies(skip, take, orderBy, searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompaniesApi#getCompanies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompaniesApi;

public class CompaniesApiExample {

    public static void main(String[] args) {
        CompaniesApi apiInstance = new CompaniesApi();
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        String orderBy = orderBy_example; // String | 
        String searchFilter = searchFilter_example; // String | 
        try {
            CompanyModelPagedQueryResult result = apiInstance.getCompanies(skip, take, orderBy, searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompaniesApi#getCompanies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *skip = 56; //  (optional)
Integer *take = 56; //  (optional)
String *orderBy = orderBy_example; //  (optional)
String *searchFilter = searchFilter_example; //  (optional)

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

// Retrieves a specific list of companies, to which the current user has access to, based on the request parameters
[apiInstance getCompaniesWith:skip
    take:take
    orderBy:orderBy
    searchFilter:searchFilter
              completionHandler: ^(CompanyModelPagedQueryResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.CompaniesApi()
var opts = { 
  'skip': 56, // {{Integer}} 
  'take': 56, // {{Integer}} 
  'orderBy': orderBy_example, // {{String}} 
  'searchFilter': searchFilter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCompanies(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CompaniesApi();
            var skip = 56;  // Integer |  (optional) 
            var take = 56;  // Integer |  (optional) 
            var orderBy = orderBy_example;  // String |  (optional) 
            var searchFilter = searchFilter_example;  // String |  (optional) 

            try
            {
                // Retrieves a specific list of companies, to which the current user has access to, based on the request parameters
                CompanyModelPagedQueryResult result = apiInstance.getCompanies(skip, take, orderBy, searchFilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompaniesApi.getCompanies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCompaniesApi();
$skip = 56; // Integer | 
$take = 56; // Integer | 
$orderBy = orderBy_example; // String | 
$searchFilter = searchFilter_example; // String | 

try {
    $result = $api_instance->getCompanies($skip, $take, $orderBy, $searchFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompaniesApi->getCompanies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CompaniesApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CompaniesApi->new();
my $skip = 56; # Integer | 
my $take = 56; # Integer | 
my $orderBy = orderBy_example; # String | 
my $searchFilter = searchFilter_example; # String | 

eval { 
    my $result = $api_instance->getCompanies(skip => $skip, take => $take, orderBy => $orderBy, searchFilter => $searchFilter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CompaniesApi->getCompanies: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CompaniesApi()
skip = 56 # Integer |  (optional)
take = 56 # Integer |  (optional)
orderBy = orderBy_example # String |  (optional)
searchFilter = searchFilter_example # String |  (optional)

try: 
    # Retrieves a specific list of companies, to which the current user has access to, based on the request parameters
    api_response = api_instance.get_companies(skip=skip, take=take, orderBy=orderBy, searchFilter=searchFilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompaniesApi->getCompanies: %s\n" % e)

Parameters

Query parameters
Name Description
skip
Integer (int32)
take
Integer (int32)
orderBy
String
searchFilter
String

Responses

Status: 200 - List of companies retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the companies list!


getCompaniesByType

Retrieves a specific list of companies based on the request parameters

In case of a successful request, the system will return the existing total number of records and a list of companies and status code 200.


/api/Companies/GetCompaniesByType

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Companies/GetCompaniesByType?searchFilter=&companyTypeID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompaniesApi;

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

public class CompaniesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        CompaniesApi apiInstance = new CompaniesApi();
        String searchFilter = searchFilter_example; // String | 
        Integer companyTypeID = 56; // Integer | 
        try {
            CompanySummaryModelArrayPagedQueryResult result = apiInstance.getCompaniesByType(searchFilter, companyTypeID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompaniesApi#getCompaniesByType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompaniesApi;

public class CompaniesApiExample {

    public static void main(String[] args) {
        CompaniesApi apiInstance = new CompaniesApi();
        String searchFilter = searchFilter_example; // String | 
        Integer companyTypeID = 56; // Integer | 
        try {
            CompanySummaryModelArrayPagedQueryResult result = apiInstance.getCompaniesByType(searchFilter, companyTypeID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompaniesApi#getCompaniesByType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *searchFilter = searchFilter_example; //  (optional)
Integer *companyTypeID = 56; //  (optional)

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

// Retrieves a specific list of companies based on the request parameters
[apiInstance getCompaniesByTypeWith:searchFilter
    companyTypeID:companyTypeID
              completionHandler: ^(CompanySummaryModelArrayPagedQueryResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.CompaniesApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} 
  'companyTypeID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCompaniesByType(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CompaniesApi();
            var searchFilter = searchFilter_example;  // String |  (optional) 
            var companyTypeID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of companies based on the request parameters
                CompanySummaryModelArrayPagedQueryResult result = apiInstance.getCompaniesByType(searchFilter, companyTypeID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompaniesApi.getCompaniesByType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCompaniesApi();
$searchFilter = searchFilter_example; // String | 
$companyTypeID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CompaniesApi->new();
my $searchFilter = searchFilter_example; # String | 
my $companyTypeID = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CompaniesApi()
searchFilter = searchFilter_example # String |  (optional)
companyTypeID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of companies based on the request parameters
    api_response = api_instance.get_companies_by_type(searchFilter=searchFilter, companyTypeID=companyTypeID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompaniesApi->getCompaniesByType: %s\n" % e)

Parameters

Query parameters
Name Description
searchFilter
String
companyTypeID
Integer (int32)

Responses

Status: 200 - List of companies retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the companies list!


getCompany

Retrieves a specific company based on the provided ID

In case of a successful request, the system will return the details of the company matching the provided ID and status code 200


/api/Companies/GetCompany

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Companies/GetCompany?companyID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompaniesApi;

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

public class CompaniesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        CompaniesApi apiInstance = new CompaniesApi();
        Integer companyID = 56; // Integer | 
        try {
            CompanyDetailsModelQueryDispatchResult result = apiInstance.getCompany(companyID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompaniesApi#getCompany");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompaniesApi;

public class CompaniesApiExample {

    public static void main(String[] args) {
        CompaniesApi apiInstance = new CompaniesApi();
        Integer companyID = 56; // Integer | 
        try {
            CompanyDetailsModelQueryDispatchResult result = apiInstance.getCompany(companyID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompaniesApi#getCompany");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *companyID = 56; //  (optional)

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

// Retrieves a specific company based on the provided ID
[apiInstance getCompanyWith:companyID
              completionHandler: ^(CompanyDetailsModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.CompaniesApi()
var opts = { 
  'companyID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCompany(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CompaniesApi();
            var companyID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific company based on the provided ID
                CompanyDetailsModelQueryDispatchResult result = apiInstance.getCompany(companyID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompaniesApi.getCompany: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCompaniesApi();
$companyID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CompaniesApi->new();
my $companyID = 56; # Integer | 

eval { 
    my $result = $api_instance->getCompany(companyID => $companyID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CompaniesApi->getCompany: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CompaniesApi()
companyID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific company based on the provided ID
    api_response = api_instance.get_company(companyID=companyID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompaniesApi->getCompany: %s\n" % e)

Parameters

Query parameters
Name Description
companyID
Integer (int32)

Responses

Status: 200 - Company details retrieved

Status: 400 - Invalid request body parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find a company linked to the provided ID

Status: 500 - An error occurred. Cannot retrieve the company details!


CompanyTypes

getCompanyTypes

Retrieves the existing company types

In case of a successful request, the system types will return the list of company types and status code 200


/api/CompanyTypes/GetCompanyTypes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/CompanyTypes/GetCompanyTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CompanyTypesApi;

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

public class CompanyTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        CompanyTypesApi apiInstance = new CompanyTypesApi();
        try {
            CompanyTypeModelArrayQueryDispatchResult result = apiInstance.getCompanyTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyTypesApi#getCompanyTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CompanyTypesApi;

public class CompanyTypesApiExample {

    public static void main(String[] args) {
        CompanyTypesApi apiInstance = new CompanyTypesApi();
        try {
            CompanyTypeModelArrayQueryDispatchResult result = apiInstance.getCompanyTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyTypesApi#getCompanyTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves the existing company types
[apiInstance getCompanyTypesWithCompletionHandler: 
              ^(CompanyTypeModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CompanyTypesApi();

            try
            {
                // Retrieves the existing company types
                CompanyTypeModelArrayQueryDispatchResult result = apiInstance.getCompanyTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CompanyTypesApi.getCompanyTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiCompanyTypesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::CompanyTypesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.CompanyTypesApi()

try: 
    # Retrieves the existing company types
    api_response = api_instance.get_company_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompanyTypesApi->getCompanyTypes: %s\n" % e)

Parameters

Responses

Status: 200 - List of company types retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the company types list!


ContactPersons

getContactPerson

Retrieves a specific contact person based on the provided personID

In case of a successful request, the system will return the details of the contact person matching the provided ID and status code 200


/api/ContactPersons/GetContactPerson

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/ContactPersons/GetContactPerson?personID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactPersonsApi;

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

public class ContactPersonsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ContactPersonsApi apiInstance = new ContactPersonsApi();
        Integer personID = 56; // Integer | 
        try {
            ContactPersonDetailsModelQueryDispatchResult result = apiInstance.getContactPerson(personID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactPersonsApi#getContactPerson");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactPersonsApi;

public class ContactPersonsApiExample {

    public static void main(String[] args) {
        ContactPersonsApi apiInstance = new ContactPersonsApi();
        Integer personID = 56; // Integer | 
        try {
            ContactPersonDetailsModelQueryDispatchResult result = apiInstance.getContactPerson(personID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactPersonsApi#getContactPerson");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *personID = 56; //  (optional)

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

// Retrieves a specific contact person based on the provided personID
[apiInstance getContactPersonWith:personID
              completionHandler: ^(ContactPersonDetailsModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ContactPersonsApi()
var opts = { 
  'personID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContactPerson(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ContactPersonsApi();
            var personID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific contact person based on the provided personID
                ContactPersonDetailsModelQueryDispatchResult result = apiInstance.getContactPerson(personID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactPersonsApi.getContactPerson: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiContactPersonsApi();
$personID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ContactPersonsApi->new();
my $personID = 56; # Integer | 

eval { 
    my $result = $api_instance->getContactPerson(personID => $personID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactPersonsApi->getContactPerson: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ContactPersonsApi()
personID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific contact person based on the provided personID
    api_response = api_instance.get_contact_person(personID=personID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactPersonsApi->getContactPerson: %s\n" % e)

Parameters

Query parameters
Name Description
personID
Integer (int32)

Responses

Status: 200 - Contact person details retrieved

Status: 400 - Invalid request body parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find a contact person linked to the provided ID

Status: 500 - An error occurred. Cannot retrieve the contact person details!


getContactPersons

Retrieves a specific list of contact persons based on the request parameters

In case of a successful request, the system will return the existing total number of records and a list of contact persons default sorter by name and status code 200.


/api/ContactPersons/GetContactPersons

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/ContactPersons/GetContactPersons?skip=&take=&orderBy=&searchFilter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactPersonsApi;

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

public class ContactPersonsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ContactPersonsApi apiInstance = new ContactPersonsApi();
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        String orderBy = orderBy_example; // String | 
        String searchFilter = searchFilter_example; // String | 
        try {
            ContactPersonModelPagedQueryResult result = apiInstance.getContactPersons(skip, take, orderBy, searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactPersonsApi#getContactPersons");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactPersonsApi;

public class ContactPersonsApiExample {

    public static void main(String[] args) {
        ContactPersonsApi apiInstance = new ContactPersonsApi();
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        String orderBy = orderBy_example; // String | 
        String searchFilter = searchFilter_example; // String | 
        try {
            ContactPersonModelPagedQueryResult result = apiInstance.getContactPersons(skip, take, orderBy, searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactPersonsApi#getContactPersons");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *skip = 56; //  (optional)
Integer *take = 56; //  (optional)
String *orderBy = orderBy_example; //  (optional)
String *searchFilter = searchFilter_example; //  (optional)

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

// Retrieves a specific list of contact persons based on the request parameters
[apiInstance getContactPersonsWith:skip
    take:take
    orderBy:orderBy
    searchFilter:searchFilter
              completionHandler: ^(ContactPersonModelPagedQueryResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ContactPersonsApi()
var opts = { 
  'skip': 56, // {{Integer}} 
  'take': 56, // {{Integer}} 
  'orderBy': orderBy_example, // {{String}} 
  'searchFilter': searchFilter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContactPersons(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ContactPersonsApi();
            var skip = 56;  // Integer |  (optional) 
            var take = 56;  // Integer |  (optional) 
            var orderBy = orderBy_example;  // String |  (optional) 
            var searchFilter = searchFilter_example;  // String |  (optional) 

            try
            {
                // Retrieves a specific list of contact persons based on the request parameters
                ContactPersonModelPagedQueryResult result = apiInstance.getContactPersons(skip, take, orderBy, searchFilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactPersonsApi.getContactPersons: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiContactPersonsApi();
$skip = 56; // Integer | 
$take = 56; // Integer | 
$orderBy = orderBy_example; // String | 
$searchFilter = searchFilter_example; // String | 

try {
    $result = $api_instance->getContactPersons($skip, $take, $orderBy, $searchFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactPersonsApi->getContactPersons: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactPersonsApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ContactPersonsApi->new();
my $skip = 56; # Integer | 
my $take = 56; # Integer | 
my $orderBy = orderBy_example; # String | 
my $searchFilter = searchFilter_example; # String | 

eval { 
    my $result = $api_instance->getContactPersons(skip => $skip, take => $take, orderBy => $orderBy, searchFilter => $searchFilter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactPersonsApi->getContactPersons: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ContactPersonsApi()
skip = 56 # Integer |  (optional)
take = 56 # Integer |  (optional)
orderBy = orderBy_example # String |  (optional)
searchFilter = searchFilter_example # String |  (optional)

try: 
    # Retrieves a specific list of contact persons based on the request parameters
    api_response = api_instance.get_contact_persons(skip=skip, take=take, orderBy=orderBy, searchFilter=searchFilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactPersonsApi->getContactPersons: %s\n" % e)

Parameters

Query parameters
Name Description
skip
Integer (int32)
take
Integer (int32)
orderBy
String
searchFilter
String

Responses

Status: 200 - List of contact persons retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the contact persons list!


getContactPersonsByCompanyID

Retrieves a list of contact persons based on the provided companyID

In case of a successful request, the system will return the list of the contact persons matching the provided company ID and status code 200


/api/ContactPersons/GetContactPersonsByCompanyID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/ContactPersons/GetContactPersonsByCompanyID?companyID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactPersonsApi;

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

public class ContactPersonsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ContactPersonsApi apiInstance = new ContactPersonsApi();
        Integer companyID = 56; // Integer | 
        try {
            ContactPersonBaseModelArrayQueryDispatchResult result = apiInstance.getContactPersonsByCompanyID(companyID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactPersonsApi#getContactPersonsByCompanyID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactPersonsApi;

public class ContactPersonsApiExample {

    public static void main(String[] args) {
        ContactPersonsApi apiInstance = new ContactPersonsApi();
        Integer companyID = 56; // Integer | 
        try {
            ContactPersonBaseModelArrayQueryDispatchResult result = apiInstance.getContactPersonsByCompanyID(companyID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactPersonsApi#getContactPersonsByCompanyID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *companyID = 56; //  (optional)

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

// Retrieves a list of contact persons based on the provided companyID
[apiInstance getContactPersonsByCompanyIDWith:companyID
              completionHandler: ^(ContactPersonBaseModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ContactPersonsApi()
var opts = { 
  'companyID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContactPersonsByCompanyID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ContactPersonsApi();
            var companyID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a list of contact persons based on the provided companyID
                ContactPersonBaseModelArrayQueryDispatchResult result = apiInstance.getContactPersonsByCompanyID(companyID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactPersonsApi.getContactPersonsByCompanyID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiContactPersonsApi();
$companyID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ContactPersonsApi->new();
my $companyID = 56; # Integer | 

eval { 
    my $result = $api_instance->getContactPersonsByCompanyID(companyID => $companyID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactPersonsApi->getContactPersonsByCompanyID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ContactPersonsApi()
companyID = 56 # Integer |  (optional)

try: 
    # Retrieves a list of contact persons based on the provided companyID
    api_response = api_instance.get_contact_persons_by_company_id(companyID=companyID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactPersonsApi->getContactPersonsByCompanyID: %s\n" % e)

Parameters

Query parameters
Name Description
companyID
Integer (int32)

Responses

Status: 200 - List of contact persons retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find a contact person linked to the provided company ID

Status: 500 - An error occurred. Cannot retrieve the list of contact persons!


EnergyBalance

getEnergyBalance

Retrieves the Energy balance KPIs for a specific year on a specific plant

In case of a successful request, the system will return the Energy balance KPI and status code 200.


/api/KPIs/GetEnergyBalance

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/KPIs/GetEnergyBalance?plantID=&year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EnergyBalanceApi;

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

public class EnergyBalanceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        EnergyBalanceApi apiInstance = new EnergyBalanceApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            EnergyBalanceKPIModelQueryDispatchResult result = apiInstance.getEnergyBalance(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnergyBalanceApi#getEnergyBalance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EnergyBalanceApi;

public class EnergyBalanceApiExample {

    public static void main(String[] args) {
        EnergyBalanceApi apiInstance = new EnergyBalanceApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            EnergyBalanceKPIModelQueryDispatchResult result = apiInstance.getEnergyBalance(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnergyBalanceApi#getEnergyBalance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)
Integer *year = 56; //  (optional)

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

// Retrieves the Energy balance KPIs for a specific year on a specific plant
[apiInstance getEnergyBalanceWith:plantID
    year:year
              completionHandler: ^(EnergyBalanceKPIModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.EnergyBalanceApi()
var opts = { 
  'plantID': 56, // {{Integer}} 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEnergyBalance(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new EnergyBalanceApi();
            var plantID = 56;  // Integer |  (optional) 
            var year = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves the Energy balance KPIs for a specific year on a specific plant
                EnergyBalanceKPIModelQueryDispatchResult result = apiInstance.getEnergyBalance(plantID, year);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnergyBalanceApi.getEnergyBalance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiEnergyBalanceApi();
$plantID = 56; // Integer | 
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::EnergyBalanceApi->new();
my $plantID = 56; # Integer | 
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.EnergyBalanceApi()
plantID = 56 # Integer |  (optional)
year = 56 # Integer |  (optional)

try: 
    # Retrieves the Energy balance KPIs for a specific year on a specific plant
    api_response = api_instance.get_energy_balance(plantID=plantID, year=year)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnergyBalanceApi->getEnergyBalance: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)
year
Integer (int32)

Responses

Status: 200 - Energy balance KPI for a Plant retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided ID

Status: 500 - An error occurred. Cannot retrieve the Energy balance Plant KPI!


Frequencies

getWaterQualityFrequencies

Retrieves a list of water quality frequencies

In case of a successful request, the system will return the existing frequencies and status code 200.


/api/Frequencies/GetWaterQualityFrequencies

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Frequencies/GetWaterQualityFrequencies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FrequenciesApi;

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

public class FrequenciesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        FrequenciesApi apiInstance = new FrequenciesApi();
        try {
            FrequencyModelArrayQueryDispatchResult result = apiInstance.getWaterQualityFrequencies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrequenciesApi#getWaterQualityFrequencies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FrequenciesApi;

public class FrequenciesApiExample {

    public static void main(String[] args) {
        FrequenciesApi apiInstance = new FrequenciesApi();
        try {
            FrequencyModelArrayQueryDispatchResult result = apiInstance.getWaterQualityFrequencies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FrequenciesApi#getWaterQualityFrequencies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of water quality frequencies
[apiInstance getWaterQualityFrequenciesWithCompletionHandler: 
              ^(FrequencyModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FrequenciesApi();

            try
            {
                // Retrieves a list of water quality frequencies
                FrequencyModelArrayQueryDispatchResult result = apiInstance.getWaterQualityFrequencies();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FrequenciesApi.getWaterQualityFrequencies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFrequenciesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FrequenciesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FrequenciesApi()

try: 
    # Retrieves a list of water quality frequencies
    api_response = api_instance.get_water_quality_frequencies()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FrequenciesApi->getWaterQualityFrequencies: %s\n" % e)

Parameters

Responses

Status: 200 - Water quality frequencies retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the water quality frequencies list!


KPIs

getCompanyPlantsPolicies

Retrieves the policy KPIs for the company plants for the last 12 months

In case of a successful request, the system will return the Policy KPIs for the last 12 months for all Plants of the Company for which the logged user is linked to and status code 200.


/api/KPIs/GetCompanyPlantsPolicies

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/KPIs/GetCompanyPlantsPolicies"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KPIsApi;

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

public class KPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        KPIsApi apiInstance = new KPIsApi();
        try {
            PolicyListModelQueryDispatchResult result = apiInstance.getCompanyPlantsPolicies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getCompanyPlantsPolicies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KPIsApi;

public class KPIsApiExample {

    public static void main(String[] args) {
        KPIsApi apiInstance = new KPIsApi();
        try {
            PolicyListModelQueryDispatchResult result = apiInstance.getCompanyPlantsPolicies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getCompanyPlantsPolicies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves the policy KPIs for the company plants for the last 12 months
[apiInstance getCompanyPlantsPoliciesWithCompletionHandler: 
              ^(PolicyListModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new KPIsApi();

            try
            {
                // Retrieves the policy KPIs for the company plants for the last 12 months
                PolicyListModelQueryDispatchResult result = apiInstance.getCompanyPlantsPolicies();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KPIsApi.getCompanyPlantsPolicies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiKPIsApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::KPIsApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.KPIsApi()

try: 
    # Retrieves the policy KPIs for the company plants for the last 12 months
    api_response = api_instance.get_company_plants_policies()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KPIsApi->getCompanyPlantsPolicies: %s\n" % e)

Parameters

Responses

Status: 200 - Policy KPIs for the last 12 months retrieved

Status: 401 - Unauthorized request

Status: 404 - Cannot find any plants to calculate the Policy KPIs

Status: 500 - An error occurred. Cannot calculate the Policy KPIs!


getEnergyBalance

Retrieves the Energy balance KPIs for a specific year on a specific plant

In case of a successful request, the system will return the Energy balance KPI and status code 200.


/api/KPIs/GetEnergyBalance

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/KPIs/GetEnergyBalance?plantID=&year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KPIsApi;

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

public class KPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        KPIsApi apiInstance = new KPIsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            EnergyBalanceKPIModelQueryDispatchResult result = apiInstance.getEnergyBalance(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getEnergyBalance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KPIsApi;

public class KPIsApiExample {

    public static void main(String[] args) {
        KPIsApi apiInstance = new KPIsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            EnergyBalanceKPIModelQueryDispatchResult result = apiInstance.getEnergyBalance(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getEnergyBalance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)
Integer *year = 56; //  (optional)

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

// Retrieves the Energy balance KPIs for a specific year on a specific plant
[apiInstance getEnergyBalanceWith:plantID
    year:year
              completionHandler: ^(EnergyBalanceKPIModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.KPIsApi()
var opts = { 
  'plantID': 56, // {{Integer}} 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEnergyBalance(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new KPIsApi();
            var plantID = 56;  // Integer |  (optional) 
            var year = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves the Energy balance KPIs for a specific year on a specific plant
                EnergyBalanceKPIModelQueryDispatchResult result = apiInstance.getEnergyBalance(plantID, year);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KPIsApi.getEnergyBalance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiKPIsApi();
$plantID = 56; // Integer | 
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::KPIsApi->new();
my $plantID = 56; # Integer | 
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.KPIsApi()
plantID = 56 # Integer |  (optional)
year = 56 # Integer |  (optional)

try: 
    # Retrieves the Energy balance KPIs for a specific year on a specific plant
    api_response = api_instance.get_energy_balance(plantID=plantID, year=year)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KPIsApi->getEnergyBalance: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)
year
Integer (int32)

Responses

Status: 200 - Energy balance KPI for a Plant retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided ID

Status: 500 - An error occurred. Cannot retrieve the Energy balance Plant KPI!


getKPIStatuses

Retrieves the available statuses for a KPI

In case of a successful request, the system will return a list of KPI statuses and status code 200.


/api/KPIs/GetKPIStatuses

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/KPIs/GetKPIStatuses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KPIsApi;

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

public class KPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        KPIsApi apiInstance = new KPIsApi();
        try {
            LookupModelQueryDispatchResult result = apiInstance.getKPIStatuses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getKPIStatuses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KPIsApi;

public class KPIsApiExample {

    public static void main(String[] args) {
        KPIsApi apiInstance = new KPIsApi();
        try {
            LookupModelQueryDispatchResult result = apiInstance.getKPIStatuses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getKPIStatuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves the available statuses for a KPI
[apiInstance getKPIStatusesWithCompletionHandler: 
              ^(LookupModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new KPIsApi();

            try
            {
                // Retrieves the available statuses for a KPI
                LookupModelQueryDispatchResult result = apiInstance.getKPIStatuses();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KPIsApi.getKPIStatuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiKPIsApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::KPIsApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.KPIsApi()

try: 
    # Retrieves the available statuses for a KPI
    api_response = api_instance.get_kpi_statuses()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KPIsApi->getKPIStatuses: %s\n" % e)

Parameters

Responses

Status: 200 - List of KPI statuses retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the KPI statuses list!


getKPITypes

Retrieves the available KPI types

In case of a successful request, the system will return a list of KPI types and status code 200.


/api/KPIs/GetKPITypes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/KPIs/GetKPITypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KPIsApi;

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

public class KPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        KPIsApi apiInstance = new KPIsApi();
        try {
            LookupModelQueryDispatchResult result = apiInstance.getKPITypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getKPITypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KPIsApi;

public class KPIsApiExample {

    public static void main(String[] args) {
        KPIsApi apiInstance = new KPIsApi();
        try {
            LookupModelQueryDispatchResult result = apiInstance.getKPITypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getKPITypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves the available KPI types
[apiInstance getKPITypesWithCompletionHandler: 
              ^(LookupModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new KPIsApi();

            try
            {
                // Retrieves the available KPI types
                LookupModelQueryDispatchResult result = apiInstance.getKPITypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KPIsApi.getKPITypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiKPIsApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::KPIsApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.KPIsApi()

try: 
    # Retrieves the available KPI types
    api_response = api_instance.get_kpi_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KPIsApi->getKPITypes: %s\n" % e)

Parameters

Responses

Status: 200 - List of KPI types retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the KPI types list!


getKPIs

Retrieves the KPIs for a specific year on a plant

In case of a successful request, the system will return a list of KPIs and status code 200.


/api/KPIs/GetKPIs

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/KPIs/GetKPIs?plantID=&year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KPIsApi;

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

public class KPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        KPIsApi apiInstance = new KPIsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            PlantKPIModelQueryDispatchResult result = apiInstance.getKPIs(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getKPIs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KPIsApi;

public class KPIsApiExample {

    public static void main(String[] args) {
        KPIsApi apiInstance = new KPIsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            PlantKPIModelQueryDispatchResult result = apiInstance.getKPIs(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getKPIs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)
Integer *year = 56; //  (optional)

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

// Retrieves the KPIs for a specific year on a plant
[apiInstance getKPIsWith:plantID
    year:year
              completionHandler: ^(PlantKPIModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.KPIsApi()
var opts = { 
  'plantID': 56, // {{Integer}} 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getKPIs(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new KPIsApi();
            var plantID = 56;  // Integer |  (optional) 
            var year = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves the KPIs for a specific year on a plant
                PlantKPIModelQueryDispatchResult result = apiInstance.getKPIs(plantID, year);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KPIsApi.getKPIs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiKPIsApi();
$plantID = 56; // Integer | 
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::KPIsApi->new();
my $plantID = 56; # Integer | 
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.KPIsApi()
plantID = 56 # Integer |  (optional)
year = 56 # Integer |  (optional)

try: 
    # Retrieves the KPIs for a specific year on a plant
    api_response = api_instance.get_kpis(plantID=plantID, year=year)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KPIsApi->getKPIs: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)
year
Integer (int32)

Responses

Status: 200 - List of KPIs retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided ID

Status: 500 - An error occurred. Cannot retrieve the KPIs list!


getPlantKpisOverallStatus

Retrieves the KPIs overall status for a specific year on a plant

In case of a successful request, the system will return the KPI and status code 200.


/api/KPIs/GetPlantKpisOverallStatus

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/KPIs/GetPlantKpisOverallStatus?plantID=&year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KPIsApi;

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

public class KPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        KPIsApi apiInstance = new KPIsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            PlantKPIOverallStatusModelQueryDispatchResult result = apiInstance.getPlantKpisOverallStatus(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getPlantKpisOverallStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KPIsApi;

public class KPIsApiExample {

    public static void main(String[] args) {
        KPIsApi apiInstance = new KPIsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            PlantKPIOverallStatusModelQueryDispatchResult result = apiInstance.getPlantKpisOverallStatus(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getPlantKpisOverallStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)
Integer *year = 56; //  (optional)

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

// Retrieves the KPIs overall status for a specific year on a plant
[apiInstance getPlantKpisOverallStatusWith:plantID
    year:year
              completionHandler: ^(PlantKPIOverallStatusModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.KPIsApi()
var opts = { 
  'plantID': 56, // {{Integer}} 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlantKpisOverallStatus(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new KPIsApi();
            var plantID = 56;  // Integer |  (optional) 
            var year = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves the KPIs overall status for a specific year on a plant
                PlantKPIOverallStatusModelQueryDispatchResult result = apiInstance.getPlantKpisOverallStatus(plantID, year);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KPIsApi.getPlantKpisOverallStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiKPIsApi();
$plantID = 56; // Integer | 
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::KPIsApi->new();
my $plantID = 56; # Integer | 
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.KPIsApi()
plantID = 56 # Integer |  (optional)
year = 56 # Integer |  (optional)

try: 
    # Retrieves the KPIs overall status for a specific year on a plant
    api_response = api_instance.get_plant_kpis_overall_status(plantID=plantID, year=year)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KPIsApi->getPlantKpisOverallStatus: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)
year
Integer (int32)

Responses

Status: 200 - KPIs status retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant KPIs overall status with the provided ID

Status: 500 - An error occurred. Cannot retrieve the KPIs!


getProductivityPlantKpi

Retrieves the Productivity KPIs for a specific year on a specific plant

In case of a successful request, the system will return the Productivity KPI and status code 200.


/api/KPIs/GetProductivityPlantKpi

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/KPIs/GetProductivityPlantKpi?plantId=&year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KPIsApi;

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

public class KPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        KPIsApi apiInstance = new KPIsApi();
        Integer plantId = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            ProductivityPlantKpiModelQueryDispatchResult result = apiInstance.getProductivityPlantKpi(plantId, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getProductivityPlantKpi");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KPIsApi;

public class KPIsApiExample {

    public static void main(String[] args) {
        KPIsApi apiInstance = new KPIsApi();
        Integer plantId = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            ProductivityPlantKpiModelQueryDispatchResult result = apiInstance.getProductivityPlantKpi(plantId, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getProductivityPlantKpi");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantId = 56; //  (optional)
Integer *year = 56; //  (optional)

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

// Retrieves the Productivity KPIs for a specific year on a specific plant
[apiInstance getProductivityPlantKpiWith:plantId
    year:year
              completionHandler: ^(ProductivityPlantKpiModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.KPIsApi()
var opts = { 
  'plantId': 56, // {{Integer}} 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProductivityPlantKpi(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new KPIsApi();
            var plantId = 56;  // Integer |  (optional) 
            var year = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves the Productivity KPIs for a specific year on a specific plant
                ProductivityPlantKpiModelQueryDispatchResult result = apiInstance.getProductivityPlantKpi(plantId, year);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KPIsApi.getProductivityPlantKpi: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiKPIsApi();
$plantId = 56; // Integer | 
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::KPIsApi->new();
my $plantId = 56; # Integer | 
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.KPIsApi()
plantId = 56 # Integer |  (optional)
year = 56 # Integer |  (optional)

try: 
    # Retrieves the Productivity KPIs for a specific year on a specific plant
    api_response = api_instance.get_productivity_plant_kpi(plantId=plantId, year=year)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KPIsApi->getProductivityPlantKpi: %s\n" % e)

Parameters

Query parameters
Name Description
plantId
Integer (int32)
year
Integer (int32)

Responses

Status: 200 - Productivity KPI for a Plant retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided ID

Status: 500 - An error occurred. Cannot retrieve the Productivity Plant KPI!


getTemperature

Retrieves the Temperature KPIs for a specific year on a specific plant

In case of a successful request, the system will return the Temperature KPI and status code 200.


/api/KPIs/GetTemperature

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/KPIs/GetTemperature?plantId=&year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KPIsApi;

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

public class KPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        KPIsApi apiInstance = new KPIsApi();
        Integer plantId = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            TemperaturePlantKpiModelQueryDispatchResult result = apiInstance.getTemperature(plantId, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getTemperature");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KPIsApi;

public class KPIsApiExample {

    public static void main(String[] args) {
        KPIsApi apiInstance = new KPIsApi();
        Integer plantId = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            TemperaturePlantKpiModelQueryDispatchResult result = apiInstance.getTemperature(plantId, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getTemperature");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantId = 56; //  (optional)
Integer *year = 56; //  (optional)

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

// Retrieves the Temperature KPIs for a specific year on a specific plant
[apiInstance getTemperatureWith:plantId
    year:year
              completionHandler: ^(TemperaturePlantKpiModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.KPIsApi()
var opts = { 
  'plantId': 56, // {{Integer}} 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTemperature(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new KPIsApi();
            var plantId = 56;  // Integer |  (optional) 
            var year = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves the Temperature KPIs for a specific year on a specific plant
                TemperaturePlantKpiModelQueryDispatchResult result = apiInstance.getTemperature(plantId, year);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KPIsApi.getTemperature: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiKPIsApi();
$plantId = 56; // Integer | 
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::KPIsApi->new();
my $plantId = 56; # Integer | 
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.KPIsApi()
plantId = 56 # Integer |  (optional)
year = 56 # Integer |  (optional)

try: 
    # Retrieves the Temperature KPIs for a specific year on a specific plant
    api_response = api_instance.get_temperature(plantId=plantId, year=year)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KPIsApi->getTemperature: %s\n" % e)

Parameters

Query parameters
Name Description
plantId
Integer (int32)
year
Integer (int32)

Responses

Status: 200 - Temperature KPI for a Plant retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided ID

Status: 500 - An error occurred. Cannot retrieve the Temperature Plant KPI!


getWaterDischarge

Retrieves the Water Discharge KPI for a specific year on a specific plant

In case of a successful request, the system will return the Water Discharge KPI and status code 200.


/api/KPIs/GetWaterDischarge

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/KPIs/GetWaterDischarge?plantID=&year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KPIsApi;

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

public class KPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        KPIsApi apiInstance = new KPIsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            WaterQuantityPlantKPIModelQueryDispatchResult result = apiInstance.getWaterDischarge(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getWaterDischarge");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KPIsApi;

public class KPIsApiExample {

    public static void main(String[] args) {
        KPIsApi apiInstance = new KPIsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            WaterQuantityPlantKPIModelQueryDispatchResult result = apiInstance.getWaterDischarge(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getWaterDischarge");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)
Integer *year = 56; //  (optional)

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

// Retrieves the Water Discharge KPI for a specific year on a specific plant
[apiInstance getWaterDischargeWith:plantID
    year:year
              completionHandler: ^(WaterQuantityPlantKPIModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.KPIsApi()
var opts = { 
  'plantID': 56, // {{Integer}} 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWaterDischarge(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new KPIsApi();
            var plantID = 56;  // Integer |  (optional) 
            var year = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves the Water Discharge KPI for a specific year on a specific plant
                WaterQuantityPlantKPIModelQueryDispatchResult result = apiInstance.getWaterDischarge(plantID, year);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KPIsApi.getWaterDischarge: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiKPIsApi();
$plantID = 56; // Integer | 
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::KPIsApi->new();
my $plantID = 56; # Integer | 
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.KPIsApi()
plantID = 56 # Integer |  (optional)
year = 56 # Integer |  (optional)

try: 
    # Retrieves the Water Discharge KPI for a specific year on a specific plant
    api_response = api_instance.get_water_discharge(plantID=plantID, year=year)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KPIsApi->getWaterDischarge: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)
year
Integer (int32)

Responses

Status: 200 - Water Discharge KPI for a Plant retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided ID

Status: 500 - An error occurred. Cannot retrieve the Water Discharge Plant KPI!


getWaterDisplacement

Retrieves the Water Displacement KPI for a specific year on a specific plant

In case of a successful request, the system will return the Water Displacement KPI and status code 200.


/api/KPIs/GetWaterDisplacement

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/KPIs/GetWaterDisplacement?plantID=&year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KPIsApi;

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

public class KPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        KPIsApi apiInstance = new KPIsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            WaterQuantityPlantKPIModelQueryDispatchResult result = apiInstance.getWaterDisplacement(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getWaterDisplacement");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KPIsApi;

public class KPIsApiExample {

    public static void main(String[] args) {
        KPIsApi apiInstance = new KPIsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            WaterQuantityPlantKPIModelQueryDispatchResult result = apiInstance.getWaterDisplacement(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KPIsApi#getWaterDisplacement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)
Integer *year = 56; //  (optional)

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

// Retrieves the Water Displacement KPI for a specific year on a specific plant
[apiInstance getWaterDisplacementWith:plantID
    year:year
              completionHandler: ^(WaterQuantityPlantKPIModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.KPIsApi()
var opts = { 
  'plantID': 56, // {{Integer}} 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWaterDisplacement(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new KPIsApi();
            var plantID = 56;  // Integer |  (optional) 
            var year = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves the Water Displacement KPI for a specific year on a specific plant
                WaterQuantityPlantKPIModelQueryDispatchResult result = apiInstance.getWaterDisplacement(plantID, year);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KPIsApi.getWaterDisplacement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiKPIsApi();
$plantID = 56; // Integer | 
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::KPIsApi->new();
my $plantID = 56; # Integer | 
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.KPIsApi()
plantID = 56 # Integer |  (optional)
year = 56 # Integer |  (optional)

try: 
    # Retrieves the Water Displacement KPI for a specific year on a specific plant
    api_response = api_instance.get_water_displacement(plantID=plantID, year=year)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KPIsApi->getWaterDisplacement: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)
year
Integer (int32)

Responses

Status: 200 - Water Displacement KPI for a Plant retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided ID

Status: 500 - An error occurred. Cannot retrieve the Water Displacement Plant KPI!


LegalRequirements

getLegalRequirements

Retrieves a list of legal requirements

In case of a successful request, the system will return the existing legal requirements and status code 200.


/api/LegalRequirements/GetLegalRequirements

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/LegalRequirements/GetLegalRequirements"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LegalRequirementsApi;

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

public class LegalRequirementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        LegalRequirementsApi apiInstance = new LegalRequirementsApi();
        try {
            LegalRequirementModelArrayQueryDispatchResult result = apiInstance.getLegalRequirements();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalRequirementsApi#getLegalRequirements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LegalRequirementsApi;

public class LegalRequirementsApiExample {

    public static void main(String[] args) {
        LegalRequirementsApi apiInstance = new LegalRequirementsApi();
        try {
            LegalRequirementModelArrayQueryDispatchResult result = apiInstance.getLegalRequirements();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalRequirementsApi#getLegalRequirements");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of legal requirements
[apiInstance getLegalRequirementsWithCompletionHandler: 
              ^(LegalRequirementModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new LegalRequirementsApi();

            try
            {
                // Retrieves a list of legal requirements
                LegalRequirementModelArrayQueryDispatchResult result = apiInstance.getLegalRequirements();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LegalRequirementsApi.getLegalRequirements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiLegalRequirementsApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::LegalRequirementsApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.LegalRequirementsApi()

try: 
    # Retrieves a list of legal requirements
    api_response = api_instance.get_legal_requirements()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LegalRequirementsApi->getLegalRequirements: %s\n" % e)

Parameters

Responses

Status: 200 - Legal requirements retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the legal requirements list!


LegalTypes

getLegalTypes

Retrieves the existing legal types

In case of a successful request, the system will return the list of legal types and status code 200


/api/LegalTypes/GetLegalTypes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/LegalTypes/GetLegalTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LegalTypesApi;

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

public class LegalTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        LegalTypesApi apiInstance = new LegalTypesApi();
        try {
            LegalTypeModelArrayQueryDispatchResult result = apiInstance.getLegalTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalTypesApi#getLegalTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LegalTypesApi;

public class LegalTypesApiExample {

    public static void main(String[] args) {
        LegalTypesApi apiInstance = new LegalTypesApi();
        try {
            LegalTypeModelArrayQueryDispatchResult result = apiInstance.getLegalTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalTypesApi#getLegalTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves the existing legal types
[apiInstance getLegalTypesWithCompletionHandler: 
              ^(LegalTypeModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new LegalTypesApi();

            try
            {
                // Retrieves the existing legal types
                LegalTypeModelArrayQueryDispatchResult result = apiInstance.getLegalTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LegalTypesApi.getLegalTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiLegalTypesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::LegalTypesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.LegalTypesApi()

try: 
    # Retrieves the existing legal types
    api_response = api_instance.get_legal_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LegalTypesApi->getLegalTypes: %s\n" % e)

Parameters

Responses

Status: 200 - List of legal types retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the legal types list!


LegalUses

getLegalUses

Retrieves a list of legal uses

In case of a successful request, the system will return the existing legal uses and status code 200.


/api/LegalUses/GetLegalUses

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/LegalUses/GetLegalUses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LegalUsesApi;

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

public class LegalUsesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        LegalUsesApi apiInstance = new LegalUsesApi();
        try {
            LegalUseModelArrayQueryDispatchResult result = apiInstance.getLegalUses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalUsesApi#getLegalUses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LegalUsesApi;

public class LegalUsesApiExample {

    public static void main(String[] args) {
        LegalUsesApi apiInstance = new LegalUsesApi();
        try {
            LegalUseModelArrayQueryDispatchResult result = apiInstance.getLegalUses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegalUsesApi#getLegalUses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of legal uses
[apiInstance getLegalUsesWithCompletionHandler: 
              ^(LegalUseModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new LegalUsesApi();

            try
            {
                // Retrieves a list of legal uses
                LegalUseModelArrayQueryDispatchResult result = apiInstance.getLegalUses();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LegalUsesApi.getLegalUses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiLegalUsesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::LegalUsesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.LegalUsesApi()

try: 
    # Retrieves a list of legal uses
    api_response = api_instance.get_legal_uses()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LegalUsesApi->getLegalUses: %s\n" % e)

Parameters

Responses

Status: 200 - Legal uses retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the legal uses list!


Markets

apiMarketsGetMarketsGet

Retrieves the existing markets

In case of a successful request, the system will return the list of markets and status code 200


/api/Markets/GetMarkets

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Markets/GetMarkets"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MarketsApi;

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

public class MarketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        MarketsApi apiInstance = new MarketsApi();
        try {
            LookupModelArrayQueryDispatchResult result = apiInstance.apiMarketsGetMarketsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MarketsApi#apiMarketsGetMarketsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MarketsApi;

public class MarketsApiExample {

    public static void main(String[] args) {
        MarketsApi apiInstance = new MarketsApi();
        try {
            LookupModelArrayQueryDispatchResult result = apiInstance.apiMarketsGetMarketsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MarketsApi#apiMarketsGetMarketsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves the existing markets
[apiInstance apiMarketsGetMarketsGetWithCompletionHandler: 
              ^(LookupModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MarketsApi();

            try
            {
                // Retrieves the existing markets
                LookupModelArrayQueryDispatchResult result = apiInstance.apiMarketsGetMarketsGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MarketsApi.apiMarketsGetMarketsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMarketsApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MarketsApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MarketsApi()

try: 
    # Retrieves the existing markets
    api_response = api_instance.api_markets_get_markets_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MarketsApi->apiMarketsGetMarketsGet: %s\n" % e)

Parameters

Responses

Status: 200 - List of markets retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the markets list!


MeasurementStatus

getMeasurementStatusesTypes

Retrieves a list of measurement statuses

In case of a successful request, the system will return the existing measurement statuses and status code 200.


/api/MeasurementStatus/GetMeasurementStatusesTypes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/MeasurementStatus/GetMeasurementStatusesTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MeasurementStatusApi;

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

public class MeasurementStatusApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        MeasurementStatusApi apiInstance = new MeasurementStatusApi();
        try {
            LookupModelArrayQueryDispatchResult result = apiInstance.getMeasurementStatusesTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeasurementStatusApi#getMeasurementStatusesTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MeasurementStatusApi;

public class MeasurementStatusApiExample {

    public static void main(String[] args) {
        MeasurementStatusApi apiInstance = new MeasurementStatusApi();
        try {
            LookupModelArrayQueryDispatchResult result = apiInstance.getMeasurementStatusesTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeasurementStatusApi#getMeasurementStatusesTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of measurement statuses
[apiInstance getMeasurementStatusesTypesWithCompletionHandler: 
              ^(LookupModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MeasurementStatusApi();

            try
            {
                // Retrieves a list of measurement statuses
                LookupModelArrayQueryDispatchResult result = apiInstance.getMeasurementStatusesTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MeasurementStatusApi.getMeasurementStatusesTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMeasurementStatusApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MeasurementStatusApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MeasurementStatusApi()

try: 
    # Retrieves a list of measurement statuses
    api_response = api_instance.get_measurement_statuses_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MeasurementStatusApi->getMeasurementStatusesTypes: %s\n" % e)

Parameters

Responses

Status: 200 - Measurement statuses retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the measurement statuses list!


MeasurementTypes

getMeasurementTypes

Retrieves a list of measurement types

In case of a successful request, the system will return the existing measurement types and status code 200.


/api/MeasurementTypes/GetMeasurementTypes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/MeasurementTypes/GetMeasurementTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MeasurementTypesApi;

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

public class MeasurementTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        MeasurementTypesApi apiInstance = new MeasurementTypesApi();
        try {
            MeasurementTypeModelArrayQueryDispatchResult result = apiInstance.getMeasurementTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeasurementTypesApi#getMeasurementTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MeasurementTypesApi;

public class MeasurementTypesApiExample {

    public static void main(String[] args) {
        MeasurementTypesApi apiInstance = new MeasurementTypesApi();
        try {
            MeasurementTypeModelArrayQueryDispatchResult result = apiInstance.getMeasurementTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeasurementTypesApi#getMeasurementTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of measurement types
[apiInstance getMeasurementTypesWithCompletionHandler: 
              ^(MeasurementTypeModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MeasurementTypesApi();

            try
            {
                // Retrieves a list of measurement types
                MeasurementTypeModelArrayQueryDispatchResult result = apiInstance.getMeasurementTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MeasurementTypesApi.getMeasurementTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMeasurementTypesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MeasurementTypesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MeasurementTypesApi()

try: 
    # Retrieves a list of measurement types
    api_response = api_instance.get_measurement_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MeasurementTypesApi->getMeasurementTypes: %s\n" % e)

Parameters

Responses

Status: 200 - Measurement types retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the measurement types list!


Measurements

getMeasurementData

Retrieves the measurement data for a specific year and plant

In case of a successful request, the system will return the values of the measurement data matching the provided ID and year and status code 200


/api/Measurements/GetMeasurementData

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Measurements/GetMeasurementData?plantID=&year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MeasurementsApi;

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

public class MeasurementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        MeasurementsApi apiInstance = new MeasurementsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            PlantMeasurementDataModelQueryDispatchResult result = apiInstance.getMeasurementData(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeasurementsApi#getMeasurementData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MeasurementsApi;

public class MeasurementsApiExample {

    public static void main(String[] args) {
        MeasurementsApi apiInstance = new MeasurementsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        try {
            PlantMeasurementDataModelQueryDispatchResult result = apiInstance.getMeasurementData(plantID, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeasurementsApi#getMeasurementData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)
Integer *year = 56; //  (optional)

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

// Retrieves the measurement data for a specific year and plant
[apiInstance getMeasurementDataWith:plantID
    year:year
              completionHandler: ^(PlantMeasurementDataModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.MeasurementsApi()
var opts = { 
  'plantID': 56, // {{Integer}} 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMeasurementData(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MeasurementsApi();
            var plantID = 56;  // Integer |  (optional) 
            var year = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves the measurement data for a specific year and plant
                PlantMeasurementDataModelQueryDispatchResult result = apiInstance.getMeasurementData(plantID, year);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MeasurementsApi.getMeasurementData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMeasurementsApi();
$plantID = 56; // Integer | 
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MeasurementsApi->new();
my $plantID = 56; # Integer | 
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MeasurementsApi()
plantID = 56 # Integer |  (optional)
year = 56 # Integer |  (optional)

try: 
    # Retrieves the measurement data for a specific year and plant
    api_response = api_instance.get_measurement_data(plantID=plantID, year=year)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MeasurementsApi->getMeasurementData: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)
year
Integer (int32)

Responses

Status: 200 - Measurement data retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the measurement data for the provided ID or year

Status: 500 - An error occurred. Cannot retrieve the measurement data!


getMonthlyMeasurementData

Retrieves the monthly measurement data for a specific plant based on the provided year and month

In case of a successful request, the system will return the values of the monthly measurement data matching the provided plant, year and month and status code 200


/api/Measurements/GetMonthlyMeasurementData

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Measurements/GetMonthlyMeasurementData?plantID=&year=&month="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MeasurementsApi;

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

public class MeasurementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        MeasurementsApi apiInstance = new MeasurementsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        Integer month = 56; // Integer | 
        try {
            PlantMonthlyMeasurementDataModelQueryDispatchResult result = apiInstance.getMonthlyMeasurementData(plantID, year, month);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeasurementsApi#getMonthlyMeasurementData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MeasurementsApi;

public class MeasurementsApiExample {

    public static void main(String[] args) {
        MeasurementsApi apiInstance = new MeasurementsApi();
        Integer plantID = 56; // Integer | 
        Integer year = 56; // Integer | 
        Integer month = 56; // Integer | 
        try {
            PlantMonthlyMeasurementDataModelQueryDispatchResult result = apiInstance.getMonthlyMeasurementData(plantID, year, month);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeasurementsApi#getMonthlyMeasurementData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)
Integer *year = 56; //  (optional)
Integer *month = 56; //  (optional)

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

// Retrieves the monthly measurement data for a specific plant based on the provided year and month
[apiInstance getMonthlyMeasurementDataWith:plantID
    year:year
    month:month
              completionHandler: ^(PlantMonthlyMeasurementDataModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.MeasurementsApi()
var opts = { 
  'plantID': 56, // {{Integer}} 
  'year': 56, // {{Integer}} 
  'month': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMonthlyMeasurementData(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new MeasurementsApi();
            var plantID = 56;  // Integer |  (optional) 
            var year = 56;  // Integer |  (optional) 
            var month = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves the monthly measurement data for a specific plant based on the provided year and month
                PlantMonthlyMeasurementDataModelQueryDispatchResult result = apiInstance.getMonthlyMeasurementData(plantID, year, month);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MeasurementsApi.getMonthlyMeasurementData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiMeasurementsApi();
$plantID = 56; // Integer | 
$year = 56; // Integer | 
$month = 56; // Integer | 

try {
    $result = $api_instance->getMonthlyMeasurementData($plantID, $year, $month);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MeasurementsApi->getMonthlyMeasurementData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MeasurementsApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::MeasurementsApi->new();
my $plantID = 56; # Integer | 
my $year = 56; # Integer | 
my $month = 56; # Integer | 

eval { 
    my $result = $api_instance->getMonthlyMeasurementData(plantID => $plantID, year => $year, month => $month);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MeasurementsApi->getMonthlyMeasurementData: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.MeasurementsApi()
plantID = 56 # Integer |  (optional)
year = 56 # Integer |  (optional)
month = 56 # Integer |  (optional)

try: 
    # Retrieves the monthly measurement data for a specific plant based on the provided year and month
    api_response = api_instance.get_monthly_measurement_data(plantID=plantID, year=year, month=month)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MeasurementsApi->getMonthlyMeasurementData: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)
year
Integer (int32)
month
Integer (int32)

Responses

Status: 200 - Monthly measurement data retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the monthly measurement data for the provided plant ID, year and month

Status: 500 - An error occurred. Cannot retrieve the monthly measurement data!


NotificationTypes

getNotificationTypes

Retrieves a list of notification types

In case of a successful request, the system will return the existing notification types and status code 200.


/api/NotificationTypes/GetNotificationTypes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/NotificationTypes/GetNotificationTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotificationTypesApi;

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

public class NotificationTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        NotificationTypesApi apiInstance = new NotificationTypesApi();
        try {
            LookupModelArrayQueryDispatchResult result = apiInstance.getNotificationTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationTypesApi#getNotificationTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotificationTypesApi;

public class NotificationTypesApiExample {

    public static void main(String[] args) {
        NotificationTypesApi apiInstance = new NotificationTypesApi();
        try {
            LookupModelArrayQueryDispatchResult result = apiInstance.getNotificationTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationTypesApi#getNotificationTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of notification types
[apiInstance getNotificationTypesWithCompletionHandler: 
              ^(LookupModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new NotificationTypesApi();

            try
            {
                // Retrieves a list of notification types
                LookupModelArrayQueryDispatchResult result = apiInstance.getNotificationTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotificationTypesApi.getNotificationTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNotificationTypesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::NotificationTypesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.NotificationTypesApi()

try: 
    # Retrieves a list of notification types
    api_response = api_instance.get_notification_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationTypesApi->getNotificationTypes: %s\n" % e)

Parameters

Responses

Status: 200 - Notification types retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the notification types list!


Notifications

getPlantsCounterByNotificationTypes

Retrieves the number of plants that has at least a notification based on the request parameter notificationTypeIds and status code 200.


/api/Notifications/GetPlantsCounterByNotificationTypes

Usage and SDK Samples

curl -X POST\
\
-H "Accept: application/json"\
-H "Content-Type: application/json-patch+json,application/json,text/json,application/*+json"\
"https://api.ifonline.nl/api/Notifications/GetPlantsCounterByNotificationTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotificationsApi;

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

public class NotificationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        NotificationsApi apiInstance = new NotificationsApi();
        NotificationFilterModel body = ; // NotificationFilterModel | 
        try {
            Int32NullableQueryDispatchResult result = apiInstance.getPlantsCounterByNotificationTypes(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#getPlantsCounterByNotificationTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotificationsApi;

public class NotificationsApiExample {

    public static void main(String[] args) {
        NotificationsApi apiInstance = new NotificationsApi();
        NotificationFilterModel body = ; // NotificationFilterModel | 
        try {
            Int32NullableQueryDispatchResult result = apiInstance.getPlantsCounterByNotificationTypes(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationsApi#getPlantsCounterByNotificationTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
NotificationFilterModel *body = ; //  (optional)

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

// Retrieves the number of plants that has at least a notification based on the request parameter notificationTypeIds and status code 200.
[apiInstance getPlantsCounterByNotificationTypesWith:body
              completionHandler: ^(Int32NullableQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new NotificationsApi();
            var body = new NotificationFilterModel(); // NotificationFilterModel |  (optional) 

            try
            {
                // Retrieves the number of plants that has at least a notification based on the request parameter notificationTypeIds and status code 200.
                Int32NullableQueryDispatchResult result = apiInstance.getPlantsCounterByNotificationTypes(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotificationsApi.getPlantsCounterByNotificationTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiNotificationsApi();
$body = ; // NotificationFilterModel | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::NotificationsApi->new();
my $body = WWW::SwaggerClient::Object::NotificationFilterModel->new(); # NotificationFilterModel | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.NotificationsApi()
body =  # NotificationFilterModel |  (optional)

try: 
    # Retrieves the number of plants that has at least a notification based on the request parameter notificationTypeIds and status code 200.
    api_response = api_instance.get_plants_counter_by_notification_types(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationsApi->getPlantsCounterByNotificationTypes: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Number of plants with notifications retrieved

Status: 401 - Unauthorized request

Status: 404 - Cannot find a plant notifications with provided notificationTypeIDs

Status: 500 - An error occurred. Cannot retrieve the number of plants!


Permits

getAvailablePermits

Retrieves a list of permit dates based on the provided plant ID

In case of a successful request, the system will return the list of permit dates matching the provided parameters, the plant type, plant configuration and status code 200


/api/Permits/GetAvailablePermits

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Permits/GetAvailablePermits?plantID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PermitsApi;

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

public class PermitsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PermitsApi apiInstance = new PermitsApi();
        Integer plantID = 56; // Integer | 
        try {
            AvailablePlantPermitModelQueryDispatchResult result = apiInstance.getAvailablePermits(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermitsApi#getAvailablePermits");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PermitsApi;

public class PermitsApiExample {

    public static void main(String[] args) {
        PermitsApi apiInstance = new PermitsApi();
        Integer plantID = 56; // Integer | 
        try {
            AvailablePlantPermitModelQueryDispatchResult result = apiInstance.getAvailablePermits(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermitsApi#getAvailablePermits");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)

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

// Retrieves a list of permit dates based on the provided plant ID
[apiInstance getAvailablePermitsWith:plantID
              completionHandler: ^(AvailablePlantPermitModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PermitsApi()
var opts = { 
  'plantID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvailablePermits(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PermitsApi();
            var plantID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a list of permit dates based on the provided plant ID
                AvailablePlantPermitModelQueryDispatchResult result = apiInstance.getAvailablePermits(plantID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermitsApi.getAvailablePermits: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPermitsApi();
$plantID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PermitsApi->new();
my $plantID = 56; # Integer | 

eval { 
    my $result = $api_instance->getAvailablePermits(plantID => $plantID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PermitsApi->getAvailablePermits: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PermitsApi()
plantID = 56 # Integer |  (optional)

try: 
    # Retrieves a list of permit dates based on the provided plant ID
    api_response = api_instance.get_available_permits(plantID=plantID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermitsApi->getAvailablePermits: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)

Responses

Status: 200 - Permit dates list retrieved

Status: 400 - Invalid request body parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the permits with provided plant ID

Status: 500 - An error occured. Cannot retrieve the permit dates!


getPermit

Retrieves a specific permit based on the provided plant ID and permit date

In case of a successful request, the system will return the details of the permit matching the provided parameters and status code 200


/api/Permits/GetPermit

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Permits/GetPermit?plantID=&permitDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PermitsApi;

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

public class PermitsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PermitsApi apiInstance = new PermitsApi();
        Integer plantID = 56; // Integer | 
        Date permitDate = 2013-10-20T19:20:30+01:00; // Date | 
        try {
            PlantPermitModelQueryDispatchResult result = apiInstance.getPermit(plantID, permitDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermitsApi#getPermit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PermitsApi;

public class PermitsApiExample {

    public static void main(String[] args) {
        PermitsApi apiInstance = new PermitsApi();
        Integer plantID = 56; // Integer | 
        Date permitDate = 2013-10-20T19:20:30+01:00; // Date | 
        try {
            PlantPermitModelQueryDispatchResult result = apiInstance.getPermit(plantID, permitDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PermitsApi#getPermit");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)
Date *permitDate = 2013-10-20T19:20:30+01:00; //  (optional)

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

// Retrieves a specific permit based on the provided plant ID and permit date
[apiInstance getPermitWith:plantID
    permitDate:permitDate
              completionHandler: ^(PlantPermitModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PermitsApi()
var opts = { 
  'plantID': 56, // {{Integer}} 
  'permitDate': 2013-10-20T19:20:30+01:00 // {{Date}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPermit(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PermitsApi();
            var plantID = 56;  // Integer |  (optional) 
            var permitDate = 2013-10-20T19:20:30+01:00;  // Date |  (optional) 

            try
            {
                // Retrieves a specific permit based on the provided plant ID and permit date
                PlantPermitModelQueryDispatchResult result = apiInstance.getPermit(plantID, permitDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PermitsApi.getPermit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPermitsApi();
$plantID = 56; // Integer | 
$permitDate = 2013-10-20T19:20:30+01:00; // Date | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PermitsApi->new();
my $plantID = 56; # Integer | 
my $permitDate = 2013-10-20T19:20:30+01:00; # Date | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PermitsApi()
plantID = 56 # Integer |  (optional)
permitDate = 2013-10-20T19:20:30+01:00 # Date |  (optional)

try: 
    # Retrieves a specific permit based on the provided plant ID and permit date
    api_response = api_instance.get_permit(plantID=plantID, permitDate=permitDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PermitsApi->getPermit: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)
permitDate
Date (date-time)

Responses

Status: 200 - Permit details retrieved

Status: 400 - Invalid request body parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the permit with the provided plant ID or permit date

Status: 500 - An error occured. Cannot retrieve the permit!


PlantConfigurations

getPlantConfigurations

Retrieves a list of plant configurations

In case of a successful request, the system will return the existing plant configurations and status code 200.


/api/PlantConfigurations/GetPlantConfigurations

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/PlantConfigurations/GetPlantConfigurations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantConfigurationsApi;

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

public class PlantConfigurationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantConfigurationsApi apiInstance = new PlantConfigurationsApi();
        try {
            PlantConfigurationModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getPlantConfigurations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantConfigurationsApi#getPlantConfigurations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantConfigurationsApi;

public class PlantConfigurationsApiExample {

    public static void main(String[] args) {
        PlantConfigurationsApi apiInstance = new PlantConfigurationsApi();
        try {
            PlantConfigurationModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getPlantConfigurations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantConfigurationsApi#getPlantConfigurations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of plant configurations
[apiInstance getPlantConfigurationsWithCompletionHandler: 
              ^(PlantConfigurationModelApplicationFilteredQueryResultQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantConfigurationsApi();

            try
            {
                // Retrieves a list of plant configurations
                PlantConfigurationModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getPlantConfigurations();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantConfigurationsApi.getPlantConfigurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantConfigurationsApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantConfigurationsApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantConfigurationsApi()

try: 
    # Retrieves a list of plant configurations
    api_response = api_instance.get_plant_configurations()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantConfigurationsApi->getPlantConfigurations: %s\n" % e)

Parameters

Responses

Status: 200 - Plant configurations retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plant configurations list!


PlantDepths

getPlantDepths

Retrieves a list of plant depths

In case of a successful request, the system will return the existing plant depths and status code 200.


/api/PlantDepths/GetPlantDepths

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/PlantDepths/GetPlantDepths"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantDepthsApi;

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

public class PlantDepthsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantDepthsApi apiInstance = new PlantDepthsApi();
        try {
            PlantDepthModelArrayQueryDispatchResult result = apiInstance.getPlantDepths();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantDepthsApi#getPlantDepths");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantDepthsApi;

public class PlantDepthsApiExample {

    public static void main(String[] args) {
        PlantDepthsApi apiInstance = new PlantDepthsApi();
        try {
            PlantDepthModelArrayQueryDispatchResult result = apiInstance.getPlantDepths();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantDepthsApi#getPlantDepths");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of plant depths
[apiInstance getPlantDepthsWithCompletionHandler: 
              ^(PlantDepthModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantDepthsApi();

            try
            {
                // Retrieves a list of plant depths
                PlantDepthModelArrayQueryDispatchResult result = apiInstance.getPlantDepths();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantDepthsApi.getPlantDepths: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantDepthsApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantDepthsApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantDepthsApi()

try: 
    # Retrieves a list of plant depths
    api_response = api_instance.get_plant_depths()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantDepthsApi->getPlantDepths: %s\n" % e)

Parameters

Responses

Status: 200 - Plant depths retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plant depths list!


PlantDurations

getPlantDurations

Retrieves a list of plant durations

In case of a successful request, the system will return the existing plant durations and status code 200.


/api/PlantDurations/GetPlantDurations

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/PlantDurations/GetPlantDurations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantDurationsApi;

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

public class PlantDurationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantDurationsApi apiInstance = new PlantDurationsApi();
        try {
            PlantDurationModelArrayQueryDispatchResult result = apiInstance.getPlantDurations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantDurationsApi#getPlantDurations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantDurationsApi;

public class PlantDurationsApiExample {

    public static void main(String[] args) {
        PlantDurationsApi apiInstance = new PlantDurationsApi();
        try {
            PlantDurationModelArrayQueryDispatchResult result = apiInstance.getPlantDurations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantDurationsApi#getPlantDurations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of plant durations
[apiInstance getPlantDurationsWithCompletionHandler: 
              ^(PlantDurationModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantDurationsApi();

            try
            {
                // Retrieves a list of plant durations
                PlantDurationModelArrayQueryDispatchResult result = apiInstance.getPlantDurations();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantDurationsApi.getPlantDurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantDurationsApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantDurationsApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantDurationsApi()

try: 
    # Retrieves a list of plant durations
    api_response = api_instance.get_plant_durations()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantDurationsApi->getPlantDurations: %s\n" % e)

Parameters

Responses

Status: 200 - Plant durations retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plant durations list!


PlantNotes

getPlantNote

Retrieves a specific plant note based on the provided plant noteID

In case of a successful request, the plant will return the details of the plant note matching the provided Id and status code 200


/api/PlantNotes/GetPlantNote

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/PlantNotes/GetPlantNote?plantNoteID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantNotesApi;

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

public class PlantNotesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantNotesApi apiInstance = new PlantNotesApi();
        Integer plantNoteID = 56; // Integer | 
        try {
            PlantNoteModelQueryDispatchResult result = apiInstance.getPlantNote(plantNoteID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantNotesApi#getPlantNote");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantNotesApi;

public class PlantNotesApiExample {

    public static void main(String[] args) {
        PlantNotesApi apiInstance = new PlantNotesApi();
        Integer plantNoteID = 56; // Integer | 
        try {
            PlantNoteModelQueryDispatchResult result = apiInstance.getPlantNote(plantNoteID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantNotesApi#getPlantNote");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantNoteID = 56; //  (optional)

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

// Retrieves a specific plant note based on the provided plant noteID
[apiInstance getPlantNoteWith:plantNoteID
              completionHandler: ^(PlantNoteModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantNotesApi()
var opts = { 
  'plantNoteID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlantNote(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantNotesApi();
            var plantNoteID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific plant note based on the provided plant noteID
                PlantNoteModelQueryDispatchResult result = apiInstance.getPlantNote(plantNoteID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantNotesApi.getPlantNote: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantNotesApi();
$plantNoteID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantNotesApi->new();
my $plantNoteID = 56; # Integer | 

eval { 
    my $result = $api_instance->getPlantNote(plantNoteID => $plantNoteID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantNotesApi->getPlantNote: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantNotesApi()
plantNoteID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific plant note based on the provided plant noteID
    api_response = api_instance.get_plant_note(plantNoteID=plantNoteID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantNotesApi->getPlantNote: %s\n" % e)

Parameters

Query parameters
Name Description
plantNoteID
Integer (int32)

Responses

Status: 200 - PlantNote details retrieved

Status: 400 - Invalid request body parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find a plant note linked to the provided Id

Status: 500 - An error occurred. Cannot retrieve the plant note details!


PlantOwnerTypes

getPlantOwnerTypes

Retrieves a list of plant owner types

In case of a successful request, the system will return the existing plant owner types and status code 200.


/api/PlantOwnerTypes/GetPlantOwnerTypes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/PlantOwnerTypes/GetPlantOwnerTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantOwnerTypesApi;

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

public class PlantOwnerTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantOwnerTypesApi apiInstance = new PlantOwnerTypesApi();
        try {
            PlantOwnerTypeModelArrayQueryDispatchResult result = apiInstance.getPlantOwnerTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantOwnerTypesApi#getPlantOwnerTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantOwnerTypesApi;

public class PlantOwnerTypesApiExample {

    public static void main(String[] args) {
        PlantOwnerTypesApi apiInstance = new PlantOwnerTypesApi();
        try {
            PlantOwnerTypeModelArrayQueryDispatchResult result = apiInstance.getPlantOwnerTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantOwnerTypesApi#getPlantOwnerTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of plant owner types
[apiInstance getPlantOwnerTypesWithCompletionHandler: 
              ^(PlantOwnerTypeModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantOwnerTypesApi();

            try
            {
                // Retrieves a list of plant owner types
                PlantOwnerTypeModelArrayQueryDispatchResult result = apiInstance.getPlantOwnerTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantOwnerTypesApi.getPlantOwnerTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantOwnerTypesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantOwnerTypesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantOwnerTypesApi()

try: 
    # Retrieves a list of plant owner types
    api_response = api_instance.get_plant_owner_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantOwnerTypesApi->getPlantOwnerTypes: %s\n" % e)

Parameters

Responses

Status: 200 - Plant owner types retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plant owner types list!


PlantStates

getPlantStates

Retrieves a list of plant states

In case of a successful request, the system will return the existing plant states and status code 200.


/api/PlantStates/GetPlantStates

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/PlantStates/GetPlantStates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantStatesApi;

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

public class PlantStatesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantStatesApi apiInstance = new PlantStatesApi();
        try {
            LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getPlantStates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantStatesApi#getPlantStates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantStatesApi;

public class PlantStatesApiExample {

    public static void main(String[] args) {
        PlantStatesApi apiInstance = new PlantStatesApi();
        try {
            LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getPlantStates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantStatesApi#getPlantStates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of plant states
[apiInstance getPlantStatesWithCompletionHandler: 
              ^(LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantStatesApi();

            try
            {
                // Retrieves a list of plant states
                LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getPlantStates();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantStatesApi.getPlantStates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantStatesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantStatesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantStatesApi()

try: 
    # Retrieves a list of plant states
    api_response = api_instance.get_plant_states()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantStatesApi->getPlantStates: %s\n" % e)

Parameters

Responses

Status: 200 - Plant states retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plant states list!


PlantSubTypes

getPlantSubTypes

Retrieves a list of plant subtypes

In case of a successful request, the system will return the existing plant subtypes and status code 200.


/api/PlantSubTypes/GetPlantSubTypes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/PlantSubTypes/GetPlantSubTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantSubTypesApi;

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

public class PlantSubTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantSubTypesApi apiInstance = new PlantSubTypesApi();
        try {
            PlantSubTypeModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getPlantSubTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantSubTypesApi#getPlantSubTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantSubTypesApi;

public class PlantSubTypesApiExample {

    public static void main(String[] args) {
        PlantSubTypesApi apiInstance = new PlantSubTypesApi();
        try {
            PlantSubTypeModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getPlantSubTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantSubTypesApi#getPlantSubTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of plant subtypes
[apiInstance getPlantSubTypesWithCompletionHandler: 
              ^(PlantSubTypeModelApplicationFilteredQueryResultQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantSubTypesApi();

            try
            {
                // Retrieves a list of plant subtypes
                PlantSubTypeModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getPlantSubTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantSubTypesApi.getPlantSubTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantSubTypesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantSubTypesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantSubTypesApi()

try: 
    # Retrieves a list of plant subtypes
    api_response = api_instance.get_plant_sub_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantSubTypesApi->getPlantSubTypes: %s\n" % e)

Parameters

Responses

Status: 200 - Plant subtypes retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plant subtypes list!


PlantTypes

getPlantTypes

Retrieves a list of plant types

In case of a successful request, the system will return the existing plant types and status code 200.


/api/PlantTypes/GetPlantTypes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/PlantTypes/GetPlantTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantTypesApi;

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

public class PlantTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantTypesApi apiInstance = new PlantTypesApi();
        try {
            LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getPlantTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantTypesApi#getPlantTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantTypesApi;

public class PlantTypesApiExample {

    public static void main(String[] args) {
        PlantTypesApi apiInstance = new PlantTypesApi();
        try {
            LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getPlantTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantTypesApi#getPlantTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of plant types
[apiInstance getPlantTypesWithCompletionHandler: 
              ^(LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantTypesApi();

            try
            {
                // Retrieves a list of plant types
                LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getPlantTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantTypesApi.getPlantTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantTypesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantTypesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantTypesApi()

try: 
    # Retrieves a list of plant types
    api_response = api_instance.get_plant_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantTypesApi->getPlantTypes: %s\n" % e)

Parameters

Responses

Status: 200 - Plant types retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plant types list!


PlantUsageTypes

getPlantUsageTypes

Retrieves a list of plant usage types

In case of a successful request, the system will return the existing plant usage types and status code 200.


/api/PlantUsageTypes/GetPlantUsageTypes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/PlantUsageTypes/GetPlantUsageTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantUsageTypesApi;

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

public class PlantUsageTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantUsageTypesApi apiInstance = new PlantUsageTypesApi();
        try {
            PlantUsageTypeModelArrayQueryDispatchResult result = apiInstance.getPlantUsageTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantUsageTypesApi#getPlantUsageTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantUsageTypesApi;

public class PlantUsageTypesApiExample {

    public static void main(String[] args) {
        PlantUsageTypesApi apiInstance = new PlantUsageTypesApi();
        try {
            PlantUsageTypeModelArrayQueryDispatchResult result = apiInstance.getPlantUsageTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantUsageTypesApi#getPlantUsageTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of plant usage types
[apiInstance getPlantUsageTypesWithCompletionHandler: 
              ^(PlantUsageTypeModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantUsageTypesApi();

            try
            {
                // Retrieves a list of plant usage types
                PlantUsageTypeModelArrayQueryDispatchResult result = apiInstance.getPlantUsageTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantUsageTypesApi.getPlantUsageTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantUsageTypesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantUsageTypesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantUsageTypesApi()

try: 
    # Retrieves a list of plant usage types
    api_response = api_instance.get_plant_usage_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantUsageTypesApi->getPlantUsageTypes: %s\n" % e)

Parameters

Responses

Status: 200 - Plant usage types retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plant usage types list!


PlantZones

getPlantZones

Retrieves a list of plant zones

In case of a successful request, the system will return the existing plant zones and status code 200.


/api/PlantZones/GetPlantZones

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/PlantZones/GetPlantZones"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantZonesApi;

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

public class PlantZonesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantZonesApi apiInstance = new PlantZonesApi();
        try {
            PlantZoneModelArrayQueryDispatchResult result = apiInstance.getPlantZones();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantZonesApi#getPlantZones");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantZonesApi;

public class PlantZonesApiExample {

    public static void main(String[] args) {
        PlantZonesApi apiInstance = new PlantZonesApi();
        try {
            PlantZoneModelArrayQueryDispatchResult result = apiInstance.getPlantZones();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantZonesApi#getPlantZones");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of plant zones
[apiInstance getPlantZonesWithCompletionHandler: 
              ^(PlantZoneModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantZonesApi();

            try
            {
                // Retrieves a list of plant zones
                PlantZoneModelArrayQueryDispatchResult result = apiInstance.getPlantZones();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantZonesApi.getPlantZones: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantZonesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantZonesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantZonesApi()

try: 
    # Retrieves a list of plant zones
    api_response = api_instance.get_plant_zones()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantZonesApi->getPlantZones: %s\n" % e)

Parameters

Responses

Status: 200 - Plant zones retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plant zones list!


Plants

getAreasByPlantID

Retrieves a specific list of areas based on the provided plantID

In case of a successful request, the system will return a list of areas that are linked to the plant and status code 200.


/api/Plants/GetAreasByPlantID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetAreasByPlantID?plantID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            AreaSummaryListModelArrayQueryDispatchResult result = apiInstance.getAreasByPlantID(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getAreasByPlantID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            AreaSummaryListModelArrayQueryDispatchResult result = apiInstance.getAreasByPlantID(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getAreasByPlantID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)

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

// Retrieves a specific list of areas based on the provided plantID
[apiInstance getAreasByPlantIDWith:plantID
              completionHandler: ^(AreaSummaryListModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'plantID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAreasByPlantID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var plantID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of areas based on the provided plantID
                AreaSummaryListModelArrayQueryDispatchResult result = apiInstance.getAreasByPlantID(plantID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getAreasByPlantID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$plantID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $plantID = 56; # Integer | 

eval { 
    my $result = $api_instance->getAreasByPlantID(plantID => $plantID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getAreasByPlantID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
plantID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of areas based on the provided plantID
    api_response = api_instance.get_areas_by_plant_id(plantID=plantID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getAreasByPlantID: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)

Responses

Status: 200 - List of linked areas retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided Id

Status: 500 - An error occurred. Cannot retrieve the linked Areas!


getBoreholesByPlantID

Retrieves a specific list of Boreholes based on the provided plant ID

In case of a successful request, the system will return a list of Boreholes that are linked to the plant and status code 200.


/api/Plants/GetBoreholesByPlantID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetBoreholesByPlantID?plantID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            BoreholeSummaryListModelArrayQueryDispatchResult result = apiInstance.getBoreholesByPlantID(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getBoreholesByPlantID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            BoreholeSummaryListModelArrayQueryDispatchResult result = apiInstance.getBoreholesByPlantID(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getBoreholesByPlantID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)

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

// Retrieves a specific list of Boreholes based on the provided plant ID
[apiInstance getBoreholesByPlantIDWith:plantID
              completionHandler: ^(BoreholeSummaryListModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'plantID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBoreholesByPlantID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var plantID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of Boreholes based on the provided plant ID
                BoreholeSummaryListModelArrayQueryDispatchResult result = apiInstance.getBoreholesByPlantID(plantID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getBoreholesByPlantID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$plantID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $plantID = 56; # Integer | 

eval { 
    my $result = $api_instance->getBoreholesByPlantID(plantID => $plantID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getBoreholesByPlantID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
plantID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of Boreholes based on the provided plant ID
    api_response = api_instance.get_boreholes_by_plant_id(plantID=plantID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getBoreholesByPlantID: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)

Responses

Status: 200 - List of linked Boreholes retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided Id

Status: 500 - An error occurred. Cannot retrieve the linked Boreholes!


getCompanyPlants

Retrieves the plants linked to a company to which the logged user is linked to via a contact person

In case of a successful request, the system will return the list of plants and status code 200.


/api/Plants/GetCompanyPlants

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetCompanyPlants?onlyUnhealthyPlants="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        Boolean onlyUnhealthyPlants = true; // Boolean | 
        try {
            CompanyPlantModelArrayQueryDispatchResult result = apiInstance.getCompanyPlants(onlyUnhealthyPlants);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getCompanyPlants");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        Boolean onlyUnhealthyPlants = true; // Boolean | 
        try {
            CompanyPlantModelArrayQueryDispatchResult result = apiInstance.getCompanyPlants(onlyUnhealthyPlants);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getCompanyPlants");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Boolean *onlyUnhealthyPlants = true; //  (optional)

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

// Retrieves the plants linked to a company to which the logged user is linked to via a contact person
[apiInstance getCompanyPlantsWith:onlyUnhealthyPlants
              completionHandler: ^(CompanyPlantModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'onlyUnhealthyPlants': true // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCompanyPlants(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var onlyUnhealthyPlants = true;  // Boolean |  (optional) 

            try
            {
                // Retrieves the plants linked to a company to which the logged user is linked to via a contact person
                CompanyPlantModelArrayQueryDispatchResult result = apiInstance.getCompanyPlants(onlyUnhealthyPlants);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getCompanyPlants: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$onlyUnhealthyPlants = true; // Boolean | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $onlyUnhealthyPlants = true; # Boolean | 

eval { 
    my $result = $api_instance->getCompanyPlants(onlyUnhealthyPlants => $onlyUnhealthyPlants);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getCompanyPlants: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
onlyUnhealthyPlants = true # Boolean |  (optional)

try: 
    # Retrieves the plants linked to a company to which the logged user is linked to via a contact person
    api_response = api_instance.get_company_plants(onlyUnhealthyPlants=onlyUnhealthyPlants)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getCompanyPlants: %s\n" % e)

Parameters

Query parameters
Name Description
onlyUnhealthyPlants
Boolean

Responses

Status: 200 - List of plants retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the list of plants!


getFilteredProjectPlants

Retrieves a specific list of plants based on the query parameters

In case of a successful request, the system will return a list of plants and status code 200.


/api/Plants/GetFilteredProjectPlants

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetFilteredProjectPlants?searchFilter=&coordinateX=&coordinateY=&areaID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        String searchFilter = searchFilter_example; // String | 
        Integer coordinateX = 56; // Integer | 
        Integer coordinateY = 56; // Integer | 
        Integer areaID = 56; // Integer | 
        try {
            PlantSummaryListModelArrayQueryDispatchResult result = apiInstance.getFilteredProjectPlants(searchFilter, coordinateX, coordinateY, areaID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getFilteredProjectPlants");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        String searchFilter = searchFilter_example; // String | 
        Integer coordinateX = 56; // Integer | 
        Integer coordinateY = 56; // Integer | 
        Integer areaID = 56; // Integer | 
        try {
            PlantSummaryListModelArrayQueryDispatchResult result = apiInstance.getFilteredProjectPlants(searchFilter, coordinateX, coordinateY, areaID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getFilteredProjectPlants");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *searchFilter = searchFilter_example; //  (optional)
Integer *coordinateX = 56; //  (optional)
Integer *coordinateY = 56; //  (optional)
Integer *areaID = 56; //  (optional)

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

// Retrieves a specific list of plants based on the query parameters
[apiInstance getFilteredProjectPlantsWith:searchFilter
    coordinateX:coordinateX
    coordinateY:coordinateY
    areaID:areaID
              completionHandler: ^(PlantSummaryListModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} 
  'coordinateX': 56, // {{Integer}} 
  'coordinateY': 56, // {{Integer}} 
  'areaID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilteredProjectPlants(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var searchFilter = searchFilter_example;  // String |  (optional) 
            var coordinateX = 56;  // Integer |  (optional) 
            var coordinateY = 56;  // Integer |  (optional) 
            var areaID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of plants based on the query parameters
                PlantSummaryListModelArrayQueryDispatchResult result = apiInstance.getFilteredProjectPlants(searchFilter, coordinateX, coordinateY, areaID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getFilteredProjectPlants: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$searchFilter = searchFilter_example; // String | 
$coordinateX = 56; // Integer | 
$coordinateY = 56; // Integer | 
$areaID = 56; // Integer | 

try {
    $result = $api_instance->getFilteredProjectPlants($searchFilter, $coordinateX, $coordinateY, $areaID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PlantsApi->getFilteredProjectPlants: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlantsApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $searchFilter = searchFilter_example; # String | 
my $coordinateX = 56; # Integer | 
my $coordinateY = 56; # Integer | 
my $areaID = 56; # Integer | 

eval { 
    my $result = $api_instance->getFilteredProjectPlants(searchFilter => $searchFilter, coordinateX => $coordinateX, coordinateY => $coordinateY, areaID => $areaID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getFilteredProjectPlants: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
searchFilter = searchFilter_example # String |  (optional)
coordinateX = 56 # Integer |  (optional)
coordinateY = 56 # Integer |  (optional)
areaID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of plants based on the query parameters
    api_response = api_instance.get_filtered_project_plants(searchFilter=searchFilter, coordinateX=coordinateX, coordinateY=coordinateY, areaID=areaID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getFilteredProjectPlants: %s\n" % e)

Parameters

Query parameters
Name Description
searchFilter
String
coordinateX
Integer (int32)
coordinateY
Integer (int32)
areaID
Integer (int32)

Responses

Status: 200 - List of plants retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plants list!


getNumberOfPlants

Retrieves the number of plants linked to a company to which the logged user is linked to via a contact person

In case of a successful request, the system will return the number of plants and status code 200.


/api/Plants/GetNumberOfPlants

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetNumberOfPlants"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        try {
            Int32QueryDispatchResult result = apiInstance.getNumberOfPlants();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getNumberOfPlants");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        try {
            Int32QueryDispatchResult result = apiInstance.getNumberOfPlants();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getNumberOfPlants");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves the number of plants linked to a company to which the logged user is linked to via a contact person
[apiInstance getNumberOfPlantsWithCompletionHandler: 
              ^(Int32QueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();

            try
            {
                // Retrieves the number of plants linked to a company to which the logged user is linked to via a contact person
                Int32QueryDispatchResult result = apiInstance.getNumberOfPlants();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getNumberOfPlants: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()

try: 
    # Retrieves the number of plants linked to a company to which the logged user is linked to via a contact person
    api_response = api_instance.get_number_of_plants()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getNumberOfPlants: %s\n" % e)

Parameters

Responses

Status: 200 - Number of plants retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the number of plants!


getPlant

Retrieves a specific plant based on the provided Id

In case of a successful request, the system will return the details of the plant matching the provided Id and status code 200


/api/Plants/GetPlant

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetPlant?plantID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            PlantModelQueryDispatchResult result = apiInstance.getPlant(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getPlant");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            PlantModelQueryDispatchResult result = apiInstance.getPlant(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getPlant");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)

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

// Retrieves a specific plant based on the provided Id
[apiInstance getPlantWith:plantID
              completionHandler: ^(PlantModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'plantID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlant(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var plantID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific plant based on the provided Id
                PlantModelQueryDispatchResult result = apiInstance.getPlant(plantID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getPlant: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$plantID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $plantID = 56; # Integer | 

eval { 
    my $result = $api_instance->getPlant(plantID => $plantID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getPlant: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
plantID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific plant based on the provided Id
    api_response = api_instance.get_plant(plantID=plantID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getPlant: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)

Responses

Status: 200 - Plant details retrieved

Status: 400 - Invalid request body parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided Id

Status: 500 - An error occured. Cannot retrieve the plant!


getPlantOverview

Retrieves the overview for a specific plant

In case of a successful request, the system will return the plant overview and status code 200.


/api/Plants/GetPlantOverview

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetPlantOverview?plantId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        Integer plantId = 56; // Integer | 
        try {
            PlantOverviewModelQueryDispatchResult result = apiInstance.getPlantOverview(plantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getPlantOverview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        Integer plantId = 56; // Integer | 
        try {
            PlantOverviewModelQueryDispatchResult result = apiInstance.getPlantOverview(plantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getPlantOverview");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantId = 56; //  (optional)

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

// Retrieves the overview for a specific plant
[apiInstance getPlantOverviewWith:plantId
              completionHandler: ^(PlantOverviewModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'plantId': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlantOverview(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var plantId = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves the overview for a specific plant
                PlantOverviewModelQueryDispatchResult result = apiInstance.getPlantOverview(plantId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getPlantOverview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$plantId = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $plantId = 56; # Integer | 

eval { 
    my $result = $api_instance->getPlantOverview(plantId => $plantId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getPlantOverview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
plantId = 56 # Integer |  (optional)

try: 
    # Retrieves the overview for a specific plant
    api_response = api_instance.get_plant_overview(plantId=plantId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getPlantOverview: %s\n" % e)

Parameters

Query parameters
Name Description
plantId
Integer (int32)

Responses

Status: 200 - Plant overview retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plant!


getPlantSummary

Retrieves a specific plant based on the provided plant ID

In case of a successful request, the system will return the summary details of the plant matching the provided Id and status code 200


/api/Plants/GetPlantSummary

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetPlantSummary?plantID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            PlantSummaryModelQueryDispatchResult result = apiInstance.getPlantSummary(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getPlantSummary");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            PlantSummaryModelQueryDispatchResult result = apiInstance.getPlantSummary(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getPlantSummary");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)

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

// Retrieves a specific plant based on the provided plant ID
[apiInstance getPlantSummaryWith:plantID
              completionHandler: ^(PlantSummaryModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'plantID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlantSummary(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var plantID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific plant based on the provided plant ID
                PlantSummaryModelQueryDispatchResult result = apiInstance.getPlantSummary(plantID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getPlantSummary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$plantID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $plantID = 56; # Integer | 

eval { 
    my $result = $api_instance->getPlantSummary(plantID => $plantID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getPlantSummary: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
plantID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific plant based on the provided plant ID
    api_response = api_instance.get_plant_summary(plantID=plantID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getPlantSummary: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)

Responses

Status: 200 - ProjectPlant summary details retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find a plant linked to the provided Id

Status: 500 - An error occurred. Cannot retrieve the plant summary details!


getPlantsByContactPersonID

Retrieves a list of plants based on the provided contactPersonID

In case of a successful request, the system will return the list of the plants matching the provided Id and status code 200


/api/Plants/GetPlantsByContactPersonID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetPlantsByContactPersonID?contactPersonID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        Integer contactPersonID = 56; // Integer | 
        try {
            PlantBaseModelArrayQueryDispatchResult result = apiInstance.getPlantsByContactPersonID(contactPersonID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getPlantsByContactPersonID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        Integer contactPersonID = 56; // Integer | 
        try {
            PlantBaseModelArrayQueryDispatchResult result = apiInstance.getPlantsByContactPersonID(contactPersonID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getPlantsByContactPersonID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *contactPersonID = 56; //  (optional)

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

// Retrieves a list of plants based on the provided contactPersonID
[apiInstance getPlantsByContactPersonIDWith:contactPersonID
              completionHandler: ^(PlantBaseModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'contactPersonID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlantsByContactPersonID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var contactPersonID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a list of plants based on the provided contactPersonID
                PlantBaseModelArrayQueryDispatchResult result = apiInstance.getPlantsByContactPersonID(contactPersonID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getPlantsByContactPersonID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$contactPersonID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $contactPersonID = 56; # Integer | 

eval { 
    my $result = $api_instance->getPlantsByContactPersonID(contactPersonID => $contactPersonID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getPlantsByContactPersonID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
contactPersonID = 56 # Integer |  (optional)

try: 
    # Retrieves a list of plants based on the provided contactPersonID
    api_response = api_instance.get_plants_by_contact_person_id(contactPersonID=contactPersonID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getPlantsByContactPersonID: %s\n" % e)

Parameters

Query parameters
Name Description
contactPersonID
Integer (int32)

Responses

Status: 200 - Plant list retrieved

Status: 400 - Invalid request body parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the contact person with the provided Id

Status: 500 - An error occurred. Cannot retrieve the list of plants!


getPlantsByPlantID

Retrieves a specific list of linked plants based on the provided plant ID

In case of a successful request, the system will return a list of plants that are linked to the plant and status code 200.


/api/Plants/GetPlantsByPlantID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetPlantsByPlantID?plantID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            PlantSummaryListModelArrayQueryDispatchResult result = apiInstance.getPlantsByPlantID(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getPlantsByPlantID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            PlantSummaryListModelArrayQueryDispatchResult result = apiInstance.getPlantsByPlantID(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getPlantsByPlantID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)

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

// Retrieves a specific list of linked plants based on the provided plant ID
[apiInstance getPlantsByPlantIDWith:plantID
              completionHandler: ^(PlantSummaryListModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'plantID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlantsByPlantID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var plantID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of linked plants based on the provided plant ID
                PlantSummaryListModelArrayQueryDispatchResult result = apiInstance.getPlantsByPlantID(plantID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getPlantsByPlantID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$plantID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $plantID = 56; # Integer | 

eval { 
    my $result = $api_instance->getPlantsByPlantID(plantID => $plantID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getPlantsByPlantID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
plantID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of linked plants based on the provided plant ID
    api_response = api_instance.get_plants_by_plant_id(plantID=plantID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getPlantsByPlantID: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)

Responses

Status: 200 - List of linked plants retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided Id

Status: 500 - An error occurred. Cannot retrieve the linked plants!


getPlantsFiltered

Retrieves a specific list of plants based on the request parameters

In case of a successful request, the API will return a list of plants and status code 200.


/api/Plants/GetPlantsFiltered

Usage and SDK Samples

curl -X POST\
\
-H "Accept: application/json"\
-H "Content-Type: application/json-patch+json,application/json,text/json,application/*+json"\
"https://api.ifonline.nl/api/Plants/GetPlantsFiltered?skip=&take=&orderBy=&searchFilter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        PlantFilterModel body = ; // PlantFilterModel | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        String orderBy = orderBy_example; // String | 
        String searchFilter = searchFilter_example; // String | 
        try {
            PlantListFilteredModelPagedQueryResultQueryDispatchResult result = apiInstance.getPlantsFiltered(body, skip, take, orderBy, searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getPlantsFiltered");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        PlantFilterModel body = ; // PlantFilterModel | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        String orderBy = orderBy_example; // String | 
        String searchFilter = searchFilter_example; // String | 
        try {
            PlantListFilteredModelPagedQueryResultQueryDispatchResult result = apiInstance.getPlantsFiltered(body, skip, take, orderBy, searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getPlantsFiltered");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PlantFilterModel *body = ; //  (optional)
Integer *skip = 56; //  (optional)
Integer *take = 56; //  (optional)
String *orderBy = orderBy_example; //  (optional)
String *searchFilter = searchFilter_example; //  (optional)

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

// Retrieves a specific list of plants based on the request parameters
[apiInstance getPlantsFilteredWith:body
    skip:skip
    take:take
    orderBy:orderBy
    searchFilter:searchFilter
              completionHandler: ^(PlantListFilteredModelPagedQueryResultQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'body':  // {{PlantFilterModel}} 
  'skip': 56 // {{Integer}} 
  'take': 56 // {{Integer}} 
  'orderBy': orderBy_example // {{String}} 
  'searchFilter': searchFilter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPlantsFiltered(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var body = new PlantFilterModel(); // PlantFilterModel |  (optional) 
            var skip = 56;  // Integer |  (optional) 
            var take = 56;  // Integer |  (optional) 
            var orderBy = orderBy_example;  // String |  (optional) 
            var searchFilter = searchFilter_example;  // String |  (optional) 

            try
            {
                // Retrieves a specific list of plants based on the request parameters
                PlantListFilteredModelPagedQueryResultQueryDispatchResult result = apiInstance.getPlantsFiltered(body, skip, take, orderBy, searchFilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getPlantsFiltered: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$body = ; // PlantFilterModel | 
$skip = 56; // Integer | 
$take = 56; // Integer | 
$orderBy = orderBy_example; // String | 
$searchFilter = searchFilter_example; // String | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $body = WWW::SwaggerClient::Object::PlantFilterModel->new(); # PlantFilterModel | 
my $skip = 56; # Integer | 
my $take = 56; # Integer | 
my $orderBy = orderBy_example; # String | 
my $searchFilter = searchFilter_example; # String | 

eval { 
    my $result = $api_instance->getPlantsFiltered(body => $body, skip => $skip, take => $take, orderBy => $orderBy, searchFilter => $searchFilter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getPlantsFiltered: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
body =  # PlantFilterModel |  (optional)
skip = 56 # Integer |  (optional)
take = 56 # Integer |  (optional)
orderBy = orderBy_example # String |  (optional)
searchFilter = searchFilter_example # String |  (optional)

try: 
    # Retrieves a specific list of plants based on the request parameters
    api_response = api_instance.get_plants_filtered(body=body, skip=skip, take=take, orderBy=orderBy, searchFilter=searchFilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getPlantsFiltered: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
skip
Integer (int32)
take
Integer (int32)
orderBy
String
searchFilter
String

Responses

Status: 200 - List of plants retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plants list!


getProjectPlant

Retrieves a specific plant based on the provided Id

In case of a successful request, the system will return the details of the plant matching the provided Id and status code 200


/api/Plants/GetProjectPlant

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetProjectPlant?plantID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            ProjectPlantModelQueryDispatchResult result = apiInstance.getProjectPlant(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getProjectPlant");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            ProjectPlantModelQueryDispatchResult result = apiInstance.getProjectPlant(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getProjectPlant");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)

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

// Retrieves a specific plant based on the provided Id
[apiInstance getProjectPlantWith:plantID
              completionHandler: ^(ProjectPlantModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'plantID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectPlant(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var plantID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific plant based on the provided Id
                ProjectPlantModelQueryDispatchResult result = apiInstance.getProjectPlant(plantID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getProjectPlant: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$plantID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $plantID = 56; # Integer | 

eval { 
    my $result = $api_instance->getProjectPlant(plantID => $plantID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getProjectPlant: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
plantID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific plant based on the provided Id
    api_response = api_instance.get_project_plant(plantID=plantID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getProjectPlant: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)

Responses

Status: 200 - Project plant details retrieved

Status: 400 - Invalid request body parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided Id

Status: 500 - An error occured. Cannot retrieve the plant!


getProjectPlants

Retrieves a specific list of plants based on the query parameters

In case of a successful request, the system will return the existing total number of records a list of plants ordered by default by Name and status code 200.


/api/Plants/GetProjectPlants

Usage and SDK Samples

curl -X POST\
\
-H "Accept: application/json"\
-H "Content-Type: application/json-patch+json,application/json,text/json,application/*+json"\
"https://api.ifonline.nl/api/Plants/GetProjectPlants?skip=&take=&orderBy=&searchFilter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        FilterModel body = ; // FilterModel | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        String orderBy = orderBy_example; // String | 
        String searchFilter = searchFilter_example; // String | 
        try {
            ProjectPlantListModelPagedQueryResultQueryDispatchResult result = apiInstance.getProjectPlants(body, skip, take, orderBy, searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getProjectPlants");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        FilterModel body = ; // FilterModel | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        String orderBy = orderBy_example; // String | 
        String searchFilter = searchFilter_example; // String | 
        try {
            ProjectPlantListModelPagedQueryResultQueryDispatchResult result = apiInstance.getProjectPlants(body, skip, take, orderBy, searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getProjectPlants");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
FilterModel *body = ; //  (optional)
Integer *skip = 56; //  (optional)
Integer *take = 56; //  (optional)
String *orderBy = orderBy_example; //  (optional)
String *searchFilter = searchFilter_example; //  (optional)

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

// Retrieves a specific list of plants based on the query parameters
[apiInstance getProjectPlantsWith:body
    skip:skip
    take:take
    orderBy:orderBy
    searchFilter:searchFilter
              completionHandler: ^(ProjectPlantListModelPagedQueryResultQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'body':  // {{FilterModel}} 
  'skip': 56 // {{Integer}} 
  'take': 56 // {{Integer}} 
  'orderBy': orderBy_example // {{String}} 
  'searchFilter': searchFilter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectPlants(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var body = new FilterModel(); // FilterModel |  (optional) 
            var skip = 56;  // Integer |  (optional) 
            var take = 56;  // Integer |  (optional) 
            var orderBy = orderBy_example;  // String |  (optional) 
            var searchFilter = searchFilter_example;  // String |  (optional) 

            try
            {
                // Retrieves a specific list of plants based on the query parameters
                ProjectPlantListModelPagedQueryResultQueryDispatchResult result = apiInstance.getProjectPlants(body, skip, take, orderBy, searchFilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getProjectPlants: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$body = ; // FilterModel | 
$skip = 56; // Integer | 
$take = 56; // Integer | 
$orderBy = orderBy_example; // String | 
$searchFilter = searchFilter_example; // String | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $body = WWW::SwaggerClient::Object::FilterModel->new(); # FilterModel | 
my $skip = 56; # Integer | 
my $take = 56; # Integer | 
my $orderBy = orderBy_example; # String | 
my $searchFilter = searchFilter_example; # String | 

eval { 
    my $result = $api_instance->getProjectPlants(body => $body, skip => $skip, take => $take, orderBy => $orderBy, searchFilter => $searchFilter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getProjectPlants: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
body =  # FilterModel |  (optional)
skip = 56 # Integer |  (optional)
take = 56 # Integer |  (optional)
orderBy = orderBy_example # String |  (optional)
searchFilter = searchFilter_example # String |  (optional)

try: 
    # Retrieves a specific list of plants based on the query parameters
    api_response = api_instance.get_project_plants(body=body, skip=skip, take=take, orderBy=orderBy, searchFilter=searchFilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getProjectPlants: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
skip
Integer (int32)
take
Integer (int32)
orderBy
String
searchFilter
String

Responses

Status: 200 - List of plants retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the plants list!


getProjectsByPlantID

Retrieves a specific list of Projects based on the provided plant ID

In case of a successful request, the system will return a list of Projects that are linked to the plant and status code 200.


/api/Plants/GetProjectsByPlantID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetProjectsByPlantID?plantID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            ProjectSummaryListModelArrayQueryDispatchResult result = apiInstance.getProjectsByPlantID(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getProjectsByPlantID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            ProjectSummaryListModelArrayQueryDispatchResult result = apiInstance.getProjectsByPlantID(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getProjectsByPlantID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)

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

// Retrieves a specific list of Projects based on the provided plant ID
[apiInstance getProjectsByPlantIDWith:plantID
              completionHandler: ^(ProjectSummaryListModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'plantID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectsByPlantID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var plantID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of Projects based on the provided plant ID
                ProjectSummaryListModelArrayQueryDispatchResult result = apiInstance.getProjectsByPlantID(plantID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getProjectsByPlantID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$plantID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $plantID = 56; # Integer | 

eval { 
    my $result = $api_instance->getProjectsByPlantID(plantID => $plantID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getProjectsByPlantID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
plantID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of Projects based on the provided plant ID
    api_response = api_instance.get_projects_by_plant_id(plantID=plantID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getProjectsByPlantID: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)

Responses

Status: 200 - List of linked Projects retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided Id

Status: 500 - An error occurred. Cannot retrieve the linked Projects!


getTotalCountOfPlantsByMeasurementStatus

Retrieves number of plants that have the specified MeasurementStatus.Code.

In case of a successful request, the count for the number of plants with the specified MeasurementStatus.Code will be returned.


/api/Plants/GetTotalCountOfPlantsByMeasurementStatus

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetTotalCountOfPlantsByMeasurementStatus?measurementStatusCode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        String measurementStatusCode = measurementStatusCode_example; // String | 
        try {
            Int32NullableQueryDispatchResult result = apiInstance.getTotalCountOfPlantsByMeasurementStatus(measurementStatusCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getTotalCountOfPlantsByMeasurementStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        String measurementStatusCode = measurementStatusCode_example; // String | 
        try {
            Int32NullableQueryDispatchResult result = apiInstance.getTotalCountOfPlantsByMeasurementStatus(measurementStatusCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getTotalCountOfPlantsByMeasurementStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *measurementStatusCode = measurementStatusCode_example; //  (optional)

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

// Retrieves number of plants that have the specified MeasurementStatus.Code.
[apiInstance getTotalCountOfPlantsByMeasurementStatusWith:measurementStatusCode
              completionHandler: ^(Int32NullableQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'measurementStatusCode': measurementStatusCode_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTotalCountOfPlantsByMeasurementStatus(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var measurementStatusCode = measurementStatusCode_example;  // String |  (optional) 

            try
            {
                // Retrieves number of plants that have the specified MeasurementStatus.Code.
                Int32NullableQueryDispatchResult result = apiInstance.getTotalCountOfPlantsByMeasurementStatus(measurementStatusCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getTotalCountOfPlantsByMeasurementStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$measurementStatusCode = measurementStatusCode_example; // String | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $measurementStatusCode = measurementStatusCode_example; # String | 

eval { 
    my $result = $api_instance->getTotalCountOfPlantsByMeasurementStatus(measurementStatusCode => $measurementStatusCode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getTotalCountOfPlantsByMeasurementStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
measurementStatusCode = measurementStatusCode_example # String |  (optional)

try: 
    # Retrieves number of plants that have the specified MeasurementStatus.Code.
    api_response = api_instance.get_total_count_of_plants_by_measurement_status(measurementStatusCode=measurementStatusCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getTotalCountOfPlantsByMeasurementStatus: %s\n" % e)

Parameters

Query parameters
Name Description
measurementStatusCode
String

Responses

Status: 204 - Count successfuly retrieved.

Status: 401 - Unauthorized request

Status: 404 - Invalid Measurment Status Code

Status: 500 - An error occurred. Cannot retrieve requested info.


getWellsByPlantID

Retrieves a specific list of wells based on the provided plant ID

In case of a successful request, the system will return a list of wells that are linked to the plant and status code 200.


/api/Plants/GetWellsByPlantID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Plants/GetWellsByPlantID?plantID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlantsApi;

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

public class PlantsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            WellSummaryListModelArrayQueryDispatchResult result = apiInstance.getWellsByPlantID(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getWellsByPlantID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlantsApi;

public class PlantsApiExample {

    public static void main(String[] args) {
        PlantsApi apiInstance = new PlantsApi();
        Integer plantID = 56; // Integer | 
        try {
            WellSummaryListModelArrayQueryDispatchResult result = apiInstance.getWellsByPlantID(plantID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlantsApi#getWellsByPlantID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *plantID = 56; //  (optional)

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

// Retrieves a specific list of wells based on the provided plant ID
[apiInstance getWellsByPlantIDWith:plantID
              completionHandler: ^(WellSummaryListModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.PlantsApi()
var opts = { 
  'plantID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWellsByPlantID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PlantsApi();
            var plantID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of wells based on the provided plant ID
                WellSummaryListModelArrayQueryDispatchResult result = apiInstance.getWellsByPlantID(plantID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlantsApi.getWellsByPlantID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPlantsApi();
$plantID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PlantsApi->new();
my $plantID = 56; # Integer | 

eval { 
    my $result = $api_instance->getWellsByPlantID(plantID => $plantID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PlantsApi->getWellsByPlantID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PlantsApi()
plantID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of wells based on the provided plant ID
    api_response = api_instance.get_wells_by_plant_id(plantID=plantID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlantsApi->getWellsByPlantID: %s\n" % e)

Parameters

Query parameters
Name Description
plantID
Integer (int32)

Responses

Status: 200 - List of linked wells retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the plant with the provided Id

Status: 500 - An error occurred. Cannot retrieve the linked wells!


Products

getProducts

Retrieves the existing products

In case of a successful request, the system will return the list of products and status code 200


/api/Products/GetProducts

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Products/GetProducts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProductsApi;

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

public class ProductsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProductsApi apiInstance = new ProductsApi();
        try {
            LookupModelArrayQueryDispatchResult result = apiInstance.getProducts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProducts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProductsApi;

public class ProductsApiExample {

    public static void main(String[] args) {
        ProductsApi apiInstance = new ProductsApi();
        try {
            LookupModelArrayQueryDispatchResult result = apiInstance.getProducts();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProductsApi#getProducts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves the existing products
[apiInstance getProductsWithCompletionHandler: 
              ^(LookupModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ProductsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProducts(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()
        {

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProductsApi();

            try
            {
                // Retrieves the existing products
                LookupModelArrayQueryDispatchResult result = apiInstance.getProducts();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProductsApi.getProducts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProductsApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProductsApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProductsApi()

try: 
    # Retrieves the existing products
    api_response = api_instance.get_products()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProductsApi->getProducts: %s\n" % e)

Parameters

Responses

Status: 200 - List of products retrieved

Status: 401 - Unauthorized request


ProjectTypes

getProjectTypes

Retrieves the existing project types

In case of a successful request, the system will return the list of project types and status code 200


/api/ProjectTypes/GetProjectTypes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/ProjectTypes/GetProjectTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectTypesApi;

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

public class ProjectTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProjectTypesApi apiInstance = new ProjectTypesApi();
        try {
            LookupModelArrayQueryDispatchResult result = apiInstance.getProjectTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectTypesApi#getProjectTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectTypesApi;

public class ProjectTypesApiExample {

    public static void main(String[] args) {
        ProjectTypesApi apiInstance = new ProjectTypesApi();
        try {
            LookupModelArrayQueryDispatchResult result = apiInstance.getProjectTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectTypesApi#getProjectTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves the existing project types
[apiInstance getProjectTypesWithCompletionHandler: 
              ^(LookupModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectTypesApi();

            try
            {
                // Retrieves the existing project types
                LookupModelArrayQueryDispatchResult result = apiInstance.getProjectTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectTypesApi.getProjectTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectTypesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectTypesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectTypesApi()

try: 
    # Retrieves the existing project types
    api_response = api_instance.get_project_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectTypesApi->getProjectTypes: %s\n" % e)

Parameters

Responses

Status: 200 - List of project types retrieved

Status: 401 - Unauthorized request


Projects

getAreasByProjectID

Retrieves a specific list of linked areas based on the provided project ID

In case of a successful request, the system will return a list of wells that are linked to the project and status code 200.


/api/Projects/GetAreasByProjectID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Projects/GetAreasByProjectID?projectID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectsApi;

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

public class ProjectsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            AreaSummaryListModelArrayQueryDispatchResult result = apiInstance.getAreasByProjectID(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getAreasByProjectID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectsApi;

public class ProjectsApiExample {

    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            AreaSummaryListModelArrayQueryDispatchResult result = apiInstance.getAreasByProjectID(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getAreasByProjectID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *projectID = 56; //  (optional)

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

// Retrieves a specific list of linked areas based on the provided project ID
[apiInstance getAreasByProjectIDWith:projectID
              completionHandler: ^(AreaSummaryListModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ProjectsApi()
var opts = { 
  'projectID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAreasByProjectID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectsApi();
            var projectID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of linked areas based on the provided project ID
                AreaSummaryListModelArrayQueryDispatchResult result = apiInstance.getAreasByProjectID(projectID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectsApi.getAreasByProjectID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectsApi();
$projectID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectsApi->new();
my $projectID = 56; # Integer | 

eval { 
    my $result = $api_instance->getAreasByProjectID(projectID => $projectID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->getAreasByProjectID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectsApi()
projectID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of linked areas based on the provided project ID
    api_response = api_instance.get_areas_by_project_id(projectID=projectID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getAreasByProjectID: %s\n" % e)

Parameters

Query parameters
Name Description
projectID
Integer (int32)

Responses

Status: 200 - List of linked areas retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the project with the provided Id

Status: 500 - An error occurred. Cannot retrieve the linked areas!


getBoreholesByProjectID

Retrieves a specific list of linked boreholes based on the provided project ID

In case of a successful request, the system will return a list of boreholes that are linked to the project and status code 200.


/api/Projects/GetBoreholesByProjectID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Projects/GetBoreholesByProjectID?projectID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectsApi;

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

public class ProjectsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            BoreholeSummaryListModelArrayQueryDispatchResult result = apiInstance.getBoreholesByProjectID(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getBoreholesByProjectID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectsApi;

public class ProjectsApiExample {

    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            BoreholeSummaryListModelArrayQueryDispatchResult result = apiInstance.getBoreholesByProjectID(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getBoreholesByProjectID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *projectID = 56; //  (optional)

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

// Retrieves a specific list of linked boreholes based on the provided project ID
[apiInstance getBoreholesByProjectIDWith:projectID
              completionHandler: ^(BoreholeSummaryListModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ProjectsApi()
var opts = { 
  'projectID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBoreholesByProjectID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectsApi();
            var projectID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of linked boreholes based on the provided project ID
                BoreholeSummaryListModelArrayQueryDispatchResult result = apiInstance.getBoreholesByProjectID(projectID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectsApi.getBoreholesByProjectID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectsApi();
$projectID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectsApi->new();
my $projectID = 56; # Integer | 

eval { 
    my $result = $api_instance->getBoreholesByProjectID(projectID => $projectID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->getBoreholesByProjectID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectsApi()
projectID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of linked boreholes based on the provided project ID
    api_response = api_instance.get_boreholes_by_project_id(projectID=projectID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getBoreholesByProjectID: %s\n" % e)

Parameters

Query parameters
Name Description
projectID
Integer (int32)

Responses

Status: 200 - List of linked boreholes retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the project with the provided Id

Status: 500 - An error occurred. Cannot retrieve the linked boreholes!


getFilteredProjects

Retrieves a specific list of projects based on the query parameters

In case of a successful request, the system will return a list of projects and status code 200.


/api/Projects/GetFilteredProjects

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Projects/GetFilteredProjects?searchFilter=&coordinateX=&coordinateY=&areaID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectsApi;

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

public class ProjectsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProjectsApi apiInstance = new ProjectsApi();
        String searchFilter = searchFilter_example; // String | 
        Integer coordinateX = 56; // Integer | 
        Integer coordinateY = 56; // Integer | 
        Integer areaID = 56; // Integer | 
        try {
            ProjectSummaryListModelArrayQueryDispatchResult result = apiInstance.getFilteredProjects(searchFilter, coordinateX, coordinateY, areaID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getFilteredProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectsApi;

public class ProjectsApiExample {

    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        String searchFilter = searchFilter_example; // String | 
        Integer coordinateX = 56; // Integer | 
        Integer coordinateY = 56; // Integer | 
        Integer areaID = 56; // Integer | 
        try {
            ProjectSummaryListModelArrayQueryDispatchResult result = apiInstance.getFilteredProjects(searchFilter, coordinateX, coordinateY, areaID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getFilteredProjects");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *searchFilter = searchFilter_example; //  (optional)
Integer *coordinateX = 56; //  (optional)
Integer *coordinateY = 56; //  (optional)
Integer *areaID = 56; //  (optional)

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

// Retrieves a specific list of projects based on the query parameters
[apiInstance getFilteredProjectsWith:searchFilter
    coordinateX:coordinateX
    coordinateY:coordinateY
    areaID:areaID
              completionHandler: ^(ProjectSummaryListModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ProjectsApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} 
  'coordinateX': 56, // {{Integer}} 
  'coordinateY': 56, // {{Integer}} 
  'areaID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilteredProjects(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectsApi();
            var searchFilter = searchFilter_example;  // String |  (optional) 
            var coordinateX = 56;  // Integer |  (optional) 
            var coordinateY = 56;  // Integer |  (optional) 
            var areaID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of projects based on the query parameters
                ProjectSummaryListModelArrayQueryDispatchResult result = apiInstance.getFilteredProjects(searchFilter, coordinateX, coordinateY, areaID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectsApi.getFilteredProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectsApi();
$searchFilter = searchFilter_example; // String | 
$coordinateX = 56; // Integer | 
$coordinateY = 56; // Integer | 
$areaID = 56; // Integer | 

try {
    $result = $api_instance->getFilteredProjects($searchFilter, $coordinateX, $coordinateY, $areaID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->getFilteredProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectsApi;

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectsApi->new();
my $searchFilter = searchFilter_example; # String | 
my $coordinateX = 56; # Integer | 
my $coordinateY = 56; # Integer | 
my $areaID = 56; # Integer | 

eval { 
    my $result = $api_instance->getFilteredProjects(searchFilter => $searchFilter, coordinateX => $coordinateX, coordinateY => $coordinateY, areaID => $areaID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->getFilteredProjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectsApi()
searchFilter = searchFilter_example # String |  (optional)
coordinateX = 56 # Integer |  (optional)
coordinateY = 56 # Integer |  (optional)
areaID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of projects based on the query parameters
    api_response = api_instance.get_filtered_projects(searchFilter=searchFilter, coordinateX=coordinateX, coordinateY=coordinateY, areaID=areaID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getFilteredProjects: %s\n" % e)

Parameters

Query parameters
Name Description
searchFilter
String
coordinateX
Integer (int32)
coordinateY
Integer (int32)
areaID
Integer (int32)

Responses

Status: 200 - List of projects retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the projects list!


getProject

Retrieves a specific project based on the provided project ID

In case of a successful request, the system will return the details of the project matching the provided Id and status code 200


/api/Projects/GetProject

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Projects/GetProject?projectID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectsApi;

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

public class ProjectsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            ProjectModelQueryDispatchResult result = apiInstance.getProject(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectsApi;

public class ProjectsApiExample {

    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            ProjectModelQueryDispatchResult result = apiInstance.getProject(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *projectID = 56; //  (optional)

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

// Retrieves a specific project based on the provided project ID
[apiInstance getProjectWith:projectID
              completionHandler: ^(ProjectModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ProjectsApi()
var opts = { 
  'projectID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProject(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectsApi();
            var projectID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific project based on the provided project ID
                ProjectModelQueryDispatchResult result = apiInstance.getProject(projectID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectsApi.getProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectsApi();
$projectID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectsApi->new();
my $projectID = 56; # Integer | 

eval { 
    my $result = $api_instance->getProject(projectID => $projectID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->getProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectsApi()
projectID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific project based on the provided project ID
    api_response = api_instance.get_project(projectID=projectID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getProject: %s\n" % e)

Parameters

Query parameters
Name Description
projectID
Integer (int32)

Responses

Status: 200 - Project details retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find a project linked to the provided Id

Status: 500 - An error occurred. Cannot retrieve the project details!


getProjectPlantsByProjectID

Retrieves a specific list of linked plants based on the provided project ID

In case of a successful request, the system will return a list of plants that are linked to the project and status code 200.


/api/Projects/GetProjectPlantsByProjectID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Projects/GetProjectPlantsByProjectID?projectID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectsApi;

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

public class ProjectsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            PlantSummaryListModelArrayQueryDispatchResult result = apiInstance.getProjectPlantsByProjectID(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProjectPlantsByProjectID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectsApi;

public class ProjectsApiExample {

    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            PlantSummaryListModelArrayQueryDispatchResult result = apiInstance.getProjectPlantsByProjectID(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProjectPlantsByProjectID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *projectID = 56; //  (optional)

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

// Retrieves a specific list of linked plants based on the provided project ID
[apiInstance getProjectPlantsByProjectIDWith:projectID
              completionHandler: ^(PlantSummaryListModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ProjectsApi()
var opts = { 
  'projectID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectPlantsByProjectID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectsApi();
            var projectID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of linked plants based on the provided project ID
                PlantSummaryListModelArrayQueryDispatchResult result = apiInstance.getProjectPlantsByProjectID(projectID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectsApi.getProjectPlantsByProjectID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectsApi();
$projectID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectsApi->new();
my $projectID = 56; # Integer | 

eval { 
    my $result = $api_instance->getProjectPlantsByProjectID(projectID => $projectID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->getProjectPlantsByProjectID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectsApi()
projectID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of linked plants based on the provided project ID
    api_response = api_instance.get_project_plants_by_project_id(projectID=projectID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getProjectPlantsByProjectID: %s\n" % e)

Parameters

Query parameters
Name Description
projectID
Integer (int32)

Responses

Status: 200 - List of linked plants retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the project with the provided Id

Status: 500 - An error occurred. Cannot retrieve the linked plants!


getProjectSummary

Retrieves a specific project based on the provided project ID

In case of a successful request, the system will return the summary details of the project matching the provided Id and status code 200


/api/Projects/GetProjectSummary

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Projects/GetProjectSummary?projectID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectsApi;

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

public class ProjectsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            ProjectSummaryModelQueryDispatchResult result = apiInstance.getProjectSummary(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProjectSummary");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectsApi;

public class ProjectsApiExample {

    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            ProjectSummaryModelQueryDispatchResult result = apiInstance.getProjectSummary(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProjectSummary");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *projectID = 56; //  (optional)

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

// Retrieves a specific project based on the provided project ID
[apiInstance getProjectSummaryWith:projectID
              completionHandler: ^(ProjectSummaryModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ProjectsApi()
var opts = { 
  'projectID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectSummary(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectsApi();
            var projectID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific project based on the provided project ID
                ProjectSummaryModelQueryDispatchResult result = apiInstance.getProjectSummary(projectID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectsApi.getProjectSummary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectsApi();
$projectID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectsApi->new();
my $projectID = 56; # Integer | 

eval { 
    my $result = $api_instance->getProjectSummary(projectID => $projectID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->getProjectSummary: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectsApi()
projectID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific project based on the provided project ID
    api_response = api_instance.get_project_summary(projectID=projectID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getProjectSummary: %s\n" % e)

Parameters

Query parameters
Name Description
projectID
Integer (int32)

Responses

Status: 200 - Project summary details retrieved

Status: 400 - Invalid query parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find a project linked to the provided Id

Status: 500 - An error occurred. Cannot retrieve the project summary details!


getProjects

Retrieves a specific list of projects based on the query parameters

In case of a successful request, the system will return the existing total number of records a list of projects ordered by default by Name and status code 200.


/api/Projects/GetProjects

Usage and SDK Samples

curl -X POST\
\
-H "Accept: application/json"\
-H "Content-Type: application/json-patch+json,application/json,text/json,application/*+json"\
"https://api.ifonline.nl/api/Projects/GetProjects?skip=&take=&orderBy=&searchFilter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectsApi;

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

public class ProjectsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProjectsApi apiInstance = new ProjectsApi();
        FilterModel body = ; // FilterModel | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        String orderBy = orderBy_example; // String | 
        String searchFilter = searchFilter_example; // String | 
        try {
            ProjectListModelPagedQueryResultQueryDispatchResult result = apiInstance.getProjects(body, skip, take, orderBy, searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectsApi;

public class ProjectsApiExample {

    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        FilterModel body = ; // FilterModel | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        String orderBy = orderBy_example; // String | 
        String searchFilter = searchFilter_example; // String | 
        try {
            ProjectListModelPagedQueryResultQueryDispatchResult result = apiInstance.getProjects(body, skip, take, orderBy, searchFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProjects");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
FilterModel *body = ; //  (optional)
Integer *skip = 56; //  (optional)
Integer *take = 56; //  (optional)
String *orderBy = orderBy_example; //  (optional)
String *searchFilter = searchFilter_example; //  (optional)

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

// Retrieves a specific list of projects based on the query parameters
[apiInstance getProjectsWith:body
    skip:skip
    take:take
    orderBy:orderBy
    searchFilter:searchFilter
              completionHandler: ^(ProjectListModelPagedQueryResultQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ProjectsApi()
var opts = { 
  'body':  // {{FilterModel}} 
  'skip': 56 // {{Integer}} 
  'take': 56 // {{Integer}} 
  'orderBy': orderBy_example // {{String}} 
  'searchFilter': searchFilter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjects(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectsApi();
            var body = new FilterModel(); // FilterModel |  (optional) 
            var skip = 56;  // Integer |  (optional) 
            var take = 56;  // Integer |  (optional) 
            var orderBy = orderBy_example;  // String |  (optional) 
            var searchFilter = searchFilter_example;  // String |  (optional) 

            try
            {
                // Retrieves a specific list of projects based on the query parameters
                ProjectListModelPagedQueryResultQueryDispatchResult result = apiInstance.getProjects(body, skip, take, orderBy, searchFilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectsApi.getProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectsApi();
$body = ; // FilterModel | 
$skip = 56; // Integer | 
$take = 56; // Integer | 
$orderBy = orderBy_example; // String | 
$searchFilter = searchFilter_example; // String | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectsApi->new();
my $body = WWW::SwaggerClient::Object::FilterModel->new(); # FilterModel | 
my $skip = 56; # Integer | 
my $take = 56; # Integer | 
my $orderBy = orderBy_example; # String | 
my $searchFilter = searchFilter_example; # String | 

eval { 
    my $result = $api_instance->getProjects(body => $body, skip => $skip, take => $take, orderBy => $orderBy, searchFilter => $searchFilter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->getProjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectsApi()
body =  # FilterModel |  (optional)
skip = 56 # Integer |  (optional)
take = 56 # Integer |  (optional)
orderBy = orderBy_example # String |  (optional)
searchFilter = searchFilter_example # String |  (optional)

try: 
    # Retrieves a specific list of projects based on the query parameters
    api_response = api_instance.get_projects(body=body, skip=skip, take=take, orderBy=orderBy, searchFilter=searchFilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getProjects: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
skip
Integer (int32)
take
Integer (int32)
orderBy
String
searchFilter
String

Responses

Status: 200 - List of projects retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the projects list!


getProjectsByProjectID

Retrieves a specific list of linked projects based on the provided project ID

In case of a successful request, the system will return a list of projects that are linked to the project and status code 200.


/api/Projects/GetProjectsByProjectID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Projects/GetProjectsByProjectID?projectID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectsApi;

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

public class ProjectsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            ProjectSummaryListModelArrayQueryDispatchResult result = apiInstance.getProjectsByProjectID(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProjectsByProjectID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectsApi;

public class ProjectsApiExample {

    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            ProjectSummaryListModelArrayQueryDispatchResult result = apiInstance.getProjectsByProjectID(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProjectsByProjectID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *projectID = 56; //  (optional)

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

// Retrieves a specific list of linked projects based on the provided project ID
[apiInstance getProjectsByProjectIDWith:projectID
              completionHandler: ^(ProjectSummaryListModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ProjectsApi()
var opts = { 
  'projectID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectsByProjectID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectsApi();
            var projectID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of linked projects based on the provided project ID
                ProjectSummaryListModelArrayQueryDispatchResult result = apiInstance.getProjectsByProjectID(projectID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectsApi.getProjectsByProjectID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectsApi();
$projectID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectsApi->new();
my $projectID = 56; # Integer | 

eval { 
    my $result = $api_instance->getProjectsByProjectID(projectID => $projectID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->getProjectsByProjectID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectsApi()
projectID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of linked projects based on the provided project ID
    api_response = api_instance.get_projects_by_project_id(projectID=projectID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getProjectsByProjectID: %s\n" % e)

Parameters

Query parameters
Name Description
projectID
Integer (int32)

Responses

Status: 200 - List of linked projects retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the project with the provided Id

Status: 500 - An error occurred. Cannot retrieve the linked projects!


getWellsByProjectID

Retrieves a specific list of linked wells based on the provided project ID

In case of a successful request, the system will return a list of wells that are linked to the project and status code 200.


/api/Projects/GetWellsByProjectID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Projects/GetWellsByProjectID?projectID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectsApi;

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

public class ProjectsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            WellSummaryListModelArrayQueryDispatchResult result = apiInstance.getWellsByProjectID(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getWellsByProjectID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectsApi;

public class ProjectsApiExample {

    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        Integer projectID = 56; // Integer | 
        try {
            WellSummaryListModelArrayQueryDispatchResult result = apiInstance.getWellsByProjectID(projectID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getWellsByProjectID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *projectID = 56; //  (optional)

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

// Retrieves a specific list of linked wells based on the provided project ID
[apiInstance getWellsByProjectIDWith:projectID
              completionHandler: ^(WellSummaryListModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ProjectsApi()
var opts = { 
  'projectID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWellsByProjectID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProjectsApi();
            var projectID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves a specific list of linked wells based on the provided project ID
                WellSummaryListModelArrayQueryDispatchResult result = apiInstance.getWellsByProjectID(projectID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectsApi.getWellsByProjectID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProjectsApi();
$projectID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProjectsApi->new();
my $projectID = 56; # Integer | 

eval { 
    my $result = $api_instance->getWellsByProjectID(projectID => $projectID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->getWellsByProjectID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProjectsApi()
projectID = 56 # Integer |  (optional)

try: 
    # Retrieves a specific list of linked wells based on the provided project ID
    api_response = api_instance.get_wells_by_project_id(projectID=projectID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getWellsByProjectID: %s\n" % e)

Parameters

Query parameters
Name Description
projectID
Integer (int32)

Responses

Status: 200 - List of linked wells retrieved

Status: 400 - Invalid request parameter

Status: 401 - Unauthorized request

Status: 404 - Cannot find the project with the provided Id

Status: 500 - An error occurred. Cannot retrieve the linked wells!


Provinces

getProvinceByCityID

Retrieves the existing province based on cityID

In case of a successful request, the system will return the province of the provided city and status code 200


/api/Provinces/GetProvinceByCityID

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Provinces/GetProvinceByCityID?cityID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvincesApi;

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

public class ProvincesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProvincesApi apiInstance = new ProvincesApi();
        Integer cityID = 56; // Integer | 
        try {
            ProvinceModelQueryDispatchResult result = apiInstance.getProvinceByCityID(cityID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvincesApi#getProvinceByCityID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvincesApi;

public class ProvincesApiExample {

    public static void main(String[] args) {
        ProvincesApi apiInstance = new ProvincesApi();
        Integer cityID = 56; // Integer | 
        try {
            ProvinceModelQueryDispatchResult result = apiInstance.getProvinceByCityID(cityID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvincesApi#getProvinceByCityID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *cityID = 56; //  (optional)

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

// Retrieves the existing province based on cityID
[apiInstance getProvinceByCityIDWith:cityID
              completionHandler: ^(ProvinceModelQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ProvincesApi()
var opts = { 
  'cityID': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProvinceByCityID(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProvincesApi();
            var cityID = 56;  // Integer |  (optional) 

            try
            {
                // Retrieves the existing province based on cityID
                ProvinceModelQueryDispatchResult result = apiInstance.getProvinceByCityID(cityID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvincesApi.getProvinceByCityID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProvincesApi();
$cityID = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProvincesApi->new();
my $cityID = 56; # Integer | 

eval { 
    my $result = $api_instance->getProvinceByCityID(cityID => $cityID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProvincesApi->getProvinceByCityID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProvincesApi()
cityID = 56 # Integer |  (optional)

try: 
    # Retrieves the existing province based on cityID
    api_response = api_instance.get_province_by_city_id(cityID=cityID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProvincesApi->getProvinceByCityID: %s\n" % e)

Parameters

Query parameters
Name Description
cityID
Integer (int32)

Responses

Status: 200 - Province retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the province!


getProvinces

Retrieves the existing provinces

In case of a successful request, the system will return the list of provinces and status code 200


/api/Provinces/GetProvinces

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/Provinces/GetProvinces"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProvincesApi;

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

public class ProvincesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ProvincesApi apiInstance = new ProvincesApi();
        try {
            ProvinceModelArrayQueryDispatchResult result = apiInstance.getProvinces();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvincesApi#getProvinces");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProvincesApi;

public class ProvincesApiExample {

    public static void main(String[] args) {
        ProvincesApi apiInstance = new ProvincesApi();
        try {
            ProvinceModelArrayQueryDispatchResult result = apiInstance.getProvinces();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProvincesApi#getProvinces");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves the existing provinces
[apiInstance getProvincesWithCompletionHandler: 
              ^(ProvinceModelArrayQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ProvincesApi();

            try
            {
                // Retrieves the existing provinces
                ProvinceModelArrayQueryDispatchResult result = apiInstance.getProvinces();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProvincesApi.getProvinces: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiProvincesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ProvincesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ProvincesApi()

try: 
    # Retrieves the existing provinces
    api_response = api_instance.get_provinces()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProvincesApi->getProvinces: %s\n" % e)

Parameters

Responses

Status: 200 - List of provinces retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the provinces list!


Reports

getKPIReportData


/api/Reports/GetKPIReportData

Usage and SDK Samples

curl -X GET\
\
"https://api.ifonline.nl/api/Reports/GetKPIReportData"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ReportsApi apiInstance = new ReportsApi();
        try {
            apiInstance.getKPIReportData();
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getKPIReportData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        try {
            apiInstance.getKPIReportData();
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getKPIReportData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

[apiInstance getKPIReportDataWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReportsApi();

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

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReportsApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReportsApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReportsApi()

try: 
    api_instance.get_kpi_report_data()
except ApiException as e:
    print("Exception when calling ReportsApi->getKPIReportData: %s\n" % e)

Parameters

Responses

Status: 200 - Success


getKPIStatusCounters


/api/Reports/GetKPIStatusCounters

Usage and SDK Samples

curl -X GET\
\
"https://api.ifonline.nl/api/Reports/GetKPIStatusCounters?year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ReportsApi apiInstance = new ReportsApi();
        Integer year = 56; // Integer | 
        try {
            apiInstance.getKPIStatusCounters(year);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getKPIStatusCounters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Integer year = 56; // Integer | 
        try {
            apiInstance.getKPIStatusCounters(year);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getKPIStatusCounters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *year = 56; //  (optional)

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

[apiInstance getKPIStatusCountersWith:year
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ReportsApi()
var opts = { 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getKPIStatusCounters(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReportsApi();
            var year = 56;  // Integer |  (optional) 

            try
            {
                apiInstance.getKPIStatusCounters(year);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.getKPIStatusCounters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReportsApi();
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
year = 56 # Integer |  (optional)

try: 
    api_instance.get_kpi_status_counters(year=year)
except ApiException as e:
    print("Exception when calling ReportsApi->getKPIStatusCounters: %s\n" % e)

Parameters

Query parameters
Name Description
year
Integer (int32)

Responses

Status: 200 - Success


getMeasurementDataStatusCounters


/api/Reports/GetMeasurementDataStatusCounters

Usage and SDK Samples

curl -X GET\
\
"https://api.ifonline.nl/api/Reports/GetMeasurementDataStatusCounters?year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ReportsApi apiInstance = new ReportsApi();
        Integer year = 56; // Integer | 
        try {
            apiInstance.getMeasurementDataStatusCounters(year);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getMeasurementDataStatusCounters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Integer year = 56; // Integer | 
        try {
            apiInstance.getMeasurementDataStatusCounters(year);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getMeasurementDataStatusCounters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *year = 56; //  (optional)

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

[apiInstance getMeasurementDataStatusCountersWith:year
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ReportsApi()
var opts = { 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getMeasurementDataStatusCounters(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReportsApi();
            var year = 56;  // Integer |  (optional) 

            try
            {
                apiInstance.getMeasurementDataStatusCounters(year);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.getMeasurementDataStatusCounters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReportsApi();
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
year = 56 # Integer |  (optional)

try: 
    api_instance.get_measurement_data_status_counters(year=year)
except ApiException as e:
    print("Exception when calling ReportsApi->getMeasurementDataStatusCounters: %s\n" % e)

Parameters

Query parameters
Name Description
year
Integer (int32)

Responses

Status: 200 - Success


getPlantListByKPIStatus


/api/Reports/GetPlantListByKIPStatus

Usage and SDK Samples

curl -X GET\
\
"https://api.ifonline.nl/api/Reports/GetPlantListByKIPStatus?kpiStatusCode=&year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ReportsApi apiInstance = new ReportsApi();
        String kpiStatusCode = kpiStatusCode_example; // String | 
        Integer year = 56; // Integer | 
        try {
            apiInstance.getPlantListByKPIStatus(kpiStatusCode, year);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getPlantListByKPIStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        String kpiStatusCode = kpiStatusCode_example; // String | 
        Integer year = 56; // Integer | 
        try {
            apiInstance.getPlantListByKPIStatus(kpiStatusCode, year);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getPlantListByKPIStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *kpiStatusCode = kpiStatusCode_example; //  (optional)
Integer *year = 56; //  (optional)

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

[apiInstance getPlantListByKPIStatusWith:kpiStatusCode
    year:year
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ReportsApi()
var opts = { 
  'kpiStatusCode': kpiStatusCode_example, // {{String}} 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getPlantListByKPIStatus(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReportsApi();
            var kpiStatusCode = kpiStatusCode_example;  // String |  (optional) 
            var year = 56;  // Integer |  (optional) 

            try
            {
                apiInstance.getPlantListByKPIStatus(kpiStatusCode, year);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.getPlantListByKPIStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReportsApi();
$kpiStatusCode = kpiStatusCode_example; // String | 
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $kpiStatusCode = kpiStatusCode_example; # String | 
my $year = 56; # Integer | 

eval { 
    $api_instance->getPlantListByKPIStatus(kpiStatusCode => $kpiStatusCode, year => $year);
};
if ($@) {
    warn "Exception when calling ReportsApi->getPlantListByKPIStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
kpiStatusCode = kpiStatusCode_example # String |  (optional)
year = 56 # Integer |  (optional)

try: 
    api_instance.get_plant_list_by_kpi_status(kpiStatusCode=kpiStatusCode, year=year)
except ApiException as e:
    print("Exception when calling ReportsApi->getPlantListByKPIStatus: %s\n" % e)

Parameters

Query parameters
Name Description
kpiStatusCode
String
year
Integer (int32)

Responses

Status: 200 - Success


getPlantListByMeasurementDataStatus


/api/Reports/GetPlantListByMeasurementDataStatus

Usage and SDK Samples

curl -X GET\
\
"https://api.ifonline.nl/api/Reports/GetPlantListByMeasurementDataStatus?measurementStatusCode=&year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ReportsApi apiInstance = new ReportsApi();
        String measurementStatusCode = measurementStatusCode_example; // String | 
        Integer year = 56; // Integer | 
        try {
            apiInstance.getPlantListByMeasurementDataStatus(measurementStatusCode, year);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getPlantListByMeasurementDataStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        String measurementStatusCode = measurementStatusCode_example; // String | 
        Integer year = 56; // Integer | 
        try {
            apiInstance.getPlantListByMeasurementDataStatus(measurementStatusCode, year);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getPlantListByMeasurementDataStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *measurementStatusCode = measurementStatusCode_example; //  (optional)
Integer *year = 56; //  (optional)

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

[apiInstance getPlantListByMeasurementDataStatusWith:measurementStatusCode
    year:year
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ReportsApi()
var opts = { 
  'measurementStatusCode': measurementStatusCode_example, // {{String}} 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getPlantListByMeasurementDataStatus(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReportsApi();
            var measurementStatusCode = measurementStatusCode_example;  // String |  (optional) 
            var year = 56;  // Integer |  (optional) 

            try
            {
                apiInstance.getPlantListByMeasurementDataStatus(measurementStatusCode, year);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.getPlantListByMeasurementDataStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReportsApi();
$measurementStatusCode = measurementStatusCode_example; // String | 
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $measurementStatusCode = measurementStatusCode_example; # String | 
my $year = 56; # Integer | 

eval { 
    $api_instance->getPlantListByMeasurementDataStatus(measurementStatusCode => $measurementStatusCode, year => $year);
};
if ($@) {
    warn "Exception when calling ReportsApi->getPlantListByMeasurementDataStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
measurementStatusCode = measurementStatusCode_example # String |  (optional)
year = 56 # Integer |  (optional)

try: 
    api_instance.get_plant_list_by_measurement_data_status(measurementStatusCode=measurementStatusCode, year=year)
except ApiException as e:
    print("Exception when calling ReportsApi->getPlantListByMeasurementDataStatus: %s\n" % e)

Parameters

Query parameters
Name Description
measurementStatusCode
String
year
Integer (int32)

Responses

Status: 200 - Success


getPolicies


/api/Reports/GetPolicies

Usage and SDK Samples

curl -X GET\
\
"https://api.ifonline.nl/api/Reports/GetPolicies?year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ReportsApi apiInstance = new ReportsApi();
        Integer year = 56; // Integer | 
        try {
            apiInstance.getPolicies(year);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getPolicies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Integer year = 56; // Integer | 
        try {
            apiInstance.getPolicies(year);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getPolicies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *year = 56; //  (optional)

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

[apiInstance getPoliciesWith:year
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ReportsApi()
var opts = { 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getPolicies(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReportsApi();
            var year = 56;  // Integer |  (optional) 

            try
            {
                apiInstance.getPolicies(year);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.getPolicies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReportsApi();
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
year = 56 # Integer |  (optional)

try: 
    api_instance.get_policies(year=year)
except ApiException as e:
    print("Exception when calling ReportsApi->getPolicies: %s\n" % e)

Parameters

Query parameters
Name Description
year
Integer (int32)

Responses

Status: 200 - Success


getYearlyKPIStatusCounters


/api/Reports/GetYearlyKPIStatusCounters

Usage and SDK Samples

curl -X GET\
\
"https://api.ifonline.nl/api/Reports/GetYearlyKPIStatusCounters?year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        ReportsApi apiInstance = new ReportsApi();
        Integer year = 56; // Integer | 
        try {
            apiInstance.getYearlyKPIStatusCounters(year);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getYearlyKPIStatusCounters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Integer year = 56; // Integer | 
        try {
            apiInstance.getYearlyKPIStatusCounters(year);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getYearlyKPIStatusCounters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *year = 56; //  (optional)

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

[apiInstance getYearlyKPIStatusCountersWith:year
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new IfTechnologyApi.ReportsApi()
var opts = { 
  'year': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getYearlyKPIStatusCounters(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new ReportsApi();
            var year = 56;  // Integer |  (optional) 

            try
            {
                apiInstance.getYearlyKPIStatusCounters(year);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.getYearlyKPIStatusCounters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiReportsApi();
$year = 56; // Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $year = 56; # Integer | 

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
year = 56 # Integer |  (optional)

try: 
    api_instance.get_yearly_kpi_status_counters(year=year)
except ApiException as e:
    print("Exception when calling ReportsApi->getYearlyKPIStatusCounters: %s\n" % e)

Parameters

Query parameters
Name Description
year
Integer (int32)

Responses

Status: 200 - Success


WellStatuses

getWellStatuses

Retrieves a list of well statuses

In case of a successful request, the system will return the existing well statuses and status code 200.


/api/WellStatuses/GetWellStatuses

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/WellStatuses/GetWellStatuses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WellStatusesApi;

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

public class WellStatusesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        WellStatusesApi apiInstance = new WellStatusesApi();
        try {
            LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getWellStatuses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WellStatusesApi#getWellStatuses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WellStatusesApi;

public class WellStatusesApiExample {

    public static void main(String[] args) {
        WellStatusesApi apiInstance = new WellStatusesApi();
        try {
            LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getWellStatuses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WellStatusesApi#getWellStatuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of well statuses
[apiInstance getWellStatusesWithCompletionHandler: 
              ^(LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WellStatusesApi();

            try
            {
                // Retrieves a list of well statuses
                LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getWellStatuses();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WellStatusesApi.getWellStatuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiWellStatusesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WellStatusesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WellStatusesApi()

try: 
    # Retrieves a list of well statuses
    api_response = api_instance.get_well_statuses()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WellStatusesApi->getWellStatuses: %s\n" % e)

Parameters

Responses

Status: 200 - Well statuses retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the well statuses list!


WellTypes

getWellTypes

Retrieves a list of well types

In case of a successful request, the system will return the existing well types and status code 200.


/api/WellTypes/GetWellTypes

Usage and SDK Samples

curl -X GET\
\
-H "Accept: application/json"\
"https://api.ifonline.nl/api/WellTypes/GetWellTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WellTypesApi;

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

public class WellTypesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        WellTypesApi apiInstance = new WellTypesApi();
        try {
            LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getWellTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WellTypesApi#getWellTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WellTypesApi;

public class WellTypesApiExample {

    public static void main(String[] args) {
        WellTypesApi apiInstance = new WellTypesApi();
        try {
            LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getWellTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WellTypesApi#getWellTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Retrieves a list of well types
[apiInstance getWellTypesWithCompletionHandler: 
              ^(LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var IfTechnologyApi = require('if_technology_api');
var defaultClient = IfTechnologyApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

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

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

            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WellTypesApi();

            try
            {
                // Retrieves a list of well types
                LookupWithOwnerModelApplicationFilteredQueryResultQueryDispatchResult result = apiInstance.getWellTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WellTypesApi.getWellTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiWellTypesApi();

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

# Configure OAuth2 access token for authorization: oauth2
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WellTypesApi->new();

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

# Configure OAuth2 access token for authorization: oauth2
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WellTypesApi()

try: 
    # Retrieves a list of well types
    api_response = api_instance.get_well_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WellTypesApi->getWellTypes: %s\n" % e)

Parameters

Responses

Status: 200 - Well types retrieved

Status: 401 - Unauthorized request

Status: 500 - An error occurred. Cannot retrieve the well types list!