LTZF API

Authentifizierung

authDelete

Key adder interface for removing API keys from the system. Allows administrators and key management services to revoke access by deleting an existing API key.


/api/v2/auth

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/auth"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthentifizierungApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthentifizierungApi apiInstance = new AuthentifizierungApi();
        String apiKeyDelete = apiKeyDelete_example; // String | The API key to be deleted from the system. Must be provided as keytag.

        try {
            apiInstance.authDelete(apiKeyDelete);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthentifizierungApi#authDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String apiKeyDelete = new String(); // String | The API key to be deleted from the system. Must be provided as keytag.

try {
    final result = await api_instance.authDelete(apiKeyDelete);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->authDelete: $e\n');
}

import org.openapitools.client.api.AuthentifizierungApi;

public class AuthentifizierungApiExample {
    public static void main(String[] args) {
        AuthentifizierungApi apiInstance = new AuthentifizierungApi();
        String apiKeyDelete = apiKeyDelete_example; // String | The API key to be deleted from the system. Must be provided as keytag.

        try {
            apiInstance.authDelete(apiKeyDelete);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthentifizierungApi#authDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
AuthentifizierungApi *apiInstance = [[AuthentifizierungApi alloc] init];
String *apiKeyDelete = apiKeyDelete_example; // The API key to be deleted from the system. Must be provided as keytag. (default to null)

[apiInstance authDeleteWith:apiKeyDelete
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.AuthentifizierungApi()
var apiKeyDelete = apiKeyDelete_example; // {String} The API key to be deleted from the system. Must be provided as keytag.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.authDelete(apiKeyDelete, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class authDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new AuthentifizierungApi();
            var apiKeyDelete = apiKeyDelete_example;  // String | The API key to be deleted from the system. Must be provided as keytag. (default to null)

            try {
                apiInstance.authDelete(apiKeyDelete);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthentifizierungApi.authDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthentifizierungApi();
$apiKeyDelete = apiKeyDelete_example; // String | The API key to be deleted from the system. Must be provided as keytag.

try {
    $api_instance->authDelete($apiKeyDelete);
} catch (Exception $e) {
    echo 'Exception when calling AuthentifizierungApi->authDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthentifizierungApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthentifizierungApi->new();
my $apiKeyDelete = apiKeyDelete_example; # String | The API key to be deleted from the system. Must be provided as keytag.

eval {
    $api_instance->authDelete(apiKeyDelete => $apiKeyDelete);
};
if ($@) {
    warn "Exception when calling AuthentifizierungApi->authDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthentifizierungApi()
apiKeyDelete = apiKeyDelete_example # String | The API key to be deleted from the system. Must be provided as keytag. (default to null)

try:
    api_instance.auth_delete(apiKeyDelete)
except ApiException as e:
    print("Exception when calling AuthentifizierungApi->authDelete: %s\n" % e)
extern crate AuthentifizierungApi;

pub fn main() {
    let apiKeyDelete = apiKeyDelete_example; // String

    let mut context = AuthentifizierungApi::Context::default();
    let result = client.authDelete(apiKeyDelete, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
api-key-delete*
String
The API key to be deleted from the system. Must be provided as keytag.
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

authListing

Retrieve a list of Keys that are currently in Use


/api/v2/auth/keys

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "http://localhost/api/v2/auth/keys?since=2024-01-01T00:00Z&until=2024-12-31T23:59:59Z&page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthentifizierungApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthentifizierungApi apiInstance = new AuthentifizierungApi();
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array['String'] result = apiInstance.authListing(since, until, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthentifizierungApi#authListing");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Date since = new Date(); // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
final Date until = new Date(); // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.authListing(since, until, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->authListing: $e\n');
}

import org.openapitools.client.api.AuthentifizierungApi;

public class AuthentifizierungApiExample {
    public static void main(String[] args) {
        AuthentifizierungApi apiInstance = new AuthentifizierungApi();
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array['String'] result = apiInstance.authListing(since, until, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthentifizierungApi#authListing");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
AuthentifizierungApi *apiInstance = [[AuthentifizierungApi alloc] init];
Date *since = 2024-01-01T00:00Z; // Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
Date *until = 2024-12-31T23:59:59Z; // Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance authListingWith:since
    until:until
    page:page
    perPage:perPage
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.AuthentifizierungApi()
var opts = {
  'since': 2024-01-01T00:00Z, // {Date} Filter results to include only items updated on or after this timestamp (inclusive lower bound)
  'until': 2024-12-31T23:59:59Z, // {Date} Filter results to include only items updated on or before this timestamp (inclusive upper bound)
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

namespace Example
{
    public class authListingExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new AuthentifizierungApi();
            var since = 2024-01-01T00:00Z;  // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional)  (default to null)
            var until = 2024-12-31T23:59:59Z;  // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array['String'] result = apiInstance.authListing(since, until, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthentifizierungApi.authListing: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthentifizierungApi();
$since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
$until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->authListing($since, $until, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthentifizierungApi->authListing: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthentifizierungApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthentifizierungApi->new();
my $since = 2024-01-01T00:00Z; # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
my $until = 2024-12-31T23:59:59Z; # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->authListing(since => $since, until => $until, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthentifizierungApi->authListing: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthentifizierungApi()
since = 2024-01-01T00:00Z # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
until = 2024-12-31T23:59:59Z # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.auth_listing(since=since, until=until, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthentifizierungApi->authListing: %s\n" % e)
extern crate AuthentifizierungApi;

pub fn main() {
    let since = 2024-01-01T00:00Z; // Date
    let until = 2024-12-31T23:59:59Z; // Date
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = AuthentifizierungApi::Context::default();
    let result = client.authListing(since, until, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
since
Date (date-time)
Filter results to include only items updated on or after this timestamp (inclusive lower bound)
until
Date (date-time)
Filter results to include only items updated on or before this timestamp (inclusive upper bound)
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

authListingKeytag

Retrieve a detailed overview of the objects changed by this key


/api/v2/auth/keys/{keytag}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "http://localhost/api/v2/auth/keys/{keytag}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthentifizierungApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthentifizierungApi apiInstance = new AuthentifizierungApi();
        String keytag = keytag_example; // String | 

        try {
            auth_listing_keytag_200_response result = apiInstance.authListingKeytag(keytag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthentifizierungApi#authListingKeytag");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String keytag = new String(); // String | 

try {
    final result = await api_instance.authListingKeytag(keytag);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->authListingKeytag: $e\n');
}

import org.openapitools.client.api.AuthentifizierungApi;

public class AuthentifizierungApiExample {
    public static void main(String[] args) {
        AuthentifizierungApi apiInstance = new AuthentifizierungApi();
        String keytag = keytag_example; // String | 

        try {
            auth_listing_keytag_200_response result = apiInstance.authListingKeytag(keytag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthentifizierungApi#authListingKeytag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
AuthentifizierungApi *apiInstance = [[AuthentifizierungApi alloc] init];
String *keytag = keytag_example; //  (default to null)

[apiInstance authListingKeytagWith:keytag
              completionHandler: ^(auth_listing_keytag_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.AuthentifizierungApi()
var keytag = keytag_example; // {String} 

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

namespace Example
{
    public class authListingKeytagExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new AuthentifizierungApi();
            var keytag = keytag_example;  // String |  (default to null)

            try {
                auth_listing_keytag_200_response result = apiInstance.authListingKeytag(keytag);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthentifizierungApi.authListingKeytag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthentifizierungApi();
$keytag = keytag_example; // String | 

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

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthentifizierungApi->new();
my $keytag = keytag_example; # String | 

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

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthentifizierungApi()
keytag = keytag_example # String |  (default to null)

try:
    api_response = api_instance.auth_listing_keytag(keytag)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthentifizierungApi->authListingKeytag: %s\n" % e)
extern crate AuthentifizierungApi;

pub fn main() {
    let keytag = keytag_example; // String

    let mut context = AuthentifizierungApi::Context::default();
    let result = client.authListingKeytag(keytag, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
keytag*
String
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

authPost

Key adder interface for creating new API keys. Allows administrators to generate new access keys for collectors, administrative tools, or other key adders.


/api/v2/auth

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: text/plain" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/auth" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthentifizierungApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthentifizierungApi apiInstance = new AuthentifizierungApi();
        CreateApiKey createApiKey = ; // CreateApiKey | 

        try {
            'String' result = apiInstance.authPost(createApiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthentifizierungApi#authPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CreateApiKey createApiKey = new CreateApiKey(); // CreateApiKey | 

try {
    final result = await api_instance.authPost(createApiKey);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->authPost: $e\n');
}

import org.openapitools.client.api.AuthentifizierungApi;

public class AuthentifizierungApiExample {
    public static void main(String[] args) {
        AuthentifizierungApi apiInstance = new AuthentifizierungApi();
        CreateApiKey createApiKey = ; // CreateApiKey | 

        try {
            'String' result = apiInstance.authPost(createApiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthentifizierungApi#authPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
AuthentifizierungApi *apiInstance = [[AuthentifizierungApi alloc] init];
CreateApiKey *createApiKey = ; // 

[apiInstance authPostWith:createApiKey
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.AuthentifizierungApi()
var createApiKey = ; // {CreateApiKey} 

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

namespace Example
{
    public class authPostExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new AuthentifizierungApi();
            var createApiKey = new CreateApiKey(); // CreateApiKey | 

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

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthentifizierungApi();
$createApiKey = ; // CreateApiKey | 

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

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthentifizierungApi->new();
my $createApiKey = WWW::OPenAPIClient::Object::CreateApiKey->new(); # CreateApiKey | 

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

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthentifizierungApi()
createApiKey =  # CreateApiKey | 

try:
    api_response = api_instance.auth_post(createApiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthentifizierungApi->authPost: %s\n" % e)
extern crate AuthentifizierungApi;

pub fn main() {
    let createApiKey = ; // CreateApiKey

    let mut context = AuthentifizierungApi::Context::default();
    let result = client.authPost(createApiKey, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
createApiKey *

Details about the new API key to be created, including its scope and optional expiration date

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

authRotate

Key rotation endpoint for creating a new API key while maintaining the existing one for a transition period of one day. The old key remains valid until the specified rotation_complete_date, after which it is automatically revoked. Rotates only the own key if it is not invalid.


/api/v2/auth/rotate

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "http://localhost/api/v2/auth/rotate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthentifizierungApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthentifizierungApi apiInstance = new AuthentifizierungApi();

        try {
            rotation_response result = apiInstance.authRotate();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthentifizierungApi#authRotate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.authRotate();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->authRotate: $e\n');
}

import org.openapitools.client.api.AuthentifizierungApi;

public class AuthentifizierungApiExample {
    public static void main(String[] args) {
        AuthentifizierungApi apiInstance = new AuthentifizierungApi();

        try {
            rotation_response result = apiInstance.authRotate();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthentifizierungApi#authRotate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
AuthentifizierungApi *apiInstance = [[AuthentifizierungApi alloc] init];

[apiInstance authRotateWithCompletionHandler: 
              ^(rotation_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.AuthentifizierungApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authRotate(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class authRotateExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new AuthentifizierungApi();

            try {
                rotation_response result = apiInstance.authRotate();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthentifizierungApi.authRotate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthentifizierungApi();

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

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthentifizierungApi->new();

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

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthentifizierungApi()

try:
    api_response = api_instance.auth_rotate()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthentifizierungApi->authRotate: %s\n" % e)
extern crate AuthentifizierungApi;

pub fn main() {

    let mut context = AuthentifizierungApi::Context::default();
    let result = client.authRotate(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

authStatus

Retrieves information about the currently used API key including expiration date, rotation status, and key health.


/api/v2/auth/status

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "http://localhost/api/v2/auth/status"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthentifizierungApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthentifizierungApi apiInstance = new AuthentifizierungApi();

        try {
            api_key_status result = apiInstance.authStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthentifizierungApi#authStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.authStatus();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->authStatus: $e\n');
}

import org.openapitools.client.api.AuthentifizierungApi;

public class AuthentifizierungApiExample {
    public static void main(String[] args) {
        AuthentifizierungApi apiInstance = new AuthentifizierungApi();

        try {
            api_key_status result = apiInstance.authStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthentifizierungApi#authStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
AuthentifizierungApi *apiInstance = [[AuthentifizierungApi alloc] init];

[apiInstance authStatusWithCompletionHandler: 
              ^(api_key_status output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.AuthentifizierungApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authStatus(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class authStatusExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new AuthentifizierungApi();

            try {
                api_key_status result = apiInstance.authStatus();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthentifizierungApi.authStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthentifizierungApi();

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

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthentifizierungApi->new();

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

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthentifizierungApi()

try:
    api_response = api_instance.auth_status()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthentifizierungApi->authStatus: %s\n" % e)
extern crate AuthentifizierungApi;

pub fn main() {

    let mut context = AuthentifizierungApi::Context::default();
    let result = client.authStatus(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


CollectorSchnittstellen

kalDatePut

Collector interface for adding or updating sessions for a specific date and parliament. Completely replaces all sessions for the given date, with restrictions based on how far in the past the date is. Admin API keys can override the time restriction.


/api/v2/kalender/{parlament}/{datum}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/kalender/{parlament}/{datum}" \
 -d '{
  "api_id" : "b1a2c3d4-e5f6-7890-fedc-1234567890ab",
  "titel" : "143. Sitzung des Deutschen Bundestages",
  "termin" : "2024-05-20T09:00:00+02:00",
  "gremium" : {
    "parlament" : "BT",
    "wahlperiode" : 20,
    "name" : "plenum"
  },
  "nummer" : 143,
  "public" : true,
  "link" : "https://www.bundestag.de/sitzung/20240520",
  "tops" : [ {
    "nummer" : 1,
    "titel" : "Eröffnung der Sitzung"
  }, {
    "nummer" : 3,
    "titel" : "Erste Beratung des von den Fraktionen SPD, BÜNDNIS 90/DIE GRÜNEN und FDP eingebrachten Entwurfs eines Gesetzes zur Änderung des Bundeswahlgesetzes",
    "vorgang_id" : [ "123e4567-e89b-12d3-a456-426614174000" ],
    "dokumente" : [ ]
  } ],
  "dokumente" : [ {
    "api_id" : "c1d2e3f4-a5b6-7890-cdef-1234567890gh",
    "typ" : "tops",
    "titel" : "Tagesordnung der 143. Sitzung des Deutschen Bundestages",
    "volltext" : "TOP 1: Eröffnung der Sitzung\nTOP 2: Fragestunde\nTOP 3: Erste Beratung des Gesetzentwurfs zur Änderung des Bundeswahlgesetzes\n...",
    "hash" : "a1b2c3d4e5f6g7h8i9j0",
    "zp_modifiziert" : "2024-05-15T14:30:00+02:00",
    "zp_referenz" : "2024-05-20T09:00:00+02:00",
    "link" : "https://www.bundestag.de/tagesordnung/20240520",
    "autoren" : [ {
      "organisation" : "Deutscher Bundestag"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectorSchnittstellenApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CollectorSchnittstellenApi apiInstance = new CollectorSchnittstellenApi();
        UUID xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
        Parlament parlament = ; // Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
        date datum = 2013-10-20; // date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
        array[sitzung] sitzung = ; // array[sitzung] | 

        try {
            apiInstance.kalDatePut(xScraperId, parlament, datum, sitzung);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorSchnittstellenApi#kalDatePut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID xScraperId = new UUID(); // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
final Parlament parlament = new Parlament(); // Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
final date datum = new date(); // date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
final array[sitzung] sitzung = new array[sitzung](); // array[sitzung] | 

try {
    final result = await api_instance.kalDatePut(xScraperId, parlament, datum, sitzung);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->kalDatePut: $e\n');
}

import org.openapitools.client.api.CollectorSchnittstellenApi;

public class CollectorSchnittstellenApiExample {
    public static void main(String[] args) {
        CollectorSchnittstellenApi apiInstance = new CollectorSchnittstellenApi();
        UUID xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
        Parlament parlament = ; // Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
        date datum = 2013-10-20; // date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
        array[sitzung] sitzung = ; // array[sitzung] | 

        try {
            apiInstance.kalDatePut(xScraperId, parlament, datum, sitzung);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorSchnittstellenApi#kalDatePut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
CollectorSchnittstellenApi *apiInstance = [[CollectorSchnittstellenApi alloc] init];
UUID *xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The Scraper ID to use for the request. Used to identify the scraper that submitted the request. (default to null)
Parlament *parlament = ; // Code of the parliament to add sessions for (e.g., 'BT' for Bundestag) (default to null)
date *datum = 2013-10-20; // Date to add sessions for, in ISO 8601 format (YYYY-MM-DD) (default to null)
array[sitzung] *sitzung = ; // 

[apiInstance kalDatePutWith:xScraperId
    parlament:parlament
    datum:datum
    sitzung:sitzung
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.CollectorSchnittstellenApi()
var xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
var parlament = ; // {Parlament} Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
var datum = 2013-10-20; // {date} Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
var sitzung = ; // {array[sitzung]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.kalDatePut(xScraperId, parlament, datum, sitzung, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class kalDatePutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CollectorSchnittstellenApi();
            var xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request. (default to null)
            var parlament = new Parlament(); // Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag) (default to null)
            var datum = 2013-10-20;  // date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD) (default to null)
            var sitzung = new array[sitzung](); // array[sitzung] | 

            try {
                apiInstance.kalDatePut(xScraperId, parlament, datum, sitzung);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectorSchnittstellenApi.kalDatePut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectorSchnittstellenApi();
$xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
$parlament = ; // Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
$datum = 2013-10-20; // date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
$sitzung = ; // array[sitzung] | 

try {
    $api_instance->kalDatePut($xScraperId, $parlament, $datum, $sitzung);
} catch (Exception $e) {
    echo 'Exception when calling CollectorSchnittstellenApi->kalDatePut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectorSchnittstellenApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectorSchnittstellenApi->new();
my $xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
my $parlament = ; # Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
my $datum = 2013-10-20; # date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
my $sitzung = [WWW::OPenAPIClient::Object::array[sitzung]->new()]; # array[sitzung] | 

eval {
    $api_instance->kalDatePut(xScraperId => $xScraperId, parlament => $parlament, datum => $datum, sitzung => $sitzung);
};
if ($@) {
    warn "Exception when calling CollectorSchnittstellenApi->kalDatePut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CollectorSchnittstellenApi()
xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request. (default to null)
parlament =  # Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag) (default to null)
datum = 2013-10-20 # date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD) (default to null)
sitzung =  # array[sitzung] | 

try:
    api_instance.kal_date_put(xScraperId, parlament, datum, sitzung)
except ApiException as e:
    print("Exception when calling CollectorSchnittstellenApi->kalDatePut: %s\n" % e)
extern crate CollectorSchnittstellenApi;

pub fn main() {
    let xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let parlament = ; // Parlament
    let datum = 2013-10-20; // date
    let sitzung = ; // array[sitzung]

    let mut context = CollectorSchnittstellenApi::Context::default();
    let result = client.kalDatePut(xScraperId, parlament, datum, sitzung, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
parlament*
Parlament
Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
Required
datum*
date (date)
Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
Required
Header parameters
Name Description
X-Scraper-Id*
UUID (uuid)
The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
Required
Body parameters
Name Description
sitzung *

Array of parliamentary sessions to set for the specified date

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

vorgangPut

Collector interface for inserting a new legislative process. Processes are automatically deduplicated against existing data and merged if necessary. Used by data collection services to add new legislative processes to the system.


/api/v2/vorgang

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/vorgang" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectorSchnittstellenApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CollectorSchnittstellenApi apiInstance = new CollectorSchnittstellenApi();
        UUID xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
        Vorgang vorgang = ; // Vorgang | 

        try {
            apiInstance.vorgangPut(xScraperId, vorgang);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorSchnittstellenApi#vorgangPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID xScraperId = new UUID(); // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
final Vorgang vorgang = new Vorgang(); // Vorgang | 

try {
    final result = await api_instance.vorgangPut(xScraperId, vorgang);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->vorgangPut: $e\n');
}

import org.openapitools.client.api.CollectorSchnittstellenApi;

public class CollectorSchnittstellenApiExample {
    public static void main(String[] args) {
        CollectorSchnittstellenApi apiInstance = new CollectorSchnittstellenApi();
        UUID xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
        Vorgang vorgang = ; // Vorgang | 

        try {
            apiInstance.vorgangPut(xScraperId, vorgang);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorSchnittstellenApi#vorgangPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
CollectorSchnittstellenApi *apiInstance = [[CollectorSchnittstellenApi alloc] init];
UUID *xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The Scraper ID to use for the request. Used to identify the scraper that submitted the request. (default to null)
Vorgang *vorgang = ; // 

[apiInstance vorgangPutWith:xScraperId
    vorgang:vorgang
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.CollectorSchnittstellenApi()
var xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
var vorgang = ; // {Vorgang} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.vorgangPut(xScraperId, vorgang, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class vorgangPutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CollectorSchnittstellenApi();
            var xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request. (default to null)
            var vorgang = new Vorgang(); // Vorgang | 

            try {
                apiInstance.vorgangPut(xScraperId, vorgang);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectorSchnittstellenApi.vorgangPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectorSchnittstellenApi();
$xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
$vorgang = ; // Vorgang | 

try {
    $api_instance->vorgangPut($xScraperId, $vorgang);
} catch (Exception $e) {
    echo 'Exception when calling CollectorSchnittstellenApi->vorgangPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CollectorSchnittstellenApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectorSchnittstellenApi->new();
my $xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
my $vorgang = WWW::OPenAPIClient::Object::Vorgang->new(); # Vorgang | 

eval {
    $api_instance->vorgangPut(xScraperId => $xScraperId, vorgang => $vorgang);
};
if ($@) {
    warn "Exception when calling CollectorSchnittstellenApi->vorgangPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CollectorSchnittstellenApi()
xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request. (default to null)
vorgang =  # Vorgang | 

try:
    api_instance.vorgang_put(xScraperId, vorgang)
except ApiException as e:
    print("Exception when calling CollectorSchnittstellenApi->vorgangPut: %s\n" % e)
extern crate CollectorSchnittstellenApi;

pub fn main() {
    let xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let vorgang = ; // Vorgang

    let mut context = CollectorSchnittstellenApi::Context::default();
    let result = client.vorgangPut(xScraperId, vorgang, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
X-Scraper-Id*
UUID (uuid)
The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
Required
Body parameters
Name Description
vorgang *

Complete representation of the legislative process to insert

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

DataAdministration

autorenDeleteByParam

Administrative endpoint to delete authors matching the specified criteria. Removes all authors that match the filter parameters.


/api/v2/autoren

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/autoren?person=person_example&fach=fach_example&org=org_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataAdministrationApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        String person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
        String fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
        String org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.

        try {
            apiInstance.autorenDeleteByParam(person, fach, org);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#autorenDeleteByParam");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String person = new String(); // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
final String fach = new String(); // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
final String org = new String(); // String | Filter by author organization. Returns items where an author belongs to the specified organization.

try {
    final result = await api_instance.autorenDeleteByParam(person, fach, org);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->autorenDeleteByParam: $e\n');
}

import org.openapitools.client.api.DataAdministrationApi;

public class DataAdministrationApiExample {
    public static void main(String[] args) {
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        String person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
        String fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
        String org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.

        try {
            apiInstance.autorenDeleteByParam(person, fach, org);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#autorenDeleteByParam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DataAdministrationApi *apiInstance = [[DataAdministrationApi alloc] init];
String *person = person_example; // Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional) (default to null)
String *fach = fach_example; // Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional) (default to null)
String *org = org_example; // Filter by author organization. Returns items where an author belongs to the specified organization. (optional) (default to null)

[apiInstance autorenDeleteByParamWith:person
    fach:fach
    org:org
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.DataAdministrationApi()
var opts = {
  'person': person_example, // {String} Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
  'fach': fach_example, // {String} Filter by author's professional field. Returns items where an author has the specified professional expertise.
  'org': org_example // {String} Filter by author organization. Returns items where an author belongs to the specified organization.
};

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

namespace Example
{
    public class autorenDeleteByParamExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DataAdministrationApi();
            var person = person_example;  // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional)  (default to null)
            var fach = fach_example;  // String | Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional)  (default to null)
            var org = org_example;  // String | Filter by author organization. Returns items where an author belongs to the specified organization. (optional)  (default to null)

            try {
                apiInstance.autorenDeleteByParam(person, fach, org);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataAdministrationApi.autorenDeleteByParam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataAdministrationApi();
$person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
$fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
$org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.

try {
    $api_instance->autorenDeleteByParam($person, $fach, $org);
} catch (Exception $e) {
    echo 'Exception when calling DataAdministrationApi->autorenDeleteByParam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataAdministrationApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataAdministrationApi->new();
my $person = person_example; # String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
my $fach = fach_example; # String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
my $org = org_example; # String | Filter by author organization. Returns items where an author belongs to the specified organization.

eval {
    $api_instance->autorenDeleteByParam(person => $person, fach => $fach, org => $org);
};
if ($@) {
    warn "Exception when calling DataAdministrationApi->autorenDeleteByParam: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DataAdministrationApi()
person = person_example # String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional) (default to null)
fach = fach_example # String | Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional) (default to null)
org = org_example # String | Filter by author organization. Returns items where an author belongs to the specified organization. (optional) (default to null)

try:
    api_instance.autoren_delete_by_param(person=person, fach=fach, org=org)
except ApiException as e:
    print("Exception when calling DataAdministrationApi->autorenDeleteByParam: %s\n" % e)
extern crate DataAdministrationApi;

pub fn main() {
    let person = person_example; // String
    let fach = fach_example; // String
    let org = org_example; // String

    let mut context = DataAdministrationApi::Context::default();
    let result = client.autorenDeleteByParam(person, fach, org, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
person
String
Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
fach
String
Filter by author's professional field. Returns items where an author has the specified professional expertise.
org
String
Filter by author organization. Returns items where an author belongs to the specified organization.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

autorenPut

Administrative endpoint to add or update multiple authors at once. Creates new authors or replaces existing ones based on matching names and organizations.


/api/v2/autoren

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/autoren" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataAdministrationApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        AutorenPutRequest autorenPutRequest = ; // AutorenPutRequest | 

        try {
            apiInstance.autorenPut(autorenPutRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#autorenPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AutorenPutRequest autorenPutRequest = new AutorenPutRequest(); // AutorenPutRequest | 

try {
    final result = await api_instance.autorenPut(autorenPutRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->autorenPut: $e\n');
}

import org.openapitools.client.api.DataAdministrationApi;

public class DataAdministrationApiExample {
    public static void main(String[] args) {
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        AutorenPutRequest autorenPutRequest = ; // AutorenPutRequest | 

        try {
            apiInstance.autorenPut(autorenPutRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#autorenPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DataAdministrationApi *apiInstance = [[DataAdministrationApi alloc] init];
AutorenPutRequest *autorenPutRequest = ; // 

[apiInstance autorenPutWith:autorenPutRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.DataAdministrationApi()
var autorenPutRequest = ; // {AutorenPutRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.autorenPut(autorenPutRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class autorenPutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DataAdministrationApi();
            var autorenPutRequest = new AutorenPutRequest(); // AutorenPutRequest | 

            try {
                apiInstance.autorenPut(autorenPutRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataAdministrationApi.autorenPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataAdministrationApi();
$autorenPutRequest = ; // AutorenPutRequest | 

try {
    $api_instance->autorenPut($autorenPutRequest);
} catch (Exception $e) {
    echo 'Exception when calling DataAdministrationApi->autorenPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataAdministrationApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataAdministrationApi->new();
my $autorenPutRequest = WWW::OPenAPIClient::Object::AutorenPutRequest->new(); # AutorenPutRequest | 

eval {
    $api_instance->autorenPut(autorenPutRequest => $autorenPutRequest);
};
if ($@) {
    warn "Exception when calling DataAdministrationApi->autorenPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DataAdministrationApi()
autorenPutRequest =  # AutorenPutRequest | 

try:
    api_instance.autoren_put(autorenPutRequest)
except ApiException as e:
    print("Exception when calling DataAdministrationApi->autorenPut: %s\n" % e)
extern crate DataAdministrationApi;

pub fn main() {
    let autorenPutRequest = ; // AutorenPutRequest

    let mut context = DataAdministrationApi::Context::default();
    let result = client.autorenPut(autorenPutRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
autorenPutRequest *

Array of authors to create or update

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

dokumentDeleteId

Administrative endpoint to remove a document from the system. This operation cannot be undone and may affect other resources referencing this document.


/api/v2/dokument/{api_id}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/dokument/{api_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataAdministrationApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        UUID apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the document to delete

        try {
            apiInstance.dokumentDeleteId(apiId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#dokumentDeleteId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID apiId = new UUID(); // UUID | Unique identifier (UUID) of the document to delete

try {
    final result = await api_instance.dokumentDeleteId(apiId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dokumentDeleteId: $e\n');
}

import org.openapitools.client.api.DataAdministrationApi;

public class DataAdministrationApiExample {
    public static void main(String[] args) {
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        UUID apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the document to delete

        try {
            apiInstance.dokumentDeleteId(apiId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#dokumentDeleteId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DataAdministrationApi *apiInstance = [[DataAdministrationApi alloc] init];
UUID *apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the document to delete (default to null)

[apiInstance dokumentDeleteIdWith:apiId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.DataAdministrationApi()
var apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the document to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.dokumentDeleteId(apiId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class dokumentDeleteIdExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DataAdministrationApi();
            var apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the document to delete (default to null)

            try {
                apiInstance.dokumentDeleteId(apiId);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataAdministrationApi.dokumentDeleteId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataAdministrationApi();
$apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the document to delete

try {
    $api_instance->dokumentDeleteId($apiId);
} catch (Exception $e) {
    echo 'Exception when calling DataAdministrationApi->dokumentDeleteId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataAdministrationApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataAdministrationApi->new();
my $apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the document to delete

eval {
    $api_instance->dokumentDeleteId(apiId => $apiId);
};
if ($@) {
    warn "Exception when calling DataAdministrationApi->dokumentDeleteId: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DataAdministrationApi()
apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the document to delete (default to null)

try:
    api_instance.dokument_delete_id(apiId)
except ApiException as e:
    print("Exception when calling DataAdministrationApi->dokumentDeleteId: %s\n" % e)
extern crate DataAdministrationApi;

pub fn main() {
    let apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = DataAdministrationApi::Context::default();
    let result = client.dokumentDeleteId(apiId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
api_id*
UUID (uuid)
Unique identifier (UUID) of the document to delete
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

dokumentPutId

Administrative endpoint to upload or update documents for future reference. Creates a new document with the specified ID or replaces an existing one.


/api/v2/dokument/{api_id}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/dokument/{api_id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataAdministrationApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        UUID apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) to assign to the document or of the existing document to update
        Dokument dokument = ; // Dokument | 

        try {
            apiInstance.dokumentPutId(apiId, dokument);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#dokumentPutId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID apiId = new UUID(); // UUID | Unique identifier (UUID) to assign to the document or of the existing document to update
final Dokument dokument = new Dokument(); // Dokument | 

try {
    final result = await api_instance.dokumentPutId(apiId, dokument);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dokumentPutId: $e\n');
}

import org.openapitools.client.api.DataAdministrationApi;

public class DataAdministrationApiExample {
    public static void main(String[] args) {
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        UUID apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) to assign to the document or of the existing document to update
        Dokument dokument = ; // Dokument | 

        try {
            apiInstance.dokumentPutId(apiId, dokument);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#dokumentPutId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DataAdministrationApi *apiInstance = [[DataAdministrationApi alloc] init];
UUID *apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) to assign to the document or of the existing document to update (default to null)
Dokument *dokument = ; // 

[apiInstance dokumentPutIdWith:apiId
    dokument:dokument
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.DataAdministrationApi()
var apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) to assign to the document or of the existing document to update
var dokument = ; // {Dokument} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.dokumentPutId(apiId, dokument, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class dokumentPutIdExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DataAdministrationApi();
            var apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) to assign to the document or of the existing document to update (default to null)
            var dokument = new Dokument(); // Dokument | 

            try {
                apiInstance.dokumentPutId(apiId, dokument);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataAdministrationApi.dokumentPutId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataAdministrationApi();
$apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) to assign to the document or of the existing document to update
$dokument = ; // Dokument | 

try {
    $api_instance->dokumentPutId($apiId, $dokument);
} catch (Exception $e) {
    echo 'Exception when calling DataAdministrationApi->dokumentPutId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataAdministrationApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataAdministrationApi->new();
my $apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) to assign to the document or of the existing document to update
my $dokument = WWW::OPenAPIClient::Object::Dokument->new(); # Dokument | 

eval {
    $api_instance->dokumentPutId(apiId => $apiId, dokument => $dokument);
};
if ($@) {
    warn "Exception when calling DataAdministrationApi->dokumentPutId: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DataAdministrationApi()
apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) to assign to the document or of the existing document to update (default to null)
dokument =  # Dokument | 

try:
    api_instance.dokument_put_id(apiId, dokument)
except ApiException as e:
    print("Exception when calling DataAdministrationApi->dokumentPutId: %s\n" % e)
extern crate DataAdministrationApi;

pub fn main() {
    let apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let dokument = ; // Dokument

    let mut context = DataAdministrationApi::Context::default();
    let result = client.dokumentPutId(apiId, dokument, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
api_id*
UUID (uuid)
Unique identifier (UUID) to assign to the document or of the existing document to update
Required
Body parameters
Name Description
dokument *

Complete representation of the document to create or update

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

enumDelete

Administrative endpoint to remove a specific value from an enumeration type. Performs case-sensitive matching to identify and delete the exact value.


/api/v2/enumeration/{name}/{item}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/enumeration/{name}/{item}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataAdministrationApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        String item = item_example; // String | The exact value to remove from the enumeration (case-sensitive)
        EnumerationNames name = ; // EnumerationNames | Name of the enumeration type to remove a value from

        try {
            apiInstance.enumDelete(item, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#enumDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String item = new String(); // String | The exact value to remove from the enumeration (case-sensitive)
final EnumerationNames name = new EnumerationNames(); // EnumerationNames | Name of the enumeration type to remove a value from

try {
    final result = await api_instance.enumDelete(item, name);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->enumDelete: $e\n');
}

import org.openapitools.client.api.DataAdministrationApi;

public class DataAdministrationApiExample {
    public static void main(String[] args) {
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        String item = item_example; // String | The exact value to remove from the enumeration (case-sensitive)
        EnumerationNames name = ; // EnumerationNames | Name of the enumeration type to remove a value from

        try {
            apiInstance.enumDelete(item, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#enumDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DataAdministrationApi *apiInstance = [[DataAdministrationApi alloc] init];
String *item = item_example; // The exact value to remove from the enumeration (case-sensitive) (default to null)
EnumerationNames *name = ; // Name of the enumeration type to remove a value from (default to null)

[apiInstance enumDeleteWith:item
    name:name
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.DataAdministrationApi()
var item = item_example; // {String} The exact value to remove from the enumeration (case-sensitive)
var name = ; // {EnumerationNames} Name of the enumeration type to remove a value from

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.enumDelete(item, name, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class enumDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DataAdministrationApi();
            var item = item_example;  // String | The exact value to remove from the enumeration (case-sensitive) (default to null)
            var name = new EnumerationNames(); // EnumerationNames | Name of the enumeration type to remove a value from (default to null)

            try {
                apiInstance.enumDelete(item, name);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataAdministrationApi.enumDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataAdministrationApi();
$item = item_example; // String | The exact value to remove from the enumeration (case-sensitive)
$name = ; // EnumerationNames | Name of the enumeration type to remove a value from

try {
    $api_instance->enumDelete($item, $name);
} catch (Exception $e) {
    echo 'Exception when calling DataAdministrationApi->enumDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataAdministrationApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataAdministrationApi->new();
my $item = item_example; # String | The exact value to remove from the enumeration (case-sensitive)
my $name = ; # EnumerationNames | Name of the enumeration type to remove a value from

eval {
    $api_instance->enumDelete(item => $item, name => $name);
};
if ($@) {
    warn "Exception when calling DataAdministrationApi->enumDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DataAdministrationApi()
item = item_example # String | The exact value to remove from the enumeration (case-sensitive) (default to null)
name =  # EnumerationNames | Name of the enumeration type to remove a value from (default to null)

try:
    api_instance.enum_delete(item, name)
except ApiException as e:
    print("Exception when calling DataAdministrationApi->enumDelete: %s\n" % e)
extern crate DataAdministrationApi;

pub fn main() {
    let item = item_example; // String
    let name = ; // EnumerationNames

    let mut context = DataAdministrationApi::Context::default();
    let result = client.enumDelete(item, name, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
item*
String
The exact value to remove from the enumeration (case-sensitive)
Required
name*
EnumerationNames
Name of the enumeration type to remove a value from
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

enumPut

Administrative endpoint to add or update values in a specified enumeration type. Replaces the entire set of values for the enumeration.


/api/v2/enumeration/{name}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/enumeration/{name}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataAdministrationApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        EnumerationNames name = ; // EnumerationNames | Name of the enumeration type to update values for
        EnumPutRequest enumPutRequest = ; // EnumPutRequest | 

        try {
            apiInstance.enumPut(name, enumPutRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#enumPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final EnumerationNames name = new EnumerationNames(); // EnumerationNames | Name of the enumeration type to update values for
final EnumPutRequest enumPutRequest = new EnumPutRequest(); // EnumPutRequest | 

try {
    final result = await api_instance.enumPut(name, enumPutRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->enumPut: $e\n');
}

import org.openapitools.client.api.DataAdministrationApi;

public class DataAdministrationApiExample {
    public static void main(String[] args) {
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        EnumerationNames name = ; // EnumerationNames | Name of the enumeration type to update values for
        EnumPutRequest enumPutRequest = ; // EnumPutRequest | 

        try {
            apiInstance.enumPut(name, enumPutRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#enumPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DataAdministrationApi *apiInstance = [[DataAdministrationApi alloc] init];
EnumerationNames *name = ; // Name of the enumeration type to update values for (default to null)
EnumPutRequest *enumPutRequest = ; // 

[apiInstance enumPutWith:name
    enumPutRequest:enumPutRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.DataAdministrationApi()
var name = ; // {EnumerationNames} Name of the enumeration type to update values for
var enumPutRequest = ; // {EnumPutRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.enumPut(name, enumPutRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class enumPutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DataAdministrationApi();
            var name = new EnumerationNames(); // EnumerationNames | Name of the enumeration type to update values for (default to null)
            var enumPutRequest = new EnumPutRequest(); // EnumPutRequest | 

            try {
                apiInstance.enumPut(name, enumPutRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataAdministrationApi.enumPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataAdministrationApi();
$name = ; // EnumerationNames | Name of the enumeration type to update values for
$enumPutRequest = ; // EnumPutRequest | 

try {
    $api_instance->enumPut($name, $enumPutRequest);
} catch (Exception $e) {
    echo 'Exception when calling DataAdministrationApi->enumPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataAdministrationApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataAdministrationApi->new();
my $name = ; # EnumerationNames | Name of the enumeration type to update values for
my $enumPutRequest = WWW::OPenAPIClient::Object::EnumPutRequest->new(); # EnumPutRequest | 

eval {
    $api_instance->enumPut(name => $name, enumPutRequest => $enumPutRequest);
};
if ($@) {
    warn "Exception when calling DataAdministrationApi->enumPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DataAdministrationApi()
name =  # EnumerationNames | Name of the enumeration type to update values for (default to null)
enumPutRequest =  # EnumPutRequest | 

try:
    api_instance.enum_put(name, enumPutRequest)
except ApiException as e:
    print("Exception when calling DataAdministrationApi->enumPut: %s\n" % e)
extern crate DataAdministrationApi;

pub fn main() {
    let name = ; // EnumerationNames
    let enumPutRequest = ; // EnumPutRequest

    let mut context = DataAdministrationApi::Context::default();
    let result = client.enumPut(name, enumPutRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
EnumerationNames
Name of the enumeration type to update values for
Required
Body parameters
Name Description
enumPutRequest *

Array of string values to set for the enumeration type

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

gremienDeleteByParam

Administrative endpoint to delete committees matching the specified criteria. Removes all committees that match the filter parameters.


/api/v2/gremien

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/gremien?gr=gr_example&p=&wp=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataAdministrationApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.

        try {
            apiInstance.gremienDeleteByParam(gr, p, wp);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#gremienDeleteByParam");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String gr = new String(); // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
final Parlament p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
final Integer wp = new Integer(); // Integer | Filter by electoral period number. Returns only items from the specified electoral period.

try {
    final result = await api_instance.gremienDeleteByParam(gr, p, wp);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->gremienDeleteByParam: $e\n');
}

import org.openapitools.client.api.DataAdministrationApi;

public class DataAdministrationApiExample {
    public static void main(String[] args) {
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.

        try {
            apiInstance.gremienDeleteByParam(gr, p, wp);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#gremienDeleteByParam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DataAdministrationApi *apiInstance = [[DataAdministrationApi alloc] init];
String *gr = gr_example; // Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
Parlament *p = ; // Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
Integer *wp = 56; // Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)

[apiInstance gremienDeleteByParamWith:gr
    p:p
    wp:wp
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.DataAdministrationApi()
var opts = {
  'gr': gr_example, // {String} Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
  'p': , // {Parlament} Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
  'wp': 56 // {Integer} Filter by electoral period number. Returns only items from the specified electoral period.
};

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

namespace Example
{
    public class gremienDeleteByParamExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DataAdministrationApi();
            var gr = gr_example;  // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional)  (default to null)
            var p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional)  (default to null)
            var wp = 56;  // Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional)  (default to null)

            try {
                apiInstance.gremienDeleteByParam(gr, p, wp);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataAdministrationApi.gremienDeleteByParam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataAdministrationApi();
$gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
$p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
$wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.

try {
    $api_instance->gremienDeleteByParam($gr, $p, $wp);
} catch (Exception $e) {
    echo 'Exception when calling DataAdministrationApi->gremienDeleteByParam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataAdministrationApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataAdministrationApi->new();
my $gr = gr_example; # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
my $p = ; # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
my $wp = 56; # Integer | Filter by electoral period number. Returns only items from the specified electoral period.

eval {
    $api_instance->gremienDeleteByParam(gr => $gr, p => $p, wp => $wp);
};
if ($@) {
    warn "Exception when calling DataAdministrationApi->gremienDeleteByParam: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DataAdministrationApi()
gr = gr_example # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
p =  # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
wp = 56 # Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)

try:
    api_instance.gremien_delete_by_param(gr=gr, p=p, wp=wp)
except ApiException as e:
    print("Exception when calling DataAdministrationApi->gremienDeleteByParam: %s\n" % e)
extern crate DataAdministrationApi;

pub fn main() {
    let gr = gr_example; // String
    let p = ; // Parlament
    let wp = 56; // Integer

    let mut context = DataAdministrationApi::Context::default();
    let result = client.gremienDeleteByParam(gr, p, wp, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
gr
String
Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
p
Parlament
Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
wp
Integer
Filter by electoral period number. Returns only items from the specified electoral period.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

gremienPut

Administrative endpoint to add or update multiple committees at once. Creates new committees or replaces existing ones based on matching parliament, electoral period, and name.


/api/v2/gremien

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/gremien" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataAdministrationApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        GremienPutRequest gremienPutRequest = ; // GremienPutRequest | 

        try {
            apiInstance.gremienPut(gremienPutRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#gremienPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GremienPutRequest gremienPutRequest = new GremienPutRequest(); // GremienPutRequest | 

try {
    final result = await api_instance.gremienPut(gremienPutRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->gremienPut: $e\n');
}

import org.openapitools.client.api.DataAdministrationApi;

public class DataAdministrationApiExample {
    public static void main(String[] args) {
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        GremienPutRequest gremienPutRequest = ; // GremienPutRequest | 

        try {
            apiInstance.gremienPut(gremienPutRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#gremienPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DataAdministrationApi *apiInstance = [[DataAdministrationApi alloc] init];
GremienPutRequest *gremienPutRequest = ; // 

[apiInstance gremienPutWith:gremienPutRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.DataAdministrationApi()
var gremienPutRequest = ; // {GremienPutRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.gremienPut(gremienPutRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class gremienPutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DataAdministrationApi();
            var gremienPutRequest = new GremienPutRequest(); // GremienPutRequest | 

            try {
                apiInstance.gremienPut(gremienPutRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataAdministrationApi.gremienPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataAdministrationApi();
$gremienPutRequest = ; // GremienPutRequest | 

try {
    $api_instance->gremienPut($gremienPutRequest);
} catch (Exception $e) {
    echo 'Exception when calling DataAdministrationApi->gremienPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataAdministrationApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataAdministrationApi->new();
my $gremienPutRequest = WWW::OPenAPIClient::Object::GremienPutRequest->new(); # GremienPutRequest | 

eval {
    $api_instance->gremienPut(gremienPutRequest => $gremienPutRequest);
};
if ($@) {
    warn "Exception when calling DataAdministrationApi->gremienPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DataAdministrationApi()
gremienPutRequest =  # GremienPutRequest | 

try:
    api_instance.gremien_put(gremienPutRequest)
except ApiException as e:
    print("Exception when calling DataAdministrationApi->gremienPut: %s\n" % e)
extern crate DataAdministrationApi;

pub fn main() {
    let gremienPutRequest = ; // GremienPutRequest

    let mut context = DataAdministrationApi::Context::default();
    let result = client.gremienPut(gremienPutRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
gremienPutRequest *

Committees (Gremien) to update in-place. All objects in 'objects' are inserted if not present. All objects in the 'replaced_by' array are removed if found and references to them are pointed to the objects in the first list as indicated.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

sidPut

Administrative endpoint to directly set or replace a parliamentary session without merging or matching. Replaces the entire session data if it exists, or creates a new one if it doesn't.


/api/v2/sitzung/{sid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/sitzung/{sid}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataAdministrationApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        UUID sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to create or update
        Sitzung sitzung = ; // Sitzung | 

        try {
            apiInstance.sidPut(sid, sitzung);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#sidPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID sid = new UUID(); // UUID | Unique identifier (UUID) of the session to create or update
final Sitzung sitzung = new Sitzung(); // Sitzung | 

try {
    final result = await api_instance.sidPut(sid, sitzung);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sidPut: $e\n');
}

import org.openapitools.client.api.DataAdministrationApi;

public class DataAdministrationApiExample {
    public static void main(String[] args) {
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        UUID sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to create or update
        Sitzung sitzung = ; // Sitzung | 

        try {
            apiInstance.sidPut(sid, sitzung);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#sidPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DataAdministrationApi *apiInstance = [[DataAdministrationApi alloc] init];
UUID *sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the session to create or update (default to null)
Sitzung *sitzung = ; // 

[apiInstance sidPutWith:sid
    sitzung:sitzung
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.DataAdministrationApi()
var sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the session to create or update
var sitzung = ; // {Sitzung} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.sidPut(sid, sitzung, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class sidPutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DataAdministrationApi();
            var sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the session to create or update (default to null)
            var sitzung = new Sitzung(); // Sitzung | 

            try {
                apiInstance.sidPut(sid, sitzung);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataAdministrationApi.sidPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataAdministrationApi();
$sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to create or update
$sitzung = ; // Sitzung | 

try {
    $api_instance->sidPut($sid, $sitzung);
} catch (Exception $e) {
    echo 'Exception when calling DataAdministrationApi->sidPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataAdministrationApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataAdministrationApi->new();
my $sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the session to create or update
my $sitzung = WWW::OPenAPIClient::Object::Sitzung->new(); # Sitzung | 

eval {
    $api_instance->sidPut(sid => $sid, sitzung => $sitzung);
};
if ($@) {
    warn "Exception when calling DataAdministrationApi->sidPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DataAdministrationApi()
sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the session to create or update (default to null)
sitzung =  # Sitzung | 

try:
    api_instance.sid_put(sid, sitzung)
except ApiException as e:
    print("Exception when calling DataAdministrationApi->sidPut: %s\n" % e)
extern crate DataAdministrationApi;

pub fn main() {
    let sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let sitzung = ; // Sitzung

    let mut context = DataAdministrationApi::Context::default();
    let result = client.sidPut(sid, sitzung, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
sid*
UUID (uuid)
Unique identifier (UUID) of the session to create or update
Required
Body parameters
Name Description
sitzung *

Complete representation of the parliamentary session to create or update

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

sitzungDelete

Administrative endpoint to completely remove a parliamentary session from the system. This operation cannot be undone.


/api/v2/sitzung/{sid}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/sitzung/{sid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataAdministrationApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        UUID sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to delete

        try {
            apiInstance.sitzungDelete(sid);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#sitzungDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID sid = new UUID(); // UUID | Unique identifier (UUID) of the session to delete

try {
    final result = await api_instance.sitzungDelete(sid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sitzungDelete: $e\n');
}

import org.openapitools.client.api.DataAdministrationApi;

public class DataAdministrationApiExample {
    public static void main(String[] args) {
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        UUID sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to delete

        try {
            apiInstance.sitzungDelete(sid);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#sitzungDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DataAdministrationApi *apiInstance = [[DataAdministrationApi alloc] init];
UUID *sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the session to delete (default to null)

[apiInstance sitzungDeleteWith:sid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.DataAdministrationApi()
var sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the session to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.sitzungDelete(sid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class sitzungDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DataAdministrationApi();
            var sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the session to delete (default to null)

            try {
                apiInstance.sitzungDelete(sid);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataAdministrationApi.sitzungDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataAdministrationApi();
$sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to delete

try {
    $api_instance->sitzungDelete($sid);
} catch (Exception $e) {
    echo 'Exception when calling DataAdministrationApi->sitzungDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataAdministrationApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataAdministrationApi->new();
my $sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the session to delete

eval {
    $api_instance->sitzungDelete(sid => $sid);
};
if ($@) {
    warn "Exception when calling DataAdministrationApi->sitzungDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DataAdministrationApi()
sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the session to delete (default to null)

try:
    api_instance.sitzung_delete(sid)
except ApiException as e:
    print("Exception when calling DataAdministrationApi->sitzungDelete: %s\n" % e)
extern crate DataAdministrationApi;

pub fn main() {
    let sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = DataAdministrationApi::Context::default();
    let result = client.sitzungDelete(sid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
sid*
UUID (uuid)
Unique identifier (UUID) of the session to delete
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

vorgangDelete

Administrative endpoint to completely remove a legislative process from the system. This operation cannot be undone.


/api/v2/vorgang/{vorgang_id}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/vorgang/{vorgang_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataAdministrationApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        UUID vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to delete

        try {
            apiInstance.vorgangDelete(vorgangId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#vorgangDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID vorgangId = new UUID(); // UUID | Unique identifier (UUID) of the legislative process to delete

try {
    final result = await api_instance.vorgangDelete(vorgangId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->vorgangDelete: $e\n');
}

import org.openapitools.client.api.DataAdministrationApi;

public class DataAdministrationApiExample {
    public static void main(String[] args) {
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        UUID vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to delete

        try {
            apiInstance.vorgangDelete(vorgangId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#vorgangDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DataAdministrationApi *apiInstance = [[DataAdministrationApi alloc] init];
UUID *vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the legislative process to delete (default to null)

[apiInstance vorgangDeleteWith:vorgangId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.DataAdministrationApi()
var vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the legislative process to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.vorgangDelete(vorgangId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class vorgangDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DataAdministrationApi();
            var vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the legislative process to delete (default to null)

            try {
                apiInstance.vorgangDelete(vorgangId);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataAdministrationApi.vorgangDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataAdministrationApi();
$vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to delete

try {
    $api_instance->vorgangDelete($vorgangId);
} catch (Exception $e) {
    echo 'Exception when calling DataAdministrationApi->vorgangDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataAdministrationApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataAdministrationApi->new();
my $vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the legislative process to delete

eval {
    $api_instance->vorgangDelete(vorgangId => $vorgangId);
};
if ($@) {
    warn "Exception when calling DataAdministrationApi->vorgangDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DataAdministrationApi()
vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the legislative process to delete (default to null)

try:
    api_instance.vorgang_delete(vorgangId)
except ApiException as e:
    print("Exception when calling DataAdministrationApi->vorgangDelete: %s\n" % e)
extern crate DataAdministrationApi;

pub fn main() {
    let vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = DataAdministrationApi::Context::default();
    let result = client.vorgangDelete(vorgangId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vorgang_id*
UUID (uuid)
Unique identifier (UUID) of the legislative process to delete
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

vorgangIdPut

Administrative endpoint to directly set or replace a legislative process without merging or matching. Replaces the entire process data if it exists, or creates a new one if it doesn't.


/api/v2/vorgang/{vorgang_id}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/vorgang/{vorgang_id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DataAdministrationApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        UUID vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to create or update
        Vorgang vorgang = ; // Vorgang | 

        try {
            apiInstance.vorgangIdPut(vorgangId, vorgang);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#vorgangIdPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID vorgangId = new UUID(); // UUID | Unique identifier (UUID) of the legislative process to create or update
final Vorgang vorgang = new Vorgang(); // Vorgang | 

try {
    final result = await api_instance.vorgangIdPut(vorgangId, vorgang);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->vorgangIdPut: $e\n');
}

import org.openapitools.client.api.DataAdministrationApi;

public class DataAdministrationApiExample {
    public static void main(String[] args) {
        DataAdministrationApi apiInstance = new DataAdministrationApi();
        UUID vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to create or update
        Vorgang vorgang = ; // Vorgang | 

        try {
            apiInstance.vorgangIdPut(vorgangId, vorgang);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataAdministrationApi#vorgangIdPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DataAdministrationApi *apiInstance = [[DataAdministrationApi alloc] init];
UUID *vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the legislative process to create or update (default to null)
Vorgang *vorgang = ; // 

[apiInstance vorgangIdPutWith:vorgangId
    vorgang:vorgang
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.DataAdministrationApi()
var vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the legislative process to create or update
var vorgang = ; // {Vorgang} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.vorgangIdPut(vorgangId, vorgang, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class vorgangIdPutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DataAdministrationApi();
            var vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the legislative process to create or update (default to null)
            var vorgang = new Vorgang(); // Vorgang | 

            try {
                apiInstance.vorgangIdPut(vorgangId, vorgang);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataAdministrationApi.vorgangIdPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataAdministrationApi();
$vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to create or update
$vorgang = ; // Vorgang | 

try {
    $api_instance->vorgangIdPut($vorgangId, $vorgang);
} catch (Exception $e) {
    echo 'Exception when calling DataAdministrationApi->vorgangIdPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DataAdministrationApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DataAdministrationApi->new();
my $vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the legislative process to create or update
my $vorgang = WWW::OPenAPIClient::Object::Vorgang->new(); # Vorgang | 

eval {
    $api_instance->vorgangIdPut(vorgangId => $vorgangId, vorgang => $vorgang);
};
if ($@) {
    warn "Exception when calling DataAdministrationApi->vorgangIdPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DataAdministrationApi()
vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the legislative process to create or update (default to null)
vorgang =  # Vorgang | 

try:
    api_instance.vorgang_id_put(vorgangId, vorgang)
except ApiException as e:
    print("Exception when calling DataAdministrationApi->vorgangIdPut: %s\n" % e)
extern crate DataAdministrationApi;

pub fn main() {
    let vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let vorgang = ; // Vorgang

    let mut context = DataAdministrationApi::Context::default();
    let result = client.vorgangIdPut(vorgangId, vorgang, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vorgang_id*
UUID (uuid)
Unique identifier (UUID) of the legislative process to create or update
Required
Body parameters
Name Description
vorgang *

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

KeyadderSchnittstellen

authDelete

Key adder interface for removing API keys from the system. Allows administrators and key management services to revoke access by deleting an existing API key.


/api/v2/auth

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/auth"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KeyadderSchnittstellenApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        KeyadderSchnittstellenApi apiInstance = new KeyadderSchnittstellenApi();
        String apiKeyDelete = apiKeyDelete_example; // String | The API key to be deleted from the system. Must be provided as keytag.

        try {
            apiInstance.authDelete(apiKeyDelete);
        } catch (ApiException e) {
            System.err.println("Exception when calling KeyadderSchnittstellenApi#authDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String apiKeyDelete = new String(); // String | The API key to be deleted from the system. Must be provided as keytag.

try {
    final result = await api_instance.authDelete(apiKeyDelete);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->authDelete: $e\n');
}

import org.openapitools.client.api.KeyadderSchnittstellenApi;

public class KeyadderSchnittstellenApiExample {
    public static void main(String[] args) {
        KeyadderSchnittstellenApi apiInstance = new KeyadderSchnittstellenApi();
        String apiKeyDelete = apiKeyDelete_example; // String | The API key to be deleted from the system. Must be provided as keytag.

        try {
            apiInstance.authDelete(apiKeyDelete);
        } catch (ApiException e) {
            System.err.println("Exception when calling KeyadderSchnittstellenApi#authDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
KeyadderSchnittstellenApi *apiInstance = [[KeyadderSchnittstellenApi alloc] init];
String *apiKeyDelete = apiKeyDelete_example; // The API key to be deleted from the system. Must be provided as keytag. (default to null)

[apiInstance authDeleteWith:apiKeyDelete
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.KeyadderSchnittstellenApi()
var apiKeyDelete = apiKeyDelete_example; // {String} The API key to be deleted from the system. Must be provided as keytag.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.authDelete(apiKeyDelete, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class authDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new KeyadderSchnittstellenApi();
            var apiKeyDelete = apiKeyDelete_example;  // String | The API key to be deleted from the system. Must be provided as keytag. (default to null)

            try {
                apiInstance.authDelete(apiKeyDelete);
            } catch (Exception e) {
                Debug.Print("Exception when calling KeyadderSchnittstellenApi.authDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KeyadderSchnittstellenApi();
$apiKeyDelete = apiKeyDelete_example; // String | The API key to be deleted from the system. Must be provided as keytag.

try {
    $api_instance->authDelete($apiKeyDelete);
} catch (Exception $e) {
    echo 'Exception when calling KeyadderSchnittstellenApi->authDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KeyadderSchnittstellenApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KeyadderSchnittstellenApi->new();
my $apiKeyDelete = apiKeyDelete_example; # String | The API key to be deleted from the system. Must be provided as keytag.

eval {
    $api_instance->authDelete(apiKeyDelete => $apiKeyDelete);
};
if ($@) {
    warn "Exception when calling KeyadderSchnittstellenApi->authDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.KeyadderSchnittstellenApi()
apiKeyDelete = apiKeyDelete_example # String | The API key to be deleted from the system. Must be provided as keytag. (default to null)

try:
    api_instance.auth_delete(apiKeyDelete)
except ApiException as e:
    print("Exception when calling KeyadderSchnittstellenApi->authDelete: %s\n" % e)
extern crate KeyadderSchnittstellenApi;

pub fn main() {
    let apiKeyDelete = apiKeyDelete_example; // String

    let mut context = KeyadderSchnittstellenApi::Context::default();
    let result = client.authDelete(apiKeyDelete, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
api-key-delete*
String
The API key to be deleted from the system. Must be provided as keytag.
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

authListing

Retrieve a list of Keys that are currently in Use


/api/v2/auth/keys

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "http://localhost/api/v2/auth/keys?since=2024-01-01T00:00Z&until=2024-12-31T23:59:59Z&page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KeyadderSchnittstellenApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        KeyadderSchnittstellenApi apiInstance = new KeyadderSchnittstellenApi();
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array['String'] result = apiInstance.authListing(since, until, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KeyadderSchnittstellenApi#authListing");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Date since = new Date(); // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
final Date until = new Date(); // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.authListing(since, until, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->authListing: $e\n');
}

import org.openapitools.client.api.KeyadderSchnittstellenApi;

public class KeyadderSchnittstellenApiExample {
    public static void main(String[] args) {
        KeyadderSchnittstellenApi apiInstance = new KeyadderSchnittstellenApi();
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array['String'] result = apiInstance.authListing(since, until, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KeyadderSchnittstellenApi#authListing");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
KeyadderSchnittstellenApi *apiInstance = [[KeyadderSchnittstellenApi alloc] init];
Date *since = 2024-01-01T00:00Z; // Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
Date *until = 2024-12-31T23:59:59Z; // Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance authListingWith:since
    until:until
    page:page
    perPage:perPage
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.KeyadderSchnittstellenApi()
var opts = {
  'since': 2024-01-01T00:00Z, // {Date} Filter results to include only items updated on or after this timestamp (inclusive lower bound)
  'until': 2024-12-31T23:59:59Z, // {Date} Filter results to include only items updated on or before this timestamp (inclusive upper bound)
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

namespace Example
{
    public class authListingExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new KeyadderSchnittstellenApi();
            var since = 2024-01-01T00:00Z;  // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional)  (default to null)
            var until = 2024-12-31T23:59:59Z;  // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array['String'] result = apiInstance.authListing(since, until, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KeyadderSchnittstellenApi.authListing: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KeyadderSchnittstellenApi();
$since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
$until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->authListing($since, $until, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KeyadderSchnittstellenApi->authListing: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KeyadderSchnittstellenApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KeyadderSchnittstellenApi->new();
my $since = 2024-01-01T00:00Z; # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
my $until = 2024-12-31T23:59:59Z; # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->authListing(since => $since, until => $until, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KeyadderSchnittstellenApi->authListing: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.KeyadderSchnittstellenApi()
since = 2024-01-01T00:00Z # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
until = 2024-12-31T23:59:59Z # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.auth_listing(since=since, until=until, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KeyadderSchnittstellenApi->authListing: %s\n" % e)
extern crate KeyadderSchnittstellenApi;

pub fn main() {
    let since = 2024-01-01T00:00Z; // Date
    let until = 2024-12-31T23:59:59Z; // Date
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = KeyadderSchnittstellenApi::Context::default();
    let result = client.authListing(since, until, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
since
Date (date-time)
Filter results to include only items updated on or after this timestamp (inclusive lower bound)
until
Date (date-time)
Filter results to include only items updated on or before this timestamp (inclusive upper bound)
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

authListingKeytag

Retrieve a detailed overview of the objects changed by this key


/api/v2/auth/keys/{keytag}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "http://localhost/api/v2/auth/keys/{keytag}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KeyadderSchnittstellenApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        KeyadderSchnittstellenApi apiInstance = new KeyadderSchnittstellenApi();
        String keytag = keytag_example; // String | 

        try {
            auth_listing_keytag_200_response result = apiInstance.authListingKeytag(keytag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KeyadderSchnittstellenApi#authListingKeytag");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String keytag = new String(); // String | 

try {
    final result = await api_instance.authListingKeytag(keytag);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->authListingKeytag: $e\n');
}

import org.openapitools.client.api.KeyadderSchnittstellenApi;

public class KeyadderSchnittstellenApiExample {
    public static void main(String[] args) {
        KeyadderSchnittstellenApi apiInstance = new KeyadderSchnittstellenApi();
        String keytag = keytag_example; // String | 

        try {
            auth_listing_keytag_200_response result = apiInstance.authListingKeytag(keytag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KeyadderSchnittstellenApi#authListingKeytag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
KeyadderSchnittstellenApi *apiInstance = [[KeyadderSchnittstellenApi alloc] init];
String *keytag = keytag_example; //  (default to null)

[apiInstance authListingKeytagWith:keytag
              completionHandler: ^(auth_listing_keytag_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.KeyadderSchnittstellenApi()
var keytag = keytag_example; // {String} 

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

namespace Example
{
    public class authListingKeytagExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new KeyadderSchnittstellenApi();
            var keytag = keytag_example;  // String |  (default to null)

            try {
                auth_listing_keytag_200_response result = apiInstance.authListingKeytag(keytag);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KeyadderSchnittstellenApi.authListingKeytag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KeyadderSchnittstellenApi();
$keytag = keytag_example; // String | 

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

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KeyadderSchnittstellenApi->new();
my $keytag = keytag_example; # String | 

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

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.KeyadderSchnittstellenApi()
keytag = keytag_example # String |  (default to null)

try:
    api_response = api_instance.auth_listing_keytag(keytag)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KeyadderSchnittstellenApi->authListingKeytag: %s\n" % e)
extern crate KeyadderSchnittstellenApi;

pub fn main() {
    let keytag = keytag_example; // String

    let mut context = KeyadderSchnittstellenApi::Context::default();
    let result = client.authListingKeytag(keytag, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
keytag*
String
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

authPost

Key adder interface for creating new API keys. Allows administrators to generate new access keys for collectors, administrative tools, or other key adders.


/api/v2/auth

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: text/plain" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/auth" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KeyadderSchnittstellenApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        KeyadderSchnittstellenApi apiInstance = new KeyadderSchnittstellenApi();
        CreateApiKey createApiKey = ; // CreateApiKey | 

        try {
            'String' result = apiInstance.authPost(createApiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KeyadderSchnittstellenApi#authPost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CreateApiKey createApiKey = new CreateApiKey(); // CreateApiKey | 

try {
    final result = await api_instance.authPost(createApiKey);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->authPost: $e\n');
}

import org.openapitools.client.api.KeyadderSchnittstellenApi;

public class KeyadderSchnittstellenApiExample {
    public static void main(String[] args) {
        KeyadderSchnittstellenApi apiInstance = new KeyadderSchnittstellenApi();
        CreateApiKey createApiKey = ; // CreateApiKey | 

        try {
            'String' result = apiInstance.authPost(createApiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KeyadderSchnittstellenApi#authPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
KeyadderSchnittstellenApi *apiInstance = [[KeyadderSchnittstellenApi alloc] init];
CreateApiKey *createApiKey = ; // 

[apiInstance authPostWith:createApiKey
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.KeyadderSchnittstellenApi()
var createApiKey = ; // {CreateApiKey} 

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

namespace Example
{
    public class authPostExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new KeyadderSchnittstellenApi();
            var createApiKey = new CreateApiKey(); // CreateApiKey | 

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

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KeyadderSchnittstellenApi();
$createApiKey = ; // CreateApiKey | 

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

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KeyadderSchnittstellenApi->new();
my $createApiKey = WWW::OPenAPIClient::Object::CreateApiKey->new(); # CreateApiKey | 

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

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.KeyadderSchnittstellenApi()
createApiKey =  # CreateApiKey | 

try:
    api_response = api_instance.auth_post(createApiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KeyadderSchnittstellenApi->authPost: %s\n" % e)
extern crate KeyadderSchnittstellenApi;

pub fn main() {
    let createApiKey = ; // CreateApiKey

    let mut context = KeyadderSchnittstellenApi::Context::default();
    let result = client.authPost(createApiKey, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
createApiKey *

Details about the new API key to be created, including its scope and optional expiration date

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Miscellaneous

autorenDeleteByParam

Administrative endpoint to delete authors matching the specified criteria. Removes all authors that match the filter parameters.


/api/v2/autoren

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/autoren?person=person_example&fach=fach_example&org=org_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MiscellaneousApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        String person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
        String fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
        String org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.

        try {
            apiInstance.autorenDeleteByParam(person, fach, org);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#autorenDeleteByParam");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String person = new String(); // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
final String fach = new String(); // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
final String org = new String(); // String | Filter by author organization. Returns items where an author belongs to the specified organization.

try {
    final result = await api_instance.autorenDeleteByParam(person, fach, org);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->autorenDeleteByParam: $e\n');
}

import org.openapitools.client.api.MiscellaneousApi;

public class MiscellaneousApiExample {
    public static void main(String[] args) {
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        String person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
        String fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
        String org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.

        try {
            apiInstance.autorenDeleteByParam(person, fach, org);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#autorenDeleteByParam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
MiscellaneousApi *apiInstance = [[MiscellaneousApi alloc] init];
String *person = person_example; // Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional) (default to null)
String *fach = fach_example; // Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional) (default to null)
String *org = org_example; // Filter by author organization. Returns items where an author belongs to the specified organization. (optional) (default to null)

[apiInstance autorenDeleteByParamWith:person
    fach:fach
    org:org
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.MiscellaneousApi()
var opts = {
  'person': person_example, // {String} Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
  'fach': fach_example, // {String} Filter by author's professional field. Returns items where an author has the specified professional expertise.
  'org': org_example // {String} Filter by author organization. Returns items where an author belongs to the specified organization.
};

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

namespace Example
{
    public class autorenDeleteByParamExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MiscellaneousApi();
            var person = person_example;  // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional)  (default to null)
            var fach = fach_example;  // String | Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional)  (default to null)
            var org = org_example;  // String | Filter by author organization. Returns items where an author belongs to the specified organization. (optional)  (default to null)

            try {
                apiInstance.autorenDeleteByParam(person, fach, org);
            } catch (Exception e) {
                Debug.Print("Exception when calling MiscellaneousApi.autorenDeleteByParam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MiscellaneousApi();
$person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
$fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
$org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.

try {
    $api_instance->autorenDeleteByParam($person, $fach, $org);
} catch (Exception $e) {
    echo 'Exception when calling MiscellaneousApi->autorenDeleteByParam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MiscellaneousApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MiscellaneousApi->new();
my $person = person_example; # String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
my $fach = fach_example; # String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
my $org = org_example; # String | Filter by author organization. Returns items where an author belongs to the specified organization.

eval {
    $api_instance->autorenDeleteByParam(person => $person, fach => $fach, org => $org);
};
if ($@) {
    warn "Exception when calling MiscellaneousApi->autorenDeleteByParam: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MiscellaneousApi()
person = person_example # String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional) (default to null)
fach = fach_example # String | Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional) (default to null)
org = org_example # String | Filter by author organization. Returns items where an author belongs to the specified organization. (optional) (default to null)

try:
    api_instance.autoren_delete_by_param(person=person, fach=fach, org=org)
except ApiException as e:
    print("Exception when calling MiscellaneousApi->autorenDeleteByParam: %s\n" % e)
extern crate MiscellaneousApi;

pub fn main() {
    let person = person_example; // String
    let fach = fach_example; // String
    let org = org_example; // String

    let mut context = MiscellaneousApi::Context::default();
    let result = client.autorenDeleteByParam(person, fach, org, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
person
String
Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
fach
String
Filter by author's professional field. Returns items where an author has the specified professional expertise.
org
String
Filter by author organization. Returns items where an author belongs to the specified organization.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

autorenGet

Retrieves a list of authors filtered by optional parameters. Returns authors matching the specified criteria including name fragments, professional field, and organization.


/api/v2/autoren

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/autoren?person=person_example&fach=fach_example&org=org_example&page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MiscellaneousApi;

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

public class MiscellaneousApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        String person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
        String fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
        String org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[autor] result = apiInstance.autorenGet(person, fach, org, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#autorenGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String person = new String(); // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
final String fach = new String(); // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
final String org = new String(); // String | Filter by author organization. Returns items where an author belongs to the specified organization.
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.autorenGet(person, fach, org, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->autorenGet: $e\n');
}

import org.openapitools.client.api.MiscellaneousApi;

public class MiscellaneousApiExample {
    public static void main(String[] args) {
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        String person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
        String fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
        String org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[autor] result = apiInstance.autorenGet(person, fach, org, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#autorenGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MiscellaneousApi *apiInstance = [[MiscellaneousApi alloc] init];
String *person = person_example; // Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional) (default to null)
String *fach = fach_example; // Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional) (default to null)
String *org = org_example; // Filter by author organization. Returns items where an author belongs to the specified organization. (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance autorenGetWith:person
    fach:fach
    org:org
    page:page
    perPage:perPage
              completionHandler: ^(array[autor] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.MiscellaneousApi()
var opts = {
  'person': person_example, // {String} Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
  'fach': fach_example, // {String} Filter by author's professional field. Returns items where an author has the specified professional expertise.
  'org': org_example, // {String} Filter by author organization. Returns items where an author belongs to the specified organization.
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

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

            // Create an instance of the API class
            var apiInstance = new MiscellaneousApi();
            var person = person_example;  // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional)  (default to null)
            var fach = fach_example;  // String | Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional)  (default to null)
            var org = org_example;  // String | Filter by author organization. Returns items where an author belongs to the specified organization. (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array[autor] result = apiInstance.autorenGet(person, fach, org, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MiscellaneousApi.autorenGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MiscellaneousApi();
$person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
$fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
$org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->autorenGet($person, $fach, $org, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MiscellaneousApi->autorenGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MiscellaneousApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MiscellaneousApi->new();
my $person = person_example; # String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
my $fach = fach_example; # String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
my $org = org_example; # String | Filter by author organization. Returns items where an author belongs to the specified organization.
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->autorenGet(person => $person, fach => $fach, org => $org, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MiscellaneousApi->autorenGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MiscellaneousApi()
person = person_example # String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional) (default to null)
fach = fach_example # String | Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional) (default to null)
org = org_example # String | Filter by author organization. Returns items where an author belongs to the specified organization. (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.autoren_get(person=person, fach=fach, org=org, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MiscellaneousApi->autorenGet: %s\n" % e)
extern crate MiscellaneousApi;

pub fn main() {
    let person = person_example; // String
    let fach = fach_example; // String
    let org = org_example; // String
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = MiscellaneousApi::Context::default();
    let result = client.autorenGet(person, fach, org, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
person
String
Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
fach
String
Filter by author's professional field. Returns items where an author has the specified professional expertise.
org
String
Filter by author organization. Returns items where an author belongs to the specified organization.
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

autorenPut

Administrative endpoint to add or update multiple authors at once. Creates new authors or replaces existing ones based on matching names and organizations.


/api/v2/autoren

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/autoren" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MiscellaneousApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        AutorenPutRequest autorenPutRequest = ; // AutorenPutRequest | 

        try {
            apiInstance.autorenPut(autorenPutRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#autorenPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AutorenPutRequest autorenPutRequest = new AutorenPutRequest(); // AutorenPutRequest | 

try {
    final result = await api_instance.autorenPut(autorenPutRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->autorenPut: $e\n');
}

import org.openapitools.client.api.MiscellaneousApi;

public class MiscellaneousApiExample {
    public static void main(String[] args) {
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        AutorenPutRequest autorenPutRequest = ; // AutorenPutRequest | 

        try {
            apiInstance.autorenPut(autorenPutRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#autorenPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
MiscellaneousApi *apiInstance = [[MiscellaneousApi alloc] init];
AutorenPutRequest *autorenPutRequest = ; // 

[apiInstance autorenPutWith:autorenPutRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.MiscellaneousApi()
var autorenPutRequest = ; // {AutorenPutRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.autorenPut(autorenPutRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class autorenPutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MiscellaneousApi();
            var autorenPutRequest = new AutorenPutRequest(); // AutorenPutRequest | 

            try {
                apiInstance.autorenPut(autorenPutRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling MiscellaneousApi.autorenPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MiscellaneousApi();
$autorenPutRequest = ; // AutorenPutRequest | 

try {
    $api_instance->autorenPut($autorenPutRequest);
} catch (Exception $e) {
    echo 'Exception when calling MiscellaneousApi->autorenPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MiscellaneousApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MiscellaneousApi->new();
my $autorenPutRequest = WWW::OPenAPIClient::Object::AutorenPutRequest->new(); # AutorenPutRequest | 

eval {
    $api_instance->autorenPut(autorenPutRequest => $autorenPutRequest);
};
if ($@) {
    warn "Exception when calling MiscellaneousApi->autorenPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MiscellaneousApi()
autorenPutRequest =  # AutorenPutRequest | 

try:
    api_instance.autoren_put(autorenPutRequest)
except ApiException as e:
    print("Exception when calling MiscellaneousApi->autorenPut: %s\n" % e)
extern crate MiscellaneousApi;

pub fn main() {
    let autorenPutRequest = ; // AutorenPutRequest

    let mut context = MiscellaneousApi::Context::default();
    let result = client.autorenPut(autorenPutRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
autorenPutRequest *

Array of authors to create or update

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

dokumentDeleteId

Administrative endpoint to remove a document from the system. This operation cannot be undone and may affect other resources referencing this document.


/api/v2/dokument/{api_id}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/dokument/{api_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MiscellaneousApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        UUID apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the document to delete

        try {
            apiInstance.dokumentDeleteId(apiId);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#dokumentDeleteId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID apiId = new UUID(); // UUID | Unique identifier (UUID) of the document to delete

try {
    final result = await api_instance.dokumentDeleteId(apiId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dokumentDeleteId: $e\n');
}

import org.openapitools.client.api.MiscellaneousApi;

public class MiscellaneousApiExample {
    public static void main(String[] args) {
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        UUID apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the document to delete

        try {
            apiInstance.dokumentDeleteId(apiId);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#dokumentDeleteId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
MiscellaneousApi *apiInstance = [[MiscellaneousApi alloc] init];
UUID *apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the document to delete (default to null)

[apiInstance dokumentDeleteIdWith:apiId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.MiscellaneousApi()
var apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the document to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.dokumentDeleteId(apiId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class dokumentDeleteIdExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MiscellaneousApi();
            var apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the document to delete (default to null)

            try {
                apiInstance.dokumentDeleteId(apiId);
            } catch (Exception e) {
                Debug.Print("Exception when calling MiscellaneousApi.dokumentDeleteId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MiscellaneousApi();
$apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the document to delete

try {
    $api_instance->dokumentDeleteId($apiId);
} catch (Exception $e) {
    echo 'Exception when calling MiscellaneousApi->dokumentDeleteId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MiscellaneousApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MiscellaneousApi->new();
my $apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the document to delete

eval {
    $api_instance->dokumentDeleteId(apiId => $apiId);
};
if ($@) {
    warn "Exception when calling MiscellaneousApi->dokumentDeleteId: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MiscellaneousApi()
apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the document to delete (default to null)

try:
    api_instance.dokument_delete_id(apiId)
except ApiException as e:
    print("Exception when calling MiscellaneousApi->dokumentDeleteId: %s\n" % e)
extern crate MiscellaneousApi;

pub fn main() {
    let apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = MiscellaneousApi::Context::default();
    let result = client.dokumentDeleteId(apiId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
api_id*
UUID (uuid)
Unique identifier (UUID) of the document to delete
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

dokumentGetById

Retrieves a specific document by its unique identifier. Returns complete document data including title, full text, metadata, and author information. If called by admin or higher, this returns a list of last scrapers/collectors touching the object


/api/v2/dokument/{api_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/dokument/{api_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MiscellaneousApi;

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

public class MiscellaneousApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        UUID apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the document to retrieve

        try {
            dokument result = apiInstance.dokumentGetById(apiId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#dokumentGetById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID apiId = new UUID(); // UUID | Unique identifier (UUID) of the document to retrieve

try {
    final result = await api_instance.dokumentGetById(apiId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dokumentGetById: $e\n');
}

import org.openapitools.client.api.MiscellaneousApi;

public class MiscellaneousApiExample {
    public static void main(String[] args) {
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        UUID apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the document to retrieve

        try {
            dokument result = apiInstance.dokumentGetById(apiId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#dokumentGetById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MiscellaneousApi *apiInstance = [[MiscellaneousApi alloc] init];
UUID *apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the document to retrieve (default to null)

[apiInstance dokumentGetByIdWith:apiId
              completionHandler: ^(dokument output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.MiscellaneousApi()
var apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the document to retrieve

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

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

            // Create an instance of the API class
            var apiInstance = new MiscellaneousApi();
            var apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the document to retrieve (default to null)

            try {
                dokument result = apiInstance.dokumentGetById(apiId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MiscellaneousApi.dokumentGetById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MiscellaneousApi();
$apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the document to retrieve

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MiscellaneousApi->new();
my $apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the document to retrieve

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

# Create an instance of the API class
api_instance = openapi_client.MiscellaneousApi()
apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the document to retrieve (default to null)

try:
    api_response = api_instance.dokument_get_by_id(apiId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MiscellaneousApi->dokumentGetById: %s\n" % e)
extern crate MiscellaneousApi;

pub fn main() {
    let apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = MiscellaneousApi::Context::default();
    let result = client.dokumentGetById(apiId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
api_id*
UUID (uuid)
Unique identifier (UUID) of the document to retrieve
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

dokumentPutId

Administrative endpoint to upload or update documents for future reference. Creates a new document with the specified ID or replaces an existing one.


/api/v2/dokument/{api_id}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/dokument/{api_id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MiscellaneousApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        UUID apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) to assign to the document or of the existing document to update
        Dokument dokument = ; // Dokument | 

        try {
            apiInstance.dokumentPutId(apiId, dokument);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#dokumentPutId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID apiId = new UUID(); // UUID | Unique identifier (UUID) to assign to the document or of the existing document to update
final Dokument dokument = new Dokument(); // Dokument | 

try {
    final result = await api_instance.dokumentPutId(apiId, dokument);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dokumentPutId: $e\n');
}

import org.openapitools.client.api.MiscellaneousApi;

public class MiscellaneousApiExample {
    public static void main(String[] args) {
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        UUID apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) to assign to the document or of the existing document to update
        Dokument dokument = ; // Dokument | 

        try {
            apiInstance.dokumentPutId(apiId, dokument);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#dokumentPutId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
MiscellaneousApi *apiInstance = [[MiscellaneousApi alloc] init];
UUID *apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) to assign to the document or of the existing document to update (default to null)
Dokument *dokument = ; // 

[apiInstance dokumentPutIdWith:apiId
    dokument:dokument
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.MiscellaneousApi()
var apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) to assign to the document or of the existing document to update
var dokument = ; // {Dokument} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.dokumentPutId(apiId, dokument, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class dokumentPutIdExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MiscellaneousApi();
            var apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) to assign to the document or of the existing document to update (default to null)
            var dokument = new Dokument(); // Dokument | 

            try {
                apiInstance.dokumentPutId(apiId, dokument);
            } catch (Exception e) {
                Debug.Print("Exception when calling MiscellaneousApi.dokumentPutId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MiscellaneousApi();
$apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) to assign to the document or of the existing document to update
$dokument = ; // Dokument | 

try {
    $api_instance->dokumentPutId($apiId, $dokument);
} catch (Exception $e) {
    echo 'Exception when calling MiscellaneousApi->dokumentPutId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MiscellaneousApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MiscellaneousApi->new();
my $apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) to assign to the document or of the existing document to update
my $dokument = WWW::OPenAPIClient::Object::Dokument->new(); # Dokument | 

eval {
    $api_instance->dokumentPutId(apiId => $apiId, dokument => $dokument);
};
if ($@) {
    warn "Exception when calling MiscellaneousApi->dokumentPutId: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MiscellaneousApi()
apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) to assign to the document or of the existing document to update (default to null)
dokument =  # Dokument | 

try:
    api_instance.dokument_put_id(apiId, dokument)
except ApiException as e:
    print("Exception when calling MiscellaneousApi->dokumentPutId: %s\n" % e)
extern crate MiscellaneousApi;

pub fn main() {
    let apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let dokument = ; // Dokument

    let mut context = MiscellaneousApi::Context::default();
    let result = client.dokumentPutId(apiId, dokument, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
api_id*
UUID (uuid)
Unique identifier (UUID) to assign to the document or of the existing document to update
Required
Body parameters
Name Description
dokument *

Complete representation of the document to create or update

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

enumDelete

Administrative endpoint to remove a specific value from an enumeration type. Performs case-sensitive matching to identify and delete the exact value.


/api/v2/enumeration/{name}/{item}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/enumeration/{name}/{item}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MiscellaneousApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        String item = item_example; // String | The exact value to remove from the enumeration (case-sensitive)
        EnumerationNames name = ; // EnumerationNames | Name of the enumeration type to remove a value from

        try {
            apiInstance.enumDelete(item, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#enumDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String item = new String(); // String | The exact value to remove from the enumeration (case-sensitive)
final EnumerationNames name = new EnumerationNames(); // EnumerationNames | Name of the enumeration type to remove a value from

try {
    final result = await api_instance.enumDelete(item, name);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->enumDelete: $e\n');
}

import org.openapitools.client.api.MiscellaneousApi;

public class MiscellaneousApiExample {
    public static void main(String[] args) {
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        String item = item_example; // String | The exact value to remove from the enumeration (case-sensitive)
        EnumerationNames name = ; // EnumerationNames | Name of the enumeration type to remove a value from

        try {
            apiInstance.enumDelete(item, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#enumDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
MiscellaneousApi *apiInstance = [[MiscellaneousApi alloc] init];
String *item = item_example; // The exact value to remove from the enumeration (case-sensitive) (default to null)
EnumerationNames *name = ; // Name of the enumeration type to remove a value from (default to null)

[apiInstance enumDeleteWith:item
    name:name
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.MiscellaneousApi()
var item = item_example; // {String} The exact value to remove from the enumeration (case-sensitive)
var name = ; // {EnumerationNames} Name of the enumeration type to remove a value from

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.enumDelete(item, name, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class enumDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MiscellaneousApi();
            var item = item_example;  // String | The exact value to remove from the enumeration (case-sensitive) (default to null)
            var name = new EnumerationNames(); // EnumerationNames | Name of the enumeration type to remove a value from (default to null)

            try {
                apiInstance.enumDelete(item, name);
            } catch (Exception e) {
                Debug.Print("Exception when calling MiscellaneousApi.enumDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MiscellaneousApi();
$item = item_example; // String | The exact value to remove from the enumeration (case-sensitive)
$name = ; // EnumerationNames | Name of the enumeration type to remove a value from

try {
    $api_instance->enumDelete($item, $name);
} catch (Exception $e) {
    echo 'Exception when calling MiscellaneousApi->enumDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MiscellaneousApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MiscellaneousApi->new();
my $item = item_example; # String | The exact value to remove from the enumeration (case-sensitive)
my $name = ; # EnumerationNames | Name of the enumeration type to remove a value from

eval {
    $api_instance->enumDelete(item => $item, name => $name);
};
if ($@) {
    warn "Exception when calling MiscellaneousApi->enumDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MiscellaneousApi()
item = item_example # String | The exact value to remove from the enumeration (case-sensitive) (default to null)
name =  # EnumerationNames | Name of the enumeration type to remove a value from (default to null)

try:
    api_instance.enum_delete(item, name)
except ApiException as e:
    print("Exception when calling MiscellaneousApi->enumDelete: %s\n" % e)
extern crate MiscellaneousApi;

pub fn main() {
    let item = item_example; // String
    let name = ; // EnumerationNames

    let mut context = MiscellaneousApi::Context::default();
    let result = client.enumDelete(item, name, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
item*
String
The exact value to remove from the enumeration (case-sensitive)
Required
name*
EnumerationNames
Name of the enumeration type to remove a value from
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

enumGet

Retrieves values from a specified enumeration type. Returns a list of valid values that can be used in other API operations, optionally filtered by a substring.


/api/v2/enumeration/{name}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/enumeration/{name}?contains=contains_example&page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MiscellaneousApi;

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

public class MiscellaneousApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        EnumerationNames name = ; // EnumerationNames | Name of the enumeration type to retrieve values from
        String contains = contains_example; // String | Filter by substring match. Returns items containing this string (case-insensitive).
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array['String'] result = apiInstance.enumGet(name, contains, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#enumGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final EnumerationNames name = new EnumerationNames(); // EnumerationNames | Name of the enumeration type to retrieve values from
final String contains = new String(); // String | Filter by substring match. Returns items containing this string (case-insensitive).
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.enumGet(name, contains, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->enumGet: $e\n');
}

import org.openapitools.client.api.MiscellaneousApi;

public class MiscellaneousApiExample {
    public static void main(String[] args) {
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        EnumerationNames name = ; // EnumerationNames | Name of the enumeration type to retrieve values from
        String contains = contains_example; // String | Filter by substring match. Returns items containing this string (case-insensitive).
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array['String'] result = apiInstance.enumGet(name, contains, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#enumGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MiscellaneousApi *apiInstance = [[MiscellaneousApi alloc] init];
EnumerationNames *name = ; // Name of the enumeration type to retrieve values from (default to null)
String *contains = contains_example; // Filter by substring match. Returns items containing this string (case-insensitive). (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance enumGetWith:name
    contains:contains
    page:page
    perPage:perPage
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.MiscellaneousApi()
var name = ; // {EnumerationNames} Name of the enumeration type to retrieve values from
var opts = {
  'contains': contains_example, // {String} Filter by substring match. Returns items containing this string (case-insensitive).
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

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

            // Create an instance of the API class
            var apiInstance = new MiscellaneousApi();
            var name = new EnumerationNames(); // EnumerationNames | Name of the enumeration type to retrieve values from (default to null)
            var contains = contains_example;  // String | Filter by substring match. Returns items containing this string (case-insensitive). (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array['String'] result = apiInstance.enumGet(name, contains, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MiscellaneousApi.enumGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MiscellaneousApi();
$name = ; // EnumerationNames | Name of the enumeration type to retrieve values from
$contains = contains_example; // String | Filter by substring match. Returns items containing this string (case-insensitive).
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->enumGet($name, $contains, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MiscellaneousApi->enumGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MiscellaneousApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MiscellaneousApi->new();
my $name = ; # EnumerationNames | Name of the enumeration type to retrieve values from
my $contains = contains_example; # String | Filter by substring match. Returns items containing this string (case-insensitive).
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->enumGet(name => $name, contains => $contains, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MiscellaneousApi->enumGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MiscellaneousApi()
name =  # EnumerationNames | Name of the enumeration type to retrieve values from (default to null)
contains = contains_example # String | Filter by substring match. Returns items containing this string (case-insensitive). (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.enum_get(name, contains=contains, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MiscellaneousApi->enumGet: %s\n" % e)
extern crate MiscellaneousApi;

pub fn main() {
    let name = ; // EnumerationNames
    let contains = contains_example; // String
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = MiscellaneousApi::Context::default();
    let result = client.enumGet(name, contains, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
EnumerationNames
Name of the enumeration type to retrieve values from
Required
Query parameters
Name Description
contains
String
Filter by substring match. Returns items containing this string (case-insensitive).
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

enumPut

Administrative endpoint to add or update values in a specified enumeration type. Replaces the entire set of values for the enumeration.


/api/v2/enumeration/{name}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/enumeration/{name}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MiscellaneousApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        EnumerationNames name = ; // EnumerationNames | Name of the enumeration type to update values for
        EnumPutRequest enumPutRequest = ; // EnumPutRequest | 

        try {
            apiInstance.enumPut(name, enumPutRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#enumPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final EnumerationNames name = new EnumerationNames(); // EnumerationNames | Name of the enumeration type to update values for
final EnumPutRequest enumPutRequest = new EnumPutRequest(); // EnumPutRequest | 

try {
    final result = await api_instance.enumPut(name, enumPutRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->enumPut: $e\n');
}

import org.openapitools.client.api.MiscellaneousApi;

public class MiscellaneousApiExample {
    public static void main(String[] args) {
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        EnumerationNames name = ; // EnumerationNames | Name of the enumeration type to update values for
        EnumPutRequest enumPutRequest = ; // EnumPutRequest | 

        try {
            apiInstance.enumPut(name, enumPutRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#enumPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
MiscellaneousApi *apiInstance = [[MiscellaneousApi alloc] init];
EnumerationNames *name = ; // Name of the enumeration type to update values for (default to null)
EnumPutRequest *enumPutRequest = ; // 

[apiInstance enumPutWith:name
    enumPutRequest:enumPutRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.MiscellaneousApi()
var name = ; // {EnumerationNames} Name of the enumeration type to update values for
var enumPutRequest = ; // {EnumPutRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.enumPut(name, enumPutRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class enumPutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MiscellaneousApi();
            var name = new EnumerationNames(); // EnumerationNames | Name of the enumeration type to update values for (default to null)
            var enumPutRequest = new EnumPutRequest(); // EnumPutRequest | 

            try {
                apiInstance.enumPut(name, enumPutRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling MiscellaneousApi.enumPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MiscellaneousApi();
$name = ; // EnumerationNames | Name of the enumeration type to update values for
$enumPutRequest = ; // EnumPutRequest | 

try {
    $api_instance->enumPut($name, $enumPutRequest);
} catch (Exception $e) {
    echo 'Exception when calling MiscellaneousApi->enumPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MiscellaneousApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MiscellaneousApi->new();
my $name = ; # EnumerationNames | Name of the enumeration type to update values for
my $enumPutRequest = WWW::OPenAPIClient::Object::EnumPutRequest->new(); # EnumPutRequest | 

eval {
    $api_instance->enumPut(name => $name, enumPutRequest => $enumPutRequest);
};
if ($@) {
    warn "Exception when calling MiscellaneousApi->enumPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MiscellaneousApi()
name =  # EnumerationNames | Name of the enumeration type to update values for (default to null)
enumPutRequest =  # EnumPutRequest | 

try:
    api_instance.enum_put(name, enumPutRequest)
except ApiException as e:
    print("Exception when calling MiscellaneousApi->enumPut: %s\n" % e)
extern crate MiscellaneousApi;

pub fn main() {
    let name = ; // EnumerationNames
    let enumPutRequest = ; // EnumPutRequest

    let mut context = MiscellaneousApi::Context::default();
    let result = client.enumPut(name, enumPutRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
EnumerationNames
Name of the enumeration type to update values for
Required
Body parameters
Name Description
enumPutRequest *

Array of string values to set for the enumeration type

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

gremienDeleteByParam

Administrative endpoint to delete committees matching the specified criteria. Removes all committees that match the filter parameters.


/api/v2/gremien

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/gremien?gr=gr_example&p=&wp=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MiscellaneousApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.

        try {
            apiInstance.gremienDeleteByParam(gr, p, wp);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#gremienDeleteByParam");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String gr = new String(); // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
final Parlament p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
final Integer wp = new Integer(); // Integer | Filter by electoral period number. Returns only items from the specified electoral period.

try {
    final result = await api_instance.gremienDeleteByParam(gr, p, wp);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->gremienDeleteByParam: $e\n');
}

import org.openapitools.client.api.MiscellaneousApi;

public class MiscellaneousApiExample {
    public static void main(String[] args) {
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.

        try {
            apiInstance.gremienDeleteByParam(gr, p, wp);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#gremienDeleteByParam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
MiscellaneousApi *apiInstance = [[MiscellaneousApi alloc] init];
String *gr = gr_example; // Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
Parlament *p = ; // Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
Integer *wp = 56; // Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)

[apiInstance gremienDeleteByParamWith:gr
    p:p
    wp:wp
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.MiscellaneousApi()
var opts = {
  'gr': gr_example, // {String} Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
  'p': , // {Parlament} Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
  'wp': 56 // {Integer} Filter by electoral period number. Returns only items from the specified electoral period.
};

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

namespace Example
{
    public class gremienDeleteByParamExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MiscellaneousApi();
            var gr = gr_example;  // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional)  (default to null)
            var p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional)  (default to null)
            var wp = 56;  // Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional)  (default to null)

            try {
                apiInstance.gremienDeleteByParam(gr, p, wp);
            } catch (Exception e) {
                Debug.Print("Exception when calling MiscellaneousApi.gremienDeleteByParam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MiscellaneousApi();
$gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
$p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
$wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.

try {
    $api_instance->gremienDeleteByParam($gr, $p, $wp);
} catch (Exception $e) {
    echo 'Exception when calling MiscellaneousApi->gremienDeleteByParam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MiscellaneousApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MiscellaneousApi->new();
my $gr = gr_example; # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
my $p = ; # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
my $wp = 56; # Integer | Filter by electoral period number. Returns only items from the specified electoral period.

eval {
    $api_instance->gremienDeleteByParam(gr => $gr, p => $p, wp => $wp);
};
if ($@) {
    warn "Exception when calling MiscellaneousApi->gremienDeleteByParam: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MiscellaneousApi()
gr = gr_example # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
p =  # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
wp = 56 # Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)

try:
    api_instance.gremien_delete_by_param(gr=gr, p=p, wp=wp)
except ApiException as e:
    print("Exception when calling MiscellaneousApi->gremienDeleteByParam: %s\n" % e)
extern crate MiscellaneousApi;

pub fn main() {
    let gr = gr_example; // String
    let p = ; // Parlament
    let wp = 56; // Integer

    let mut context = MiscellaneousApi::Context::default();
    let result = client.gremienDeleteByParam(gr, p, wp, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
gr
String
Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
p
Parlament
Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
wp
Integer
Filter by electoral period number. Returns only items from the specified electoral period.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

gremienGet

Retrieves a list of committees filtered by optional parameters. Returns committees matching the specified criteria from parliament bodies and electoral periods.


/api/v2/gremien

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/gremien?gr=gr_example&p=&wp=56&page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MiscellaneousApi;

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

public class MiscellaneousApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[gremium] result = apiInstance.gremienGet(gr, p, wp, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#gremienGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String gr = new String(); // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
final Parlament p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
final Integer wp = new Integer(); // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.gremienGet(gr, p, wp, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->gremienGet: $e\n');
}

import org.openapitools.client.api.MiscellaneousApi;

public class MiscellaneousApiExample {
    public static void main(String[] args) {
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[gremium] result = apiInstance.gremienGet(gr, p, wp, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#gremienGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
MiscellaneousApi *apiInstance = [[MiscellaneousApi alloc] init];
String *gr = gr_example; // Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
Parlament *p = ; // Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
Integer *wp = 56; // Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance gremienGetWith:gr
    p:p
    wp:wp
    page:page
    perPage:perPage
              completionHandler: ^(array[gremium] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.MiscellaneousApi()
var opts = {
  'gr': gr_example, // {String} Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
  'p': , // {Parlament} Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
  'wp': 56, // {Integer} Filter by electoral period number. Returns only items from the specified electoral period.
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

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

            // Create an instance of the API class
            var apiInstance = new MiscellaneousApi();
            var gr = gr_example;  // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional)  (default to null)
            var p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional)  (default to null)
            var wp = 56;  // Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array[gremium] result = apiInstance.gremienGet(gr, p, wp, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MiscellaneousApi.gremienGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MiscellaneousApi();
$gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
$p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
$wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->gremienGet($gr, $p, $wp, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MiscellaneousApi->gremienGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MiscellaneousApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MiscellaneousApi->new();
my $gr = gr_example; # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
my $p = ; # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
my $wp = 56; # Integer | Filter by electoral period number. Returns only items from the specified electoral period.
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->gremienGet(gr => $gr, p => $p, wp => $wp, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MiscellaneousApi->gremienGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.MiscellaneousApi()
gr = gr_example # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
p =  # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
wp = 56 # Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.gremien_get(gr=gr, p=p, wp=wp, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MiscellaneousApi->gremienGet: %s\n" % e)
extern crate MiscellaneousApi;

pub fn main() {
    let gr = gr_example; // String
    let p = ; // Parlament
    let wp = 56; // Integer
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = MiscellaneousApi::Context::default();
    let result = client.gremienGet(gr, p, wp, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
gr
String
Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
p
Parlament
Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
wp
Integer
Filter by electoral period number. Returns only items from the specified electoral period.
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

gremienPut

Administrative endpoint to add or update multiple committees at once. Creates new committees or replaces existing ones based on matching parliament, electoral period, and name.


/api/v2/gremien

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/gremien" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MiscellaneousApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        GremienPutRequest gremienPutRequest = ; // GremienPutRequest | 

        try {
            apiInstance.gremienPut(gremienPutRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#gremienPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final GremienPutRequest gremienPutRequest = new GremienPutRequest(); // GremienPutRequest | 

try {
    final result = await api_instance.gremienPut(gremienPutRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->gremienPut: $e\n');
}

import org.openapitools.client.api.MiscellaneousApi;

public class MiscellaneousApiExample {
    public static void main(String[] args) {
        MiscellaneousApi apiInstance = new MiscellaneousApi();
        GremienPutRequest gremienPutRequest = ; // GremienPutRequest | 

        try {
            apiInstance.gremienPut(gremienPutRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiscellaneousApi#gremienPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
MiscellaneousApi *apiInstance = [[MiscellaneousApi alloc] init];
GremienPutRequest *gremienPutRequest = ; // 

[apiInstance gremienPutWith:gremienPutRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.MiscellaneousApi()
var gremienPutRequest = ; // {GremienPutRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.gremienPut(gremienPutRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class gremienPutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new MiscellaneousApi();
            var gremienPutRequest = new GremienPutRequest(); // GremienPutRequest | 

            try {
                apiInstance.gremienPut(gremienPutRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling MiscellaneousApi.gremienPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\MiscellaneousApi();
$gremienPutRequest = ; // GremienPutRequest | 

try {
    $api_instance->gremienPut($gremienPutRequest);
} catch (Exception $e) {
    echo 'Exception when calling MiscellaneousApi->gremienPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::MiscellaneousApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::MiscellaneousApi->new();
my $gremienPutRequest = WWW::OPenAPIClient::Object::GremienPutRequest->new(); # GremienPutRequest | 

eval {
    $api_instance->gremienPut(gremienPutRequest => $gremienPutRequest);
};
if ($@) {
    warn "Exception when calling MiscellaneousApi->gremienPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.MiscellaneousApi()
gremienPutRequest =  # GremienPutRequest | 

try:
    api_instance.gremien_put(gremienPutRequest)
except ApiException as e:
    print("Exception when calling MiscellaneousApi->gremienPut: %s\n" % e)
extern crate MiscellaneousApi;

pub fn main() {
    let gremienPutRequest = ; // GremienPutRequest

    let mut context = MiscellaneousApi::Context::default();
    let result = client.gremienPut(gremienPutRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
gremienPutRequest *

Committees (Gremien) to update in-place. All objects in 'objects' are inserted if not present. All objects in the 'replaced_by' array are removed if found and references to them are pointed to the objects in the first list as indicated.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Sitzung

kalDateGet

Retrieves a list of parliamentary sessions for a specific date and parliament. Provides all sessions scheduled for the given day in the specified parliamentary body.


/api/v2/kalender/{parlament}/{datum}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/kalender/{parlament}/{datum}?page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SitzungApi;

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

public class SitzungApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SitzungApi apiInstance = new SitzungApi();
        Parlament parlament = ; // Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
        date datum = 2013-10-20; // date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[sitzung] result = apiInstance.kalDateGet(parlament, datum, ifModifiedSince, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#kalDateGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Parlament parlament = new Parlament(); // Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
final date datum = new date(); // date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
final Date ifModifiedSince = new Date(); // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.kalDateGet(parlament, datum, ifModifiedSince, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->kalDateGet: $e\n');
}

import org.openapitools.client.api.SitzungApi;

public class SitzungApiExample {
    public static void main(String[] args) {
        SitzungApi apiInstance = new SitzungApi();
        Parlament parlament = ; // Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
        date datum = 2013-10-20; // date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[sitzung] result = apiInstance.kalDateGet(parlament, datum, ifModifiedSince, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#kalDateGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SitzungApi *apiInstance = [[SitzungApi alloc] init];
Parlament *parlament = ; // Code of the parliament to query sessions for (e.g., 'BT' for Bundestag) (default to null)
date *datum = 2013-10-20; // Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD) (default to null)
Date *ifModifiedSince = 2024-01-01T00:00Z; // Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance kalDateGetWith:parlament
    datum:datum
    ifModifiedSince:ifModifiedSince
    page:page
    perPage:perPage
              completionHandler: ^(array[sitzung] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.SitzungApi()
var parlament = ; // {Parlament} Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
var datum = 2013-10-20; // {date} Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
var opts = {
  'ifModifiedSince': 2024-01-01T00:00Z, // {Date} Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

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

            // Create an instance of the API class
            var apiInstance = new SitzungApi();
            var parlament = new Parlament(); // Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag) (default to null)
            var datum = 2013-10-20;  // date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD) (default to null)
            var ifModifiedSince = 2024-01-01T00:00Z;  // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array[sitzung] result = apiInstance.kalDateGet(parlament, datum, ifModifiedSince, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SitzungApi.kalDateGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SitzungApi();
$parlament = ; // Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
$datum = 2013-10-20; // date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
$ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->kalDateGet($parlament, $datum, $ifModifiedSince, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SitzungApi->kalDateGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SitzungApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SitzungApi->new();
my $parlament = ; # Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
my $datum = 2013-10-20; # date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
my $ifModifiedSince = 2024-01-01T00:00Z; # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->kalDateGet(parlament => $parlament, datum => $datum, ifModifiedSince => $ifModifiedSince, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SitzungApi->kalDateGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SitzungApi()
parlament =  # Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag) (default to null)
datum = 2013-10-20 # date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD) (default to null)
ifModifiedSince = 2024-01-01T00:00Z # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.kal_date_get(parlament, datum, ifModifiedSince=ifModifiedSince, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SitzungApi->kalDateGet: %s\n" % e)
extern crate SitzungApi;

pub fn main() {
    let parlament = ; // Parlament
    let datum = 2013-10-20; // date
    let ifModifiedSince = 2024-01-01T00:00Z; // Date
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = SitzungApi::Context::default();
    let result = client.kalDateGet(parlament, datum, ifModifiedSince, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
parlament*
Parlament
Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
Required
datum*
date (date)
Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
Required
Header parameters
Name Description
If-Modified-Since
Date (date-time)
Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
Query parameters
Name Description
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

kalDatePut

Collector interface for adding or updating sessions for a specific date and parliament. Completely replaces all sessions for the given date, with restrictions based on how far in the past the date is. Admin API keys can override the time restriction.


/api/v2/kalender/{parlament}/{datum}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/kalender/{parlament}/{datum}" \
 -d '{
  "api_id" : "b1a2c3d4-e5f6-7890-fedc-1234567890ab",
  "titel" : "143. Sitzung des Deutschen Bundestages",
  "termin" : "2024-05-20T09:00:00+02:00",
  "gremium" : {
    "parlament" : "BT",
    "wahlperiode" : 20,
    "name" : "plenum"
  },
  "nummer" : 143,
  "public" : true,
  "link" : "https://www.bundestag.de/sitzung/20240520",
  "tops" : [ {
    "nummer" : 1,
    "titel" : "Eröffnung der Sitzung"
  }, {
    "nummer" : 3,
    "titel" : "Erste Beratung des von den Fraktionen SPD, BÜNDNIS 90/DIE GRÜNEN und FDP eingebrachten Entwurfs eines Gesetzes zur Änderung des Bundeswahlgesetzes",
    "vorgang_id" : [ "123e4567-e89b-12d3-a456-426614174000" ],
    "dokumente" : [ ]
  } ],
  "dokumente" : [ {
    "api_id" : "c1d2e3f4-a5b6-7890-cdef-1234567890gh",
    "typ" : "tops",
    "titel" : "Tagesordnung der 143. Sitzung des Deutschen Bundestages",
    "volltext" : "TOP 1: Eröffnung der Sitzung\nTOP 2: Fragestunde\nTOP 3: Erste Beratung des Gesetzentwurfs zur Änderung des Bundeswahlgesetzes\n...",
    "hash" : "a1b2c3d4e5f6g7h8i9j0",
    "zp_modifiziert" : "2024-05-15T14:30:00+02:00",
    "zp_referenz" : "2024-05-20T09:00:00+02:00",
    "link" : "https://www.bundestag.de/tagesordnung/20240520",
    "autoren" : [ {
      "organisation" : "Deutscher Bundestag"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SitzungApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SitzungApi apiInstance = new SitzungApi();
        UUID xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
        Parlament parlament = ; // Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
        date datum = 2013-10-20; // date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
        array[sitzung] sitzung = ; // array[sitzung] | 

        try {
            apiInstance.kalDatePut(xScraperId, parlament, datum, sitzung);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#kalDatePut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID xScraperId = new UUID(); // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
final Parlament parlament = new Parlament(); // Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
final date datum = new date(); // date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
final array[sitzung] sitzung = new array[sitzung](); // array[sitzung] | 

try {
    final result = await api_instance.kalDatePut(xScraperId, parlament, datum, sitzung);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->kalDatePut: $e\n');
}

import org.openapitools.client.api.SitzungApi;

public class SitzungApiExample {
    public static void main(String[] args) {
        SitzungApi apiInstance = new SitzungApi();
        UUID xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
        Parlament parlament = ; // Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
        date datum = 2013-10-20; // date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
        array[sitzung] sitzung = ; // array[sitzung] | 

        try {
            apiInstance.kalDatePut(xScraperId, parlament, datum, sitzung);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#kalDatePut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
SitzungApi *apiInstance = [[SitzungApi alloc] init];
UUID *xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The Scraper ID to use for the request. Used to identify the scraper that submitted the request. (default to null)
Parlament *parlament = ; // Code of the parliament to add sessions for (e.g., 'BT' for Bundestag) (default to null)
date *datum = 2013-10-20; // Date to add sessions for, in ISO 8601 format (YYYY-MM-DD) (default to null)
array[sitzung] *sitzung = ; // 

[apiInstance kalDatePutWith:xScraperId
    parlament:parlament
    datum:datum
    sitzung:sitzung
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.SitzungApi()
var xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
var parlament = ; // {Parlament} Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
var datum = 2013-10-20; // {date} Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
var sitzung = ; // {array[sitzung]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.kalDatePut(xScraperId, parlament, datum, sitzung, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class kalDatePutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new SitzungApi();
            var xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request. (default to null)
            var parlament = new Parlament(); // Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag) (default to null)
            var datum = 2013-10-20;  // date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD) (default to null)
            var sitzung = new array[sitzung](); // array[sitzung] | 

            try {
                apiInstance.kalDatePut(xScraperId, parlament, datum, sitzung);
            } catch (Exception e) {
                Debug.Print("Exception when calling SitzungApi.kalDatePut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SitzungApi();
$xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
$parlament = ; // Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
$datum = 2013-10-20; // date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
$sitzung = ; // array[sitzung] | 

try {
    $api_instance->kalDatePut($xScraperId, $parlament, $datum, $sitzung);
} catch (Exception $e) {
    echo 'Exception when calling SitzungApi->kalDatePut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SitzungApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SitzungApi->new();
my $xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
my $parlament = ; # Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
my $datum = 2013-10-20; # date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
my $sitzung = [WWW::OPenAPIClient::Object::array[sitzung]->new()]; # array[sitzung] | 

eval {
    $api_instance->kalDatePut(xScraperId => $xScraperId, parlament => $parlament, datum => $datum, sitzung => $sitzung);
};
if ($@) {
    warn "Exception when calling SitzungApi->kalDatePut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SitzungApi()
xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request. (default to null)
parlament =  # Parlament | Code of the parliament to add sessions for (e.g., 'BT' for Bundestag) (default to null)
datum = 2013-10-20 # date | Date to add sessions for, in ISO 8601 format (YYYY-MM-DD) (default to null)
sitzung =  # array[sitzung] | 

try:
    api_instance.kal_date_put(xScraperId, parlament, datum, sitzung)
except ApiException as e:
    print("Exception when calling SitzungApi->kalDatePut: %s\n" % e)
extern crate SitzungApi;

pub fn main() {
    let xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let parlament = ; // Parlament
    let datum = 2013-10-20; // date
    let sitzung = ; // array[sitzung]

    let mut context = SitzungApi::Context::default();
    let result = client.kalDatePut(xScraperId, parlament, datum, sitzung, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
parlament*
Parlament
Code of the parliament to add sessions for (e.g., 'BT' for Bundestag)
Required
datum*
date (date)
Date to add sessions for, in ISO 8601 format (YYYY-MM-DD)
Required
Header parameters
Name Description
X-Scraper-Id*
UUID (uuid)
The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
Required
Body parameters
Name Description
sitzung *

Array of parliamentary sessions to set for the specified date

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

kalGet

Retrieves a filterable list of parliamentary sessions for calendar display. Returns up to 64 sessions per request, which can be filtered by various criteria including year, month, day, parliament, and committee.


/api/v2/kalender

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/kalender?since=2024-01-01T00:00Z&until=2024-12-31T23:59:59Z&p=&wp=56&gr=gr_example&y=56&m=56&dom=56&page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SitzungApi;

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

public class SitzungApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SitzungApi apiInstance = new SitzungApi();
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        Integer y = 56; // Integer | The year to filter results by (1945 or later)
        Integer m = 56; // Integer | The month to filter results by (1-12)
        Integer dom = 56; // Integer | The day of month to filter results by (1-31)
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[sitzung] result = apiInstance.kalGet(ifModifiedSince, since, until, p, wp, gr, y, m, dom, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#kalGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Date ifModifiedSince = new Date(); // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
final Date since = new Date(); // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
final Date until = new Date(); // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
final Parlament p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
final Integer wp = new Integer(); // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
final String gr = new String(); // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
final Integer y = new Integer(); // Integer | The year to filter results by (1945 or later)
final Integer m = new Integer(); // Integer | The month to filter results by (1-12)
final Integer dom = new Integer(); // Integer | The day of month to filter results by (1-31)
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.kalGet(ifModifiedSince, since, until, p, wp, gr, y, m, dom, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->kalGet: $e\n');
}

import org.openapitools.client.api.SitzungApi;

public class SitzungApiExample {
    public static void main(String[] args) {
        SitzungApi apiInstance = new SitzungApi();
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        Integer y = 56; // Integer | The year to filter results by (1945 or later)
        Integer m = 56; // Integer | The month to filter results by (1-12)
        Integer dom = 56; // Integer | The day of month to filter results by (1-31)
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[sitzung] result = apiInstance.kalGet(ifModifiedSince, since, until, p, wp, gr, y, m, dom, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#kalGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SitzungApi *apiInstance = [[SitzungApi alloc] init];
Date *ifModifiedSince = 2024-01-01T00:00Z; // Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
Date *since = 2024-01-01T00:00Z; // Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
Date *until = 2024-12-31T23:59:59Z; // Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
Parlament *p = ; // Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
Integer *wp = 56; // Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
String *gr = gr_example; // Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
Integer *y = 56; // The year to filter results by (1945 or later) (optional) (default to null)
Integer *m = 56; // The month to filter results by (1-12) (optional) (default to null)
Integer *dom = 56; // The day of month to filter results by (1-31) (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance kalGetWith:ifModifiedSince
    since:since
    until:until
    p:p
    wp:wp
    gr:gr
    y:y
    m:m
    dom:dom
    page:page
    perPage:perPage
              completionHandler: ^(array[sitzung] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.SitzungApi()
var opts = {
  'ifModifiedSince': 2024-01-01T00:00Z, // {Date} Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
  'since': 2024-01-01T00:00Z, // {Date} Filter results to include only items updated on or after this timestamp (inclusive lower bound)
  'until': 2024-12-31T23:59:59Z, // {Date} Filter results to include only items updated on or before this timestamp (inclusive upper bound)
  'p': , // {Parlament} Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
  'wp': 56, // {Integer} Filter by electoral period number. Returns only items from the specified electoral period.
  'gr': gr_example, // {String} Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
  'y': 56, // {Integer} The year to filter results by (1945 or later)
  'm': 56, // {Integer} The month to filter results by (1-12)
  'dom': 56, // {Integer} The day of month to filter results by (1-31)
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

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

            // Create an instance of the API class
            var apiInstance = new SitzungApi();
            var ifModifiedSince = 2024-01-01T00:00Z;  // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional)  (default to null)
            var since = 2024-01-01T00:00Z;  // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional)  (default to null)
            var until = 2024-12-31T23:59:59Z;  // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional)  (default to null)
            var p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional)  (default to null)
            var wp = 56;  // Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional)  (default to null)
            var gr = gr_example;  // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional)  (default to null)
            var y = 56;  // Integer | The year to filter results by (1945 or later) (optional)  (default to null)
            var m = 56;  // Integer | The month to filter results by (1-12) (optional)  (default to null)
            var dom = 56;  // Integer | The day of month to filter results by (1-31) (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array[sitzung] result = apiInstance.kalGet(ifModifiedSince, since, until, p, wp, gr, y, m, dom, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SitzungApi.kalGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SitzungApi();
$ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
$since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
$until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
$p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
$wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
$gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
$y = 56; // Integer | The year to filter results by (1945 or later)
$m = 56; // Integer | The month to filter results by (1-12)
$dom = 56; // Integer | The day of month to filter results by (1-31)
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->kalGet($ifModifiedSince, $since, $until, $p, $wp, $gr, $y, $m, $dom, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SitzungApi->kalGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SitzungApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SitzungApi->new();
my $ifModifiedSince = 2024-01-01T00:00Z; # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
my $since = 2024-01-01T00:00Z; # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
my $until = 2024-12-31T23:59:59Z; # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
my $p = ; # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
my $wp = 56; # Integer | Filter by electoral period number. Returns only items from the specified electoral period.
my $gr = gr_example; # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
my $y = 56; # Integer | The year to filter results by (1945 or later)
my $m = 56; # Integer | The month to filter results by (1-12)
my $dom = 56; # Integer | The day of month to filter results by (1-31)
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->kalGet(ifModifiedSince => $ifModifiedSince, since => $since, until => $until, p => $p, wp => $wp, gr => $gr, y => $y, m => $m, dom => $dom, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SitzungApi->kalGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SitzungApi()
ifModifiedSince = 2024-01-01T00:00Z # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
since = 2024-01-01T00:00Z # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
until = 2024-12-31T23:59:59Z # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
p =  # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
wp = 56 # Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
gr = gr_example # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
y = 56 # Integer | The year to filter results by (1945 or later) (optional) (default to null)
m = 56 # Integer | The month to filter results by (1-12) (optional) (default to null)
dom = 56 # Integer | The day of month to filter results by (1-31) (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.kal_get(ifModifiedSince=ifModifiedSince, since=since, until=until, p=p, wp=wp, gr=gr, y=y, m=m, dom=dom, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SitzungApi->kalGet: %s\n" % e)
extern crate SitzungApi;

pub fn main() {
    let ifModifiedSince = 2024-01-01T00:00Z; // Date
    let since = 2024-01-01T00:00Z; // Date
    let until = 2024-12-31T23:59:59Z; // Date
    let p = ; // Parlament
    let wp = 56; // Integer
    let gr = gr_example; // String
    let y = 56; // Integer
    let m = 56; // Integer
    let dom = 56; // Integer
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = SitzungApi::Context::default();
    let result = client.kalGet(ifModifiedSince, since, until, p, wp, gr, y, m, dom, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
If-Modified-Since
Date (date-time)
Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
Query parameters
Name Description
since
Date (date-time)
Filter results to include only items updated on or after this timestamp (inclusive lower bound)
until
Date (date-time)
Filter results to include only items updated on or before this timestamp (inclusive upper bound)
p
Parlament
Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
wp
Integer
Filter by electoral period number. Returns only items from the specified electoral period.
gr
String
Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
y
Integer
The year to filter results by (1945 or later)
m
Integer
The month to filter results by (1-12)
dom
Integer
The day of month to filter results by (1-31)
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

sGet

Retrieves a filterable list of parliamentary sessions. Returns up to 64 sessions per request, which can be filtered by various criteria including time frame, parliament, and electoral period.


/api/v2/sitzung

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/sitzung?since=2024-01-01T00:00Z&until=2024-12-31T23:59:59Z&page=56&per_page=56&p=&wp=56&gr=gr_example&vgid=38400000-8cf0-11bd-b23e-10b96e4ef00d&vgtyp="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SitzungApi;

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

public class SitzungApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SitzungApi apiInstance = new SitzungApi();
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        UUID vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Filter by associated legislative process ID. Returns only items related to the specified process.
        Vorgangstyp vgtyp = ; // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.

        try {
            array[sitzung] result = apiInstance.sGet(ifModifiedSince, since, until, page, perPage, p, wp, gr, vgid, vgtyp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#sGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Date ifModifiedSince = new Date(); // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
final Date since = new Date(); // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
final Date until = new Date(); // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.
final Parlament p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
final Integer wp = new Integer(); // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
final String gr = new String(); // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
final UUID vgid = new UUID(); // UUID | Filter by associated legislative process ID. Returns only items related to the specified process.
final Vorgangstyp vgtyp = new Vorgangstyp(); // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.

try {
    final result = await api_instance.sGet(ifModifiedSince, since, until, page, perPage, p, wp, gr, vgid, vgtyp);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sGet: $e\n');
}

import org.openapitools.client.api.SitzungApi;

public class SitzungApiExample {
    public static void main(String[] args) {
        SitzungApi apiInstance = new SitzungApi();
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        UUID vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Filter by associated legislative process ID. Returns only items related to the specified process.
        Vorgangstyp vgtyp = ; // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.

        try {
            array[sitzung] result = apiInstance.sGet(ifModifiedSince, since, until, page, perPage, p, wp, gr, vgid, vgtyp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#sGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SitzungApi *apiInstance = [[SitzungApi alloc] init];
Date *ifModifiedSince = 2024-01-01T00:00Z; // Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
Date *since = 2024-01-01T00:00Z; // Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
Date *until = 2024-12-31T23:59:59Z; // Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)
Parlament *p = ; // Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
Integer *wp = 56; // Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
String *gr = gr_example; // Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
UUID *vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Filter by associated legislative process ID. Returns only items related to the specified process. (optional) (default to null)
Vorgangstyp *vgtyp = ; // Filter by legislative process type. Returns only items of the specified process type. (optional) (default to null)

[apiInstance sGetWith:ifModifiedSince
    since:since
    until:until
    page:page
    perPage:perPage
    p:p
    wp:wp
    gr:gr
    vgid:vgid
    vgtyp:vgtyp
              completionHandler: ^(array[sitzung] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.SitzungApi()
var opts = {
  'ifModifiedSince': 2024-01-01T00:00Z, // {Date} Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
  'since': 2024-01-01T00:00Z, // {Date} Filter results to include only items updated on or after this timestamp (inclusive lower bound)
  'until': 2024-12-31T23:59:59Z, // {Date} Filter results to include only items updated on or before this timestamp (inclusive upper bound)
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56, // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
  'p': , // {Parlament} Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
  'wp': 56, // {Integer} Filter by electoral period number. Returns only items from the specified electoral period.
  'gr': gr_example, // {String} Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
  'vgid': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} Filter by associated legislative process ID. Returns only items related to the specified process.
  'vgtyp':  // {Vorgangstyp} Filter by legislative process type. Returns only items of the specified process type.
};

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

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

            // Create an instance of the API class
            var apiInstance = new SitzungApi();
            var ifModifiedSince = 2024-01-01T00:00Z;  // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional)  (default to null)
            var since = 2024-01-01T00:00Z;  // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional)  (default to null)
            var until = 2024-12-31T23:59:59Z;  // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)
            var p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional)  (default to null)
            var wp = 56;  // Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional)  (default to null)
            var gr = gr_example;  // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional)  (default to null)
            var vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Filter by associated legislative process ID. Returns only items related to the specified process. (optional)  (default to null)
            var vgtyp = new Vorgangstyp(); // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type. (optional)  (default to null)

            try {
                array[sitzung] result = apiInstance.sGet(ifModifiedSince, since, until, page, perPage, p, wp, gr, vgid, vgtyp);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SitzungApi.sGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SitzungApi();
$ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
$since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
$until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.
$p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
$wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
$gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
$vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Filter by associated legislative process ID. Returns only items related to the specified process.
$vgtyp = ; // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.

try {
    $result = $api_instance->sGet($ifModifiedSince, $since, $until, $page, $perPage, $p, $wp, $gr, $vgid, $vgtyp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SitzungApi->sGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SitzungApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SitzungApi->new();
my $ifModifiedSince = 2024-01-01T00:00Z; # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
my $since = 2024-01-01T00:00Z; # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
my $until = 2024-12-31T23:59:59Z; # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.
my $p = ; # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
my $wp = 56; # Integer | Filter by electoral period number. Returns only items from the specified electoral period.
my $gr = gr_example; # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
my $vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Filter by associated legislative process ID. Returns only items related to the specified process.
my $vgtyp = ; # Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.

eval {
    my $result = $api_instance->sGet(ifModifiedSince => $ifModifiedSince, since => $since, until => $until, page => $page, perPage => $perPage, p => $p, wp => $wp, gr => $gr, vgid => $vgid, vgtyp => $vgtyp);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SitzungApi->sGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SitzungApi()
ifModifiedSince = 2024-01-01T00:00Z # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
since = 2024-01-01T00:00Z # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
until = 2024-12-31T23:59:59Z # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)
p =  # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
wp = 56 # Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
gr = gr_example # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Filter by associated legislative process ID. Returns only items related to the specified process. (optional) (default to null)
vgtyp =  # Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type. (optional) (default to null)

try:
    api_response = api_instance.s_get(ifModifiedSince=ifModifiedSince, since=since, until=until, page=page, perPage=perPage, p=p, wp=wp, gr=gr, vgid=vgid, vgtyp=vgtyp)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SitzungApi->sGet: %s\n" % e)
extern crate SitzungApi;

pub fn main() {
    let ifModifiedSince = 2024-01-01T00:00Z; // Date
    let since = 2024-01-01T00:00Z; // Date
    let until = 2024-12-31T23:59:59Z; // Date
    let page = 56; // Integer
    let perPage = 56; // Integer
    let p = ; // Parlament
    let wp = 56; // Integer
    let gr = gr_example; // String
    let vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let vgtyp = ; // Vorgangstyp

    let mut context = SitzungApi::Context::default();
    let result = client.sGet(ifModifiedSince, since, until, page, perPage, p, wp, gr, vgid, vgtyp, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
If-Modified-Since
Date (date-time)
Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
Query parameters
Name Description
since
Date (date-time)
Filter results to include only items updated on or after this timestamp (inclusive lower bound)
until
Date (date-time)
Filter results to include only items updated on or before this timestamp (inclusive upper bound)
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.
p
Parlament
Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
wp
Integer
Filter by electoral period number. Returns only items from the specified electoral period.
gr
String
Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
vgid
UUID (uuid)
Filter by associated legislative process ID. Returns only items related to the specified process.
vgtyp
Vorgangstyp
Filter by legislative process type. Returns only items of the specified process type.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

sGetById

Retrieves detailed information about a specific parliamentary session by its unique identifier. Returns complete session data including agenda items, documents, and metadata. If called by admin or higher, this returns a list of last scrapers/collectors touching the object


/api/v2/sitzung/{sid}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/sitzung/{sid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SitzungApi;

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

public class SitzungApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SitzungApi apiInstance = new SitzungApi();
        UUID sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to retrieve
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

        try {
            sitzung result = apiInstance.sGetById(sid, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#sGetById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID sid = new UUID(); // UUID | Unique identifier (UUID) of the session to retrieve
final Date ifModifiedSince = new Date(); // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

try {
    final result = await api_instance.sGetById(sid, ifModifiedSince);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sGetById: $e\n');
}

import org.openapitools.client.api.SitzungApi;

public class SitzungApiExample {
    public static void main(String[] args) {
        SitzungApi apiInstance = new SitzungApi();
        UUID sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to retrieve
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

        try {
            sitzung result = apiInstance.sGetById(sid, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#sGetById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SitzungApi *apiInstance = [[SitzungApi alloc] init];
UUID *sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the session to retrieve (default to null)
Date *ifModifiedSince = 2024-01-01T00:00Z; // Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)

[apiInstance sGetByIdWith:sid
    ifModifiedSince:ifModifiedSince
              completionHandler: ^(sitzung output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.SitzungApi()
var sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the session to retrieve
var opts = {
  'ifModifiedSince': 2024-01-01T00:00Z // {Date} Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
};

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

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

            // Create an instance of the API class
            var apiInstance = new SitzungApi();
            var sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the session to retrieve (default to null)
            var ifModifiedSince = 2024-01-01T00:00Z;  // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional)  (default to null)

            try {
                sitzung result = apiInstance.sGetById(sid, ifModifiedSince);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SitzungApi.sGetById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SitzungApi();
$sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to retrieve
$ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

try {
    $result = $api_instance->sGetById($sid, $ifModifiedSince);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SitzungApi->sGetById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SitzungApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SitzungApi->new();
my $sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the session to retrieve
my $ifModifiedSince = 2024-01-01T00:00Z; # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

eval {
    my $result = $api_instance->sGetById(sid => $sid, ifModifiedSince => $ifModifiedSince);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SitzungApi->sGetById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.SitzungApi()
sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the session to retrieve (default to null)
ifModifiedSince = 2024-01-01T00:00Z # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)

try:
    api_response = api_instance.s_get_by_id(sid, ifModifiedSince=ifModifiedSince)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SitzungApi->sGetById: %s\n" % e)
extern crate SitzungApi;

pub fn main() {
    let sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let ifModifiedSince = 2024-01-01T00:00Z; // Date

    let mut context = SitzungApi::Context::default();
    let result = client.sGetById(sid, ifModifiedSince, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
sid*
UUID (uuid)
Unique identifier (UUID) of the session to retrieve
Required
Header parameters
Name Description
If-Modified-Since
Date (date-time)
Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

sidPut

Administrative endpoint to directly set or replace a parliamentary session without merging or matching. Replaces the entire session data if it exists, or creates a new one if it doesn't.


/api/v2/sitzung/{sid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/sitzung/{sid}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SitzungApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SitzungApi apiInstance = new SitzungApi();
        UUID sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to create or update
        Sitzung sitzung = ; // Sitzung | 

        try {
            apiInstance.sidPut(sid, sitzung);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#sidPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID sid = new UUID(); // UUID | Unique identifier (UUID) of the session to create or update
final Sitzung sitzung = new Sitzung(); // Sitzung | 

try {
    final result = await api_instance.sidPut(sid, sitzung);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sidPut: $e\n');
}

import org.openapitools.client.api.SitzungApi;

public class SitzungApiExample {
    public static void main(String[] args) {
        SitzungApi apiInstance = new SitzungApi();
        UUID sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to create or update
        Sitzung sitzung = ; // Sitzung | 

        try {
            apiInstance.sidPut(sid, sitzung);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#sidPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
SitzungApi *apiInstance = [[SitzungApi alloc] init];
UUID *sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the session to create or update (default to null)
Sitzung *sitzung = ; // 

[apiInstance sidPutWith:sid
    sitzung:sitzung
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.SitzungApi()
var sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the session to create or update
var sitzung = ; // {Sitzung} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.sidPut(sid, sitzung, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class sidPutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new SitzungApi();
            var sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the session to create or update (default to null)
            var sitzung = new Sitzung(); // Sitzung | 

            try {
                apiInstance.sidPut(sid, sitzung);
            } catch (Exception e) {
                Debug.Print("Exception when calling SitzungApi.sidPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SitzungApi();
$sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to create or update
$sitzung = ; // Sitzung | 

try {
    $api_instance->sidPut($sid, $sitzung);
} catch (Exception $e) {
    echo 'Exception when calling SitzungApi->sidPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SitzungApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SitzungApi->new();
my $sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the session to create or update
my $sitzung = WWW::OPenAPIClient::Object::Sitzung->new(); # Sitzung | 

eval {
    $api_instance->sidPut(sid => $sid, sitzung => $sitzung);
};
if ($@) {
    warn "Exception when calling SitzungApi->sidPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SitzungApi()
sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the session to create or update (default to null)
sitzung =  # Sitzung | 

try:
    api_instance.sid_put(sid, sitzung)
except ApiException as e:
    print("Exception when calling SitzungApi->sidPut: %s\n" % e)
extern crate SitzungApi;

pub fn main() {
    let sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let sitzung = ; // Sitzung

    let mut context = SitzungApi::Context::default();
    let result = client.sidPut(sid, sitzung, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
sid*
UUID (uuid)
Unique identifier (UUID) of the session to create or update
Required
Body parameters
Name Description
sitzung *

Complete representation of the parliamentary session to create or update

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

sitzungDelete

Administrative endpoint to completely remove a parliamentary session from the system. This operation cannot be undone.


/api/v2/sitzung/{sid}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/sitzung/{sid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SitzungApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SitzungApi apiInstance = new SitzungApi();
        UUID sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to delete

        try {
            apiInstance.sitzungDelete(sid);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#sitzungDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID sid = new UUID(); // UUID | Unique identifier (UUID) of the session to delete

try {
    final result = await api_instance.sitzungDelete(sid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sitzungDelete: $e\n');
}

import org.openapitools.client.api.SitzungApi;

public class SitzungApiExample {
    public static void main(String[] args) {
        SitzungApi apiInstance = new SitzungApi();
        UUID sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to delete

        try {
            apiInstance.sitzungDelete(sid);
        } catch (ApiException e) {
            System.err.println("Exception when calling SitzungApi#sitzungDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
SitzungApi *apiInstance = [[SitzungApi alloc] init];
UUID *sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the session to delete (default to null)

[apiInstance sitzungDeleteWith:sid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.SitzungApi()
var sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the session to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.sitzungDelete(sid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class sitzungDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new SitzungApi();
            var sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the session to delete (default to null)

            try {
                apiInstance.sitzungDelete(sid);
            } catch (Exception e) {
                Debug.Print("Exception when calling SitzungApi.sitzungDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SitzungApi();
$sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to delete

try {
    $api_instance->sitzungDelete($sid);
} catch (Exception $e) {
    echo 'Exception when calling SitzungApi->sitzungDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SitzungApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SitzungApi->new();
my $sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the session to delete

eval {
    $api_instance->sitzungDelete(sid => $sid);
};
if ($@) {
    warn "Exception when calling SitzungApi->sitzungDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SitzungApi()
sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the session to delete (default to null)

try:
    api_instance.sitzung_delete(sid)
except ApiException as e:
    print("Exception when calling SitzungApi->sitzungDelete: %s\n" % e)
extern crate SitzungApi;

pub fn main() {
    let sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = SitzungApi::Context::default();
    let result = client.sitzungDelete(sid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
sid*
UUID (uuid)
Unique identifier (UUID) of the session to delete
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Unauthorisiert

autorenGet

Retrieves a list of authors filtered by optional parameters. Returns authors matching the specified criteria including name fragments, professional field, and organization.


/api/v2/autoren

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/autoren?person=person_example&fach=fach_example&org=org_example&page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnauthorisiertApi;

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

public class UnauthorisiertApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        String person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
        String fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
        String org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[autor] result = apiInstance.autorenGet(person, fach, org, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#autorenGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String person = new String(); // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
final String fach = new String(); // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
final String org = new String(); // String | Filter by author organization. Returns items where an author belongs to the specified organization.
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.autorenGet(person, fach, org, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->autorenGet: $e\n');
}

import org.openapitools.client.api.UnauthorisiertApi;

public class UnauthorisiertApiExample {
    public static void main(String[] args) {
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        String person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
        String fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
        String org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[autor] result = apiInstance.autorenGet(person, fach, org, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#autorenGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnauthorisiertApi *apiInstance = [[UnauthorisiertApi alloc] init];
String *person = person_example; // Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional) (default to null)
String *fach = fach_example; // Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional) (default to null)
String *org = org_example; // Filter by author organization. Returns items where an author belongs to the specified organization. (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance autorenGetWith:person
    fach:fach
    org:org
    page:page
    perPage:perPage
              completionHandler: ^(array[autor] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.UnauthorisiertApi()
var opts = {
  'person': person_example, // {String} Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
  'fach': fach_example, // {String} Filter by author's professional field. Returns items where an author has the specified professional expertise.
  'org': org_example, // {String} Filter by author organization. Returns items where an author belongs to the specified organization.
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UnauthorisiertApi();
            var person = person_example;  // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional)  (default to null)
            var fach = fach_example;  // String | Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional)  (default to null)
            var org = org_example;  // String | Filter by author organization. Returns items where an author belongs to the specified organization. (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array[autor] result = apiInstance.autorenGet(person, fach, org, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnauthorisiertApi.autorenGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnauthorisiertApi();
$person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
$fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
$org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->autorenGet($person, $fach, $org, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnauthorisiertApi->autorenGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnauthorisiertApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnauthorisiertApi->new();
my $person = person_example; # String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
my $fach = fach_example; # String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
my $org = org_example; # String | Filter by author organization. Returns items where an author belongs to the specified organization.
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->autorenGet(person => $person, fach => $fach, org => $org, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnauthorisiertApi->autorenGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UnauthorisiertApi()
person = person_example # String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional) (default to null)
fach = fach_example # String | Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional) (default to null)
org = org_example # String | Filter by author organization. Returns items where an author belongs to the specified organization. (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.autoren_get(person=person, fach=fach, org=org, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnauthorisiertApi->autorenGet: %s\n" % e)
extern crate UnauthorisiertApi;

pub fn main() {
    let person = person_example; // String
    let fach = fach_example; // String
    let org = org_example; // String
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = UnauthorisiertApi::Context::default();
    let result = client.autorenGet(person, fach, org, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
person
String
Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
fach
String
Filter by author's professional field. Returns items where an author has the specified professional expertise.
org
String
Filter by author organization. Returns items where an author belongs to the specified organization.
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

dokumentGetById

Retrieves a specific document by its unique identifier. Returns complete document data including title, full text, metadata, and author information. If called by admin or higher, this returns a list of last scrapers/collectors touching the object


/api/v2/dokument/{api_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/dokument/{api_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnauthorisiertApi;

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

public class UnauthorisiertApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        UUID apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the document to retrieve

        try {
            dokument result = apiInstance.dokumentGetById(apiId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#dokumentGetById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID apiId = new UUID(); // UUID | Unique identifier (UUID) of the document to retrieve

try {
    final result = await api_instance.dokumentGetById(apiId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dokumentGetById: $e\n');
}

import org.openapitools.client.api.UnauthorisiertApi;

public class UnauthorisiertApiExample {
    public static void main(String[] args) {
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        UUID apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the document to retrieve

        try {
            dokument result = apiInstance.dokumentGetById(apiId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#dokumentGetById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnauthorisiertApi *apiInstance = [[UnauthorisiertApi alloc] init];
UUID *apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the document to retrieve (default to null)

[apiInstance dokumentGetByIdWith:apiId
              completionHandler: ^(dokument output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.UnauthorisiertApi()
var apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the document to retrieve

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

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

            // Create an instance of the API class
            var apiInstance = new UnauthorisiertApi();
            var apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the document to retrieve (default to null)

            try {
                dokument result = apiInstance.dokumentGetById(apiId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnauthorisiertApi.dokumentGetById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnauthorisiertApi();
$apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the document to retrieve

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnauthorisiertApi->new();
my $apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the document to retrieve

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

# Create an instance of the API class
api_instance = openapi_client.UnauthorisiertApi()
apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the document to retrieve (default to null)

try:
    api_response = api_instance.dokument_get_by_id(apiId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnauthorisiertApi->dokumentGetById: %s\n" % e)
extern crate UnauthorisiertApi;

pub fn main() {
    let apiId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = UnauthorisiertApi::Context::default();
    let result = client.dokumentGetById(apiId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
api_id*
UUID (uuid)
Unique identifier (UUID) of the document to retrieve
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

enumGet

Retrieves values from a specified enumeration type. Returns a list of valid values that can be used in other API operations, optionally filtered by a substring.


/api/v2/enumeration/{name}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/enumeration/{name}?contains=contains_example&page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnauthorisiertApi;

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

public class UnauthorisiertApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        EnumerationNames name = ; // EnumerationNames | Name of the enumeration type to retrieve values from
        String contains = contains_example; // String | Filter by substring match. Returns items containing this string (case-insensitive).
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array['String'] result = apiInstance.enumGet(name, contains, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#enumGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final EnumerationNames name = new EnumerationNames(); // EnumerationNames | Name of the enumeration type to retrieve values from
final String contains = new String(); // String | Filter by substring match. Returns items containing this string (case-insensitive).
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.enumGet(name, contains, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->enumGet: $e\n');
}

import org.openapitools.client.api.UnauthorisiertApi;

public class UnauthorisiertApiExample {
    public static void main(String[] args) {
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        EnumerationNames name = ; // EnumerationNames | Name of the enumeration type to retrieve values from
        String contains = contains_example; // String | Filter by substring match. Returns items containing this string (case-insensitive).
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array['String'] result = apiInstance.enumGet(name, contains, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#enumGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnauthorisiertApi *apiInstance = [[UnauthorisiertApi alloc] init];
EnumerationNames *name = ; // Name of the enumeration type to retrieve values from (default to null)
String *contains = contains_example; // Filter by substring match. Returns items containing this string (case-insensitive). (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance enumGetWith:name
    contains:contains
    page:page
    perPage:perPage
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.UnauthorisiertApi()
var name = ; // {EnumerationNames} Name of the enumeration type to retrieve values from
var opts = {
  'contains': contains_example, // {String} Filter by substring match. Returns items containing this string (case-insensitive).
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UnauthorisiertApi();
            var name = new EnumerationNames(); // EnumerationNames | Name of the enumeration type to retrieve values from (default to null)
            var contains = contains_example;  // String | Filter by substring match. Returns items containing this string (case-insensitive). (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array['String'] result = apiInstance.enumGet(name, contains, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnauthorisiertApi.enumGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnauthorisiertApi();
$name = ; // EnumerationNames | Name of the enumeration type to retrieve values from
$contains = contains_example; // String | Filter by substring match. Returns items containing this string (case-insensitive).
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->enumGet($name, $contains, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnauthorisiertApi->enumGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnauthorisiertApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnauthorisiertApi->new();
my $name = ; # EnumerationNames | Name of the enumeration type to retrieve values from
my $contains = contains_example; # String | Filter by substring match. Returns items containing this string (case-insensitive).
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->enumGet(name => $name, contains => $contains, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnauthorisiertApi->enumGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UnauthorisiertApi()
name =  # EnumerationNames | Name of the enumeration type to retrieve values from (default to null)
contains = contains_example # String | Filter by substring match. Returns items containing this string (case-insensitive). (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.enum_get(name, contains=contains, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnauthorisiertApi->enumGet: %s\n" % e)
extern crate UnauthorisiertApi;

pub fn main() {
    let name = ; // EnumerationNames
    let contains = contains_example; // String
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = UnauthorisiertApi::Context::default();
    let result = client.enumGet(name, contains, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
EnumerationNames
Name of the enumeration type to retrieve values from
Required
Query parameters
Name Description
contains
String
Filter by substring match. Returns items containing this string (case-insensitive).
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

gremienGet

Retrieves a list of committees filtered by optional parameters. Returns committees matching the specified criteria from parliament bodies and electoral periods.


/api/v2/gremien

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/gremien?gr=gr_example&p=&wp=56&page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnauthorisiertApi;

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

public class UnauthorisiertApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[gremium] result = apiInstance.gremienGet(gr, p, wp, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#gremienGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String gr = new String(); // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
final Parlament p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
final Integer wp = new Integer(); // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.gremienGet(gr, p, wp, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->gremienGet: $e\n');
}

import org.openapitools.client.api.UnauthorisiertApi;

public class UnauthorisiertApiExample {
    public static void main(String[] args) {
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[gremium] result = apiInstance.gremienGet(gr, p, wp, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#gremienGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnauthorisiertApi *apiInstance = [[UnauthorisiertApi alloc] init];
String *gr = gr_example; // Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
Parlament *p = ; // Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
Integer *wp = 56; // Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance gremienGetWith:gr
    p:p
    wp:wp
    page:page
    perPage:perPage
              completionHandler: ^(array[gremium] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.UnauthorisiertApi()
var opts = {
  'gr': gr_example, // {String} Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
  'p': , // {Parlament} Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
  'wp': 56, // {Integer} Filter by electoral period number. Returns only items from the specified electoral period.
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UnauthorisiertApi();
            var gr = gr_example;  // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional)  (default to null)
            var p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional)  (default to null)
            var wp = 56;  // Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array[gremium] result = apiInstance.gremienGet(gr, p, wp, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnauthorisiertApi.gremienGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnauthorisiertApi();
$gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
$p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
$wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->gremienGet($gr, $p, $wp, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnauthorisiertApi->gremienGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnauthorisiertApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnauthorisiertApi->new();
my $gr = gr_example; # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
my $p = ; # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
my $wp = 56; # Integer | Filter by electoral period number. Returns only items from the specified electoral period.
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->gremienGet(gr => $gr, p => $p, wp => $wp, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnauthorisiertApi->gremienGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UnauthorisiertApi()
gr = gr_example # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
p =  # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
wp = 56 # Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.gremien_get(gr=gr, p=p, wp=wp, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnauthorisiertApi->gremienGet: %s\n" % e)
extern crate UnauthorisiertApi;

pub fn main() {
    let gr = gr_example; // String
    let p = ; // Parlament
    let wp = 56; // Integer
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = UnauthorisiertApi::Context::default();
    let result = client.gremienGet(gr, p, wp, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
gr
String
Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
p
Parlament
Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
wp
Integer
Filter by electoral period number. Returns only items from the specified electoral period.
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

kalDateGet

Retrieves a list of parliamentary sessions for a specific date and parliament. Provides all sessions scheduled for the given day in the specified parliamentary body.


/api/v2/kalender/{parlament}/{datum}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/kalender/{parlament}/{datum}?page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnauthorisiertApi;

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

public class UnauthorisiertApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        Parlament parlament = ; // Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
        date datum = 2013-10-20; // date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[sitzung] result = apiInstance.kalDateGet(parlament, datum, ifModifiedSince, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#kalDateGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Parlament parlament = new Parlament(); // Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
final date datum = new date(); // date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
final Date ifModifiedSince = new Date(); // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.kalDateGet(parlament, datum, ifModifiedSince, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->kalDateGet: $e\n');
}

import org.openapitools.client.api.UnauthorisiertApi;

public class UnauthorisiertApiExample {
    public static void main(String[] args) {
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        Parlament parlament = ; // Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
        date datum = 2013-10-20; // date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[sitzung] result = apiInstance.kalDateGet(parlament, datum, ifModifiedSince, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#kalDateGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnauthorisiertApi *apiInstance = [[UnauthorisiertApi alloc] init];
Parlament *parlament = ; // Code of the parliament to query sessions for (e.g., 'BT' for Bundestag) (default to null)
date *datum = 2013-10-20; // Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD) (default to null)
Date *ifModifiedSince = 2024-01-01T00:00Z; // Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance kalDateGetWith:parlament
    datum:datum
    ifModifiedSince:ifModifiedSince
    page:page
    perPage:perPage
              completionHandler: ^(array[sitzung] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.UnauthorisiertApi()
var parlament = ; // {Parlament} Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
var datum = 2013-10-20; // {date} Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
var opts = {
  'ifModifiedSince': 2024-01-01T00:00Z, // {Date} Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UnauthorisiertApi();
            var parlament = new Parlament(); // Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag) (default to null)
            var datum = 2013-10-20;  // date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD) (default to null)
            var ifModifiedSince = 2024-01-01T00:00Z;  // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array[sitzung] result = apiInstance.kalDateGet(parlament, datum, ifModifiedSince, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnauthorisiertApi.kalDateGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnauthorisiertApi();
$parlament = ; // Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
$datum = 2013-10-20; // date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
$ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->kalDateGet($parlament, $datum, $ifModifiedSince, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnauthorisiertApi->kalDateGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnauthorisiertApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnauthorisiertApi->new();
my $parlament = ; # Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
my $datum = 2013-10-20; # date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
my $ifModifiedSince = 2024-01-01T00:00Z; # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->kalDateGet(parlament => $parlament, datum => $datum, ifModifiedSince => $ifModifiedSince, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnauthorisiertApi->kalDateGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UnauthorisiertApi()
parlament =  # Parlament | Code of the parliament to query sessions for (e.g., 'BT' for Bundestag) (default to null)
datum = 2013-10-20 # date | Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD) (default to null)
ifModifiedSince = 2024-01-01T00:00Z # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.kal_date_get(parlament, datum, ifModifiedSince=ifModifiedSince, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnauthorisiertApi->kalDateGet: %s\n" % e)
extern crate UnauthorisiertApi;

pub fn main() {
    let parlament = ; // Parlament
    let datum = 2013-10-20; // date
    let ifModifiedSince = 2024-01-01T00:00Z; // Date
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = UnauthorisiertApi::Context::default();
    let result = client.kalDateGet(parlament, datum, ifModifiedSince, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
parlament*
Parlament
Code of the parliament to query sessions for (e.g., 'BT' for Bundestag)
Required
datum*
date (date)
Date to retrieve sessions for, in ISO 8601 format (YYYY-MM-DD)
Required
Header parameters
Name Description
If-Modified-Since
Date (date-time)
Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
Query parameters
Name Description
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

kalGet

Retrieves a filterable list of parliamentary sessions for calendar display. Returns up to 64 sessions per request, which can be filtered by various criteria including year, month, day, parliament, and committee.


/api/v2/kalender

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/kalender?since=2024-01-01T00:00Z&until=2024-12-31T23:59:59Z&p=&wp=56&gr=gr_example&y=56&m=56&dom=56&page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnauthorisiertApi;

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

public class UnauthorisiertApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        Integer y = 56; // Integer | The year to filter results by (1945 or later)
        Integer m = 56; // Integer | The month to filter results by (1-12)
        Integer dom = 56; // Integer | The day of month to filter results by (1-31)
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[sitzung] result = apiInstance.kalGet(ifModifiedSince, since, until, p, wp, gr, y, m, dom, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#kalGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Date ifModifiedSince = new Date(); // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
final Date since = new Date(); // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
final Date until = new Date(); // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
final Parlament p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
final Integer wp = new Integer(); // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
final String gr = new String(); // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
final Integer y = new Integer(); // Integer | The year to filter results by (1945 or later)
final Integer m = new Integer(); // Integer | The month to filter results by (1-12)
final Integer dom = new Integer(); // Integer | The day of month to filter results by (1-31)
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.kalGet(ifModifiedSince, since, until, p, wp, gr, y, m, dom, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->kalGet: $e\n');
}

import org.openapitools.client.api.UnauthorisiertApi;

public class UnauthorisiertApiExample {
    public static void main(String[] args) {
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        Integer y = 56; // Integer | The year to filter results by (1945 or later)
        Integer m = 56; // Integer | The month to filter results by (1-12)
        Integer dom = 56; // Integer | The day of month to filter results by (1-31)
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[sitzung] result = apiInstance.kalGet(ifModifiedSince, since, until, p, wp, gr, y, m, dom, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#kalGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnauthorisiertApi *apiInstance = [[UnauthorisiertApi alloc] init];
Date *ifModifiedSince = 2024-01-01T00:00Z; // Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
Date *since = 2024-01-01T00:00Z; // Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
Date *until = 2024-12-31T23:59:59Z; // Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
Parlament *p = ; // Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
Integer *wp = 56; // Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
String *gr = gr_example; // Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
Integer *y = 56; // The year to filter results by (1945 or later) (optional) (default to null)
Integer *m = 56; // The month to filter results by (1-12) (optional) (default to null)
Integer *dom = 56; // The day of month to filter results by (1-31) (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance kalGetWith:ifModifiedSince
    since:since
    until:until
    p:p
    wp:wp
    gr:gr
    y:y
    m:m
    dom:dom
    page:page
    perPage:perPage
              completionHandler: ^(array[sitzung] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.UnauthorisiertApi()
var opts = {
  'ifModifiedSince': 2024-01-01T00:00Z, // {Date} Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
  'since': 2024-01-01T00:00Z, // {Date} Filter results to include only items updated on or after this timestamp (inclusive lower bound)
  'until': 2024-12-31T23:59:59Z, // {Date} Filter results to include only items updated on or before this timestamp (inclusive upper bound)
  'p': , // {Parlament} Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
  'wp': 56, // {Integer} Filter by electoral period number. Returns only items from the specified electoral period.
  'gr': gr_example, // {String} Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
  'y': 56, // {Integer} The year to filter results by (1945 or later)
  'm': 56, // {Integer} The month to filter results by (1-12)
  'dom': 56, // {Integer} The day of month to filter results by (1-31)
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UnauthorisiertApi();
            var ifModifiedSince = 2024-01-01T00:00Z;  // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional)  (default to null)
            var since = 2024-01-01T00:00Z;  // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional)  (default to null)
            var until = 2024-12-31T23:59:59Z;  // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional)  (default to null)
            var p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional)  (default to null)
            var wp = 56;  // Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional)  (default to null)
            var gr = gr_example;  // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional)  (default to null)
            var y = 56;  // Integer | The year to filter results by (1945 or later) (optional)  (default to null)
            var m = 56;  // Integer | The month to filter results by (1-12) (optional)  (default to null)
            var dom = 56;  // Integer | The day of month to filter results by (1-31) (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array[sitzung] result = apiInstance.kalGet(ifModifiedSince, since, until, p, wp, gr, y, m, dom, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnauthorisiertApi.kalGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnauthorisiertApi();
$ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
$since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
$until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
$p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
$wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
$gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
$y = 56; // Integer | The year to filter results by (1945 or later)
$m = 56; // Integer | The month to filter results by (1-12)
$dom = 56; // Integer | The day of month to filter results by (1-31)
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->kalGet($ifModifiedSince, $since, $until, $p, $wp, $gr, $y, $m, $dom, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnauthorisiertApi->kalGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnauthorisiertApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnauthorisiertApi->new();
my $ifModifiedSince = 2024-01-01T00:00Z; # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
my $since = 2024-01-01T00:00Z; # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
my $until = 2024-12-31T23:59:59Z; # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
my $p = ; # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
my $wp = 56; # Integer | Filter by electoral period number. Returns only items from the specified electoral period.
my $gr = gr_example; # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
my $y = 56; # Integer | The year to filter results by (1945 or later)
my $m = 56; # Integer | The month to filter results by (1-12)
my $dom = 56; # Integer | The day of month to filter results by (1-31)
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->kalGet(ifModifiedSince => $ifModifiedSince, since => $since, until => $until, p => $p, wp => $wp, gr => $gr, y => $y, m => $m, dom => $dom, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnauthorisiertApi->kalGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UnauthorisiertApi()
ifModifiedSince = 2024-01-01T00:00Z # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
since = 2024-01-01T00:00Z # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
until = 2024-12-31T23:59:59Z # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
p =  # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
wp = 56 # Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
gr = gr_example # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
y = 56 # Integer | The year to filter results by (1945 or later) (optional) (default to null)
m = 56 # Integer | The month to filter results by (1-12) (optional) (default to null)
dom = 56 # Integer | The day of month to filter results by (1-31) (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.kal_get(ifModifiedSince=ifModifiedSince, since=since, until=until, p=p, wp=wp, gr=gr, y=y, m=m, dom=dom, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnauthorisiertApi->kalGet: %s\n" % e)
extern crate UnauthorisiertApi;

pub fn main() {
    let ifModifiedSince = 2024-01-01T00:00Z; // Date
    let since = 2024-01-01T00:00Z; // Date
    let until = 2024-12-31T23:59:59Z; // Date
    let p = ; // Parlament
    let wp = 56; // Integer
    let gr = gr_example; // String
    let y = 56; // Integer
    let m = 56; // Integer
    let dom = 56; // Integer
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = UnauthorisiertApi::Context::default();
    let result = client.kalGet(ifModifiedSince, since, until, p, wp, gr, y, m, dom, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
If-Modified-Since
Date (date-time)
Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
Query parameters
Name Description
since
Date (date-time)
Filter results to include only items updated on or after this timestamp (inclusive lower bound)
until
Date (date-time)
Filter results to include only items updated on or before this timestamp (inclusive upper bound)
p
Parlament
Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
wp
Integer
Filter by electoral period number. Returns only items from the specified electoral period.
gr
String
Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
y
Integer
The year to filter results by (1945 or later)
m
Integer
The month to filter results by (1-12)
dom
Integer
The day of month to filter results by (1-31)
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

ping

Just does a round trip with minimal response


/ping

Usage and SDK Samples

curl -X GET \
 "http://localhost/ping?t=8.14"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnauthorisiertApi;

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

public class UnauthorisiertApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        BigDecimal t = 8.14; // BigDecimal | time of ping as milliseconds since 1.1.1970

        try {
            apiInstance.ping(t);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#ping");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final BigDecimal t = new BigDecimal(); // BigDecimal | time of ping as milliseconds since 1.1.1970

try {
    final result = await api_instance.ping(t);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->ping: $e\n');
}

import org.openapitools.client.api.UnauthorisiertApi;

public class UnauthorisiertApiExample {
    public static void main(String[] args) {
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        BigDecimal t = 8.14; // BigDecimal | time of ping as milliseconds since 1.1.1970

        try {
            apiInstance.ping(t);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#ping");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnauthorisiertApi *apiInstance = [[UnauthorisiertApi alloc] init];
BigDecimal *t = 8.14; // time of ping as milliseconds since 1.1.1970 (optional) (default to null)

[apiInstance pingWith:t
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.UnauthorisiertApi()
var opts = {
  't': 8.14 // {BigDecimal} time of ping as milliseconds since 1.1.1970
};

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

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

            // Create an instance of the API class
            var apiInstance = new UnauthorisiertApi();
            var t = 8.14;  // BigDecimal | time of ping as milliseconds since 1.1.1970 (optional)  (default to null)

            try {
                apiInstance.ping(t);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnauthorisiertApi.ping: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnauthorisiertApi();
$t = 8.14; // BigDecimal | time of ping as milliseconds since 1.1.1970

try {
    $api_instance->ping($t);
} catch (Exception $e) {
    echo 'Exception when calling UnauthorisiertApi->ping: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnauthorisiertApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnauthorisiertApi->new();
my $t = 8.14; # BigDecimal | time of ping as milliseconds since 1.1.1970

eval {
    $api_instance->ping(t => $t);
};
if ($@) {
    warn "Exception when calling UnauthorisiertApi->ping: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UnauthorisiertApi()
t = 8.14 # BigDecimal | time of ping as milliseconds since 1.1.1970 (optional) (default to null)

try:
    api_instance.ping(t=t)
except ApiException as e:
    print("Exception when calling UnauthorisiertApi->ping: %s\n" % e)
extern crate UnauthorisiertApi;

pub fn main() {
    let t = 8.14; // BigDecimal

    let mut context = UnauthorisiertApi::Context::default();
    let result = client.ping(t, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
t
BigDecimal
time of ping as milliseconds since 1.1.1970

Responses


sGet

Retrieves a filterable list of parliamentary sessions. Returns up to 64 sessions per request, which can be filtered by various criteria including time frame, parliament, and electoral period.


/api/v2/sitzung

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/sitzung?since=2024-01-01T00:00Z&until=2024-12-31T23:59:59Z&page=56&per_page=56&p=&wp=56&gr=gr_example&vgid=38400000-8cf0-11bd-b23e-10b96e4ef00d&vgtyp="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnauthorisiertApi;

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

public class UnauthorisiertApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        UUID vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Filter by associated legislative process ID. Returns only items related to the specified process.
        Vorgangstyp vgtyp = ; // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.

        try {
            array[sitzung] result = apiInstance.sGet(ifModifiedSince, since, until, page, perPage, p, wp, gr, vgid, vgtyp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#sGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Date ifModifiedSince = new Date(); // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
final Date since = new Date(); // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
final Date until = new Date(); // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.
final Parlament p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
final Integer wp = new Integer(); // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
final String gr = new String(); // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
final UUID vgid = new UUID(); // UUID | Filter by associated legislative process ID. Returns only items related to the specified process.
final Vorgangstyp vgtyp = new Vorgangstyp(); // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.

try {
    final result = await api_instance.sGet(ifModifiedSince, since, until, page, perPage, p, wp, gr, vgid, vgtyp);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sGet: $e\n');
}

import org.openapitools.client.api.UnauthorisiertApi;

public class UnauthorisiertApiExample {
    public static void main(String[] args) {
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        String gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
        UUID vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Filter by associated legislative process ID. Returns only items related to the specified process.
        Vorgangstyp vgtyp = ; // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.

        try {
            array[sitzung] result = apiInstance.sGet(ifModifiedSince, since, until, page, perPage, p, wp, gr, vgid, vgtyp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#sGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnauthorisiertApi *apiInstance = [[UnauthorisiertApi alloc] init];
Date *ifModifiedSince = 2024-01-01T00:00Z; // Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
Date *since = 2024-01-01T00:00Z; // Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
Date *until = 2024-12-31T23:59:59Z; // Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)
Parlament *p = ; // Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
Integer *wp = 56; // Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
String *gr = gr_example; // Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
UUID *vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Filter by associated legislative process ID. Returns only items related to the specified process. (optional) (default to null)
Vorgangstyp *vgtyp = ; // Filter by legislative process type. Returns only items of the specified process type. (optional) (default to null)

[apiInstance sGetWith:ifModifiedSince
    since:since
    until:until
    page:page
    perPage:perPage
    p:p
    wp:wp
    gr:gr
    vgid:vgid
    vgtyp:vgtyp
              completionHandler: ^(array[sitzung] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.UnauthorisiertApi()
var opts = {
  'ifModifiedSince': 2024-01-01T00:00Z, // {Date} Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
  'since': 2024-01-01T00:00Z, // {Date} Filter results to include only items updated on or after this timestamp (inclusive lower bound)
  'until': 2024-12-31T23:59:59Z, // {Date} Filter results to include only items updated on or before this timestamp (inclusive upper bound)
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56, // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
  'p': , // {Parlament} Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
  'wp': 56, // {Integer} Filter by electoral period number. Returns only items from the specified electoral period.
  'gr': gr_example, // {String} Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
  'vgid': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} Filter by associated legislative process ID. Returns only items related to the specified process.
  'vgtyp':  // {Vorgangstyp} Filter by legislative process type. Returns only items of the specified process type.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UnauthorisiertApi();
            var ifModifiedSince = 2024-01-01T00:00Z;  // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional)  (default to null)
            var since = 2024-01-01T00:00Z;  // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional)  (default to null)
            var until = 2024-12-31T23:59:59Z;  // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)
            var p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional)  (default to null)
            var wp = 56;  // Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional)  (default to null)
            var gr = gr_example;  // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional)  (default to null)
            var vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Filter by associated legislative process ID. Returns only items related to the specified process. (optional)  (default to null)
            var vgtyp = new Vorgangstyp(); // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type. (optional)  (default to null)

            try {
                array[sitzung] result = apiInstance.sGet(ifModifiedSince, since, until, page, perPage, p, wp, gr, vgid, vgtyp);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnauthorisiertApi.sGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnauthorisiertApi();
$ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
$since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
$until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.
$p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
$wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
$gr = gr_example; // String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
$vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Filter by associated legislative process ID. Returns only items related to the specified process.
$vgtyp = ; // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.

try {
    $result = $api_instance->sGet($ifModifiedSince, $since, $until, $page, $perPage, $p, $wp, $gr, $vgid, $vgtyp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnauthorisiertApi->sGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnauthorisiertApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnauthorisiertApi->new();
my $ifModifiedSince = 2024-01-01T00:00Z; # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
my $since = 2024-01-01T00:00Z; # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
my $until = 2024-12-31T23:59:59Z; # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.
my $p = ; # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
my $wp = 56; # Integer | Filter by electoral period number. Returns only items from the specified electoral period.
my $gr = gr_example; # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
my $vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Filter by associated legislative process ID. Returns only items related to the specified process.
my $vgtyp = ; # Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.

eval {
    my $result = $api_instance->sGet(ifModifiedSince => $ifModifiedSince, since => $since, until => $until, page => $page, perPage => $perPage, p => $p, wp => $wp, gr => $gr, vgid => $vgid, vgtyp => $vgtyp);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnauthorisiertApi->sGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UnauthorisiertApi()
ifModifiedSince = 2024-01-01T00:00Z # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
since = 2024-01-01T00:00Z # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
until = 2024-12-31T23:59:59Z # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)
p =  # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
wp = 56 # Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
gr = gr_example # String | Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter. (optional) (default to null)
vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Filter by associated legislative process ID. Returns only items related to the specified process. (optional) (default to null)
vgtyp =  # Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type. (optional) (default to null)

try:
    api_response = api_instance.s_get(ifModifiedSince=ifModifiedSince, since=since, until=until, page=page, perPage=perPage, p=p, wp=wp, gr=gr, vgid=vgid, vgtyp=vgtyp)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnauthorisiertApi->sGet: %s\n" % e)
extern crate UnauthorisiertApi;

pub fn main() {
    let ifModifiedSince = 2024-01-01T00:00Z; // Date
    let since = 2024-01-01T00:00Z; // Date
    let until = 2024-12-31T23:59:59Z; // Date
    let page = 56; // Integer
    let perPage = 56; // Integer
    let p = ; // Parlament
    let wp = 56; // Integer
    let gr = gr_example; // String
    let vgid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let vgtyp = ; // Vorgangstyp

    let mut context = UnauthorisiertApi::Context::default();
    let result = client.sGet(ifModifiedSince, since, until, page, perPage, p, wp, gr, vgid, vgtyp, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
If-Modified-Since
Date (date-time)
Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
Query parameters
Name Description
since
Date (date-time)
Filter results to include only items updated on or after this timestamp (inclusive lower bound)
until
Date (date-time)
Filter results to include only items updated on or before this timestamp (inclusive upper bound)
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.
p
Parlament
Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
wp
Integer
Filter by electoral period number. Returns only items from the specified electoral period.
gr
String
Filter by committee name substring. Returns committees whose names contain this string (case-insensitive). Used in conjunction with parlament parameter.
vgid
UUID (uuid)
Filter by associated legislative process ID. Returns only items related to the specified process.
vgtyp
Vorgangstyp
Filter by legislative process type. Returns only items of the specified process type.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

sGetById

Retrieves detailed information about a specific parliamentary session by its unique identifier. Returns complete session data including agenda items, documents, and metadata. If called by admin or higher, this returns a list of last scrapers/collectors touching the object


/api/v2/sitzung/{sid}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/sitzung/{sid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnauthorisiertApi;

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

public class UnauthorisiertApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        UUID sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to retrieve
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

        try {
            sitzung result = apiInstance.sGetById(sid, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#sGetById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID sid = new UUID(); // UUID | Unique identifier (UUID) of the session to retrieve
final Date ifModifiedSince = new Date(); // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

try {
    final result = await api_instance.sGetById(sid, ifModifiedSince);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->sGetById: $e\n');
}

import org.openapitools.client.api.UnauthorisiertApi;

public class UnauthorisiertApiExample {
    public static void main(String[] args) {
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        UUID sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to retrieve
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

        try {
            sitzung result = apiInstance.sGetById(sid, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#sGetById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnauthorisiertApi *apiInstance = [[UnauthorisiertApi alloc] init];
UUID *sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the session to retrieve (default to null)
Date *ifModifiedSince = 2024-01-01T00:00Z; // Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)

[apiInstance sGetByIdWith:sid
    ifModifiedSince:ifModifiedSince
              completionHandler: ^(sitzung output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.UnauthorisiertApi()
var sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the session to retrieve
var opts = {
  'ifModifiedSince': 2024-01-01T00:00Z // {Date} Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UnauthorisiertApi();
            var sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the session to retrieve (default to null)
            var ifModifiedSince = 2024-01-01T00:00Z;  // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional)  (default to null)

            try {
                sitzung result = apiInstance.sGetById(sid, ifModifiedSince);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnauthorisiertApi.sGetById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnauthorisiertApi();
$sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the session to retrieve
$ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

try {
    $result = $api_instance->sGetById($sid, $ifModifiedSince);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnauthorisiertApi->sGetById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnauthorisiertApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnauthorisiertApi->new();
my $sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the session to retrieve
my $ifModifiedSince = 2024-01-01T00:00Z; # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

eval {
    my $result = $api_instance->sGetById(sid => $sid, ifModifiedSince => $ifModifiedSince);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnauthorisiertApi->sGetById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UnauthorisiertApi()
sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the session to retrieve (default to null)
ifModifiedSince = 2024-01-01T00:00Z # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)

try:
    api_response = api_instance.s_get_by_id(sid, ifModifiedSince=ifModifiedSince)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnauthorisiertApi->sGetById: %s\n" % e)
extern crate UnauthorisiertApi;

pub fn main() {
    let sid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let ifModifiedSince = 2024-01-01T00:00Z; // Date

    let mut context = UnauthorisiertApi::Context::default();
    let result = client.sGetById(sid, ifModifiedSince, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
sid*
UUID (uuid)
Unique identifier (UUID) of the session to retrieve
Required
Header parameters
Name Description
If-Modified-Since
Date (date-time)
Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

status

Retrieves the current status of the API


/status

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/status"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnauthorisiertApi;

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

public class UnauthorisiertApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();

        try {
            'String' result = apiInstance.status();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#status");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.status();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->status: $e\n');
}

import org.openapitools.client.api.UnauthorisiertApi;

public class UnauthorisiertApiExample {
    public static void main(String[] args) {
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();

        try {
            'String' result = apiInstance.status();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#status");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnauthorisiertApi *apiInstance = [[UnauthorisiertApi alloc] init];

[apiInstance statusWithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.UnauthorisiertApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.status(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new UnauthorisiertApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnauthorisiertApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnauthorisiertApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.UnauthorisiertApi()

try:
    api_response = api_instance.status()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnauthorisiertApi->status: %s\n" % e)
extern crate UnauthorisiertApi;

pub fn main() {

    let mut context = UnauthorisiertApi::Context::default();
    let result = client.status(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

vorgangGet

Retrieves a filterable list of legislative processes. Returns up to 64 processes per request, which can be filtered by various criteria including time range, parliament, and electoral period.


/api/v2/vorgang

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/vorgang?since=2024-01-01T00:00Z&until=2024-12-31T23:59:59Z&p=&wp=56&person=person_example&fach=fach_example&org=org_example&vgtyp=&page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnauthorisiertApi;

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

public class UnauthorisiertApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        String person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
        String fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
        String org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.
        Vorgangstyp vgtyp = ; // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[vorgang] result = apiInstance.vorgangGet(ifModifiedSince, since, until, p, wp, person, fach, org, vgtyp, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#vorgangGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Date ifModifiedSince = new Date(); // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
final Date since = new Date(); // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
final Date until = new Date(); // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
final Parlament p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
final Integer wp = new Integer(); // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
final String person = new String(); // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
final String fach = new String(); // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
final String org = new String(); // String | Filter by author organization. Returns items where an author belongs to the specified organization.
final Vorgangstyp vgtyp = new Vorgangstyp(); // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.vorgangGet(ifModifiedSince, since, until, p, wp, person, fach, org, vgtyp, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->vorgangGet: $e\n');
}

import org.openapitools.client.api.UnauthorisiertApi;

public class UnauthorisiertApiExample {
    public static void main(String[] args) {
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        String person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
        String fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
        String org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.
        Vorgangstyp vgtyp = ; // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[vorgang] result = apiInstance.vorgangGet(ifModifiedSince, since, until, p, wp, person, fach, org, vgtyp, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#vorgangGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnauthorisiertApi *apiInstance = [[UnauthorisiertApi alloc] init];
Date *ifModifiedSince = 2024-01-01T00:00Z; // Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
Date *since = 2024-01-01T00:00Z; // Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
Date *until = 2024-12-31T23:59:59Z; // Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
Parlament *p = ; // Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
Integer *wp = 56; // Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
String *person = person_example; // Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional) (default to null)
String *fach = fach_example; // Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional) (default to null)
String *org = org_example; // Filter by author organization. Returns items where an author belongs to the specified organization. (optional) (default to null)
Vorgangstyp *vgtyp = ; // Filter by legislative process type. Returns only items of the specified process type. (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance vorgangGetWith:ifModifiedSince
    since:since
    until:until
    p:p
    wp:wp
    person:person
    fach:fach
    org:org
    vgtyp:vgtyp
    page:page
    perPage:perPage
              completionHandler: ^(array[vorgang] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.UnauthorisiertApi()
var opts = {
  'ifModifiedSince': 2024-01-01T00:00Z, // {Date} Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
  'since': 2024-01-01T00:00Z, // {Date} Filter results to include only items updated on or after this timestamp (inclusive lower bound)
  'until': 2024-12-31T23:59:59Z, // {Date} Filter results to include only items updated on or before this timestamp (inclusive upper bound)
  'p': , // {Parlament} Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
  'wp': 56, // {Integer} Filter by electoral period number. Returns only items from the specified electoral period.
  'person': person_example, // {String} Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
  'fach': fach_example, // {String} Filter by author's professional field. Returns items where an author has the specified professional expertise.
  'org': org_example, // {String} Filter by author organization. Returns items where an author belongs to the specified organization.
  'vgtyp': , // {Vorgangstyp} Filter by legislative process type. Returns only items of the specified process type.
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UnauthorisiertApi();
            var ifModifiedSince = 2024-01-01T00:00Z;  // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional)  (default to null)
            var since = 2024-01-01T00:00Z;  // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional)  (default to null)
            var until = 2024-12-31T23:59:59Z;  // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional)  (default to null)
            var p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional)  (default to null)
            var wp = 56;  // Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional)  (default to null)
            var person = person_example;  // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional)  (default to null)
            var fach = fach_example;  // String | Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional)  (default to null)
            var org = org_example;  // String | Filter by author organization. Returns items where an author belongs to the specified organization. (optional)  (default to null)
            var vgtyp = new Vorgangstyp(); // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type. (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array[vorgang] result = apiInstance.vorgangGet(ifModifiedSince, since, until, p, wp, person, fach, org, vgtyp, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnauthorisiertApi.vorgangGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnauthorisiertApi();
$ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
$since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
$until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
$p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
$wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
$person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
$fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
$org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.
$vgtyp = ; // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->vorgangGet($ifModifiedSince, $since, $until, $p, $wp, $person, $fach, $org, $vgtyp, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnauthorisiertApi->vorgangGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnauthorisiertApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnauthorisiertApi->new();
my $ifModifiedSince = 2024-01-01T00:00Z; # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
my $since = 2024-01-01T00:00Z; # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
my $until = 2024-12-31T23:59:59Z; # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
my $p = ; # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
my $wp = 56; # Integer | Filter by electoral period number. Returns only items from the specified electoral period.
my $person = person_example; # String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
my $fach = fach_example; # String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
my $org = org_example; # String | Filter by author organization. Returns items where an author belongs to the specified organization.
my $vgtyp = ; # Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->vorgangGet(ifModifiedSince => $ifModifiedSince, since => $since, until => $until, p => $p, wp => $wp, person => $person, fach => $fach, org => $org, vgtyp => $vgtyp, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnauthorisiertApi->vorgangGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UnauthorisiertApi()
ifModifiedSince = 2024-01-01T00:00Z # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
since = 2024-01-01T00:00Z # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
until = 2024-12-31T23:59:59Z # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
p =  # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
wp = 56 # Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
person = person_example # String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional) (default to null)
fach = fach_example # String | Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional) (default to null)
org = org_example # String | Filter by author organization. Returns items where an author belongs to the specified organization. (optional) (default to null)
vgtyp =  # Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type. (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.vorgang_get(ifModifiedSince=ifModifiedSince, since=since, until=until, p=p, wp=wp, person=person, fach=fach, org=org, vgtyp=vgtyp, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnauthorisiertApi->vorgangGet: %s\n" % e)
extern crate UnauthorisiertApi;

pub fn main() {
    let ifModifiedSince = 2024-01-01T00:00Z; // Date
    let since = 2024-01-01T00:00Z; // Date
    let until = 2024-12-31T23:59:59Z; // Date
    let p = ; // Parlament
    let wp = 56; // Integer
    let person = person_example; // String
    let fach = fach_example; // String
    let org = org_example; // String
    let vgtyp = ; // Vorgangstyp
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = UnauthorisiertApi::Context::default();
    let result = client.vorgangGet(ifModifiedSince, since, until, p, wp, person, fach, org, vgtyp, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
If-Modified-Since
Date (date-time)
Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
Query parameters
Name Description
since
Date (date-time)
Filter results to include only items updated on or after this timestamp (inclusive lower bound)
until
Date (date-time)
Filter results to include only items updated on or before this timestamp (inclusive upper bound)
p
Parlament
Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
wp
Integer
Filter by electoral period number. Returns only items from the specified electoral period.
person
String
Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
fach
String
Filter by author's professional field. Returns items where an author has the specified professional expertise.
org
String
Filter by author organization. Returns items where an author belongs to the specified organization.
vgtyp
Vorgangstyp
Filter by legislative process type. Returns only items of the specified process type.
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

vorgangGetById

Retrieves a specific legislative process by its unique identifier. Returns comprehensive details about the process including all its stations, associated documents, and metadata. If called by admin or higher, this returns a list of last scrapers/collectors touching the object


/api/v2/vorgang/{vorgang_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/vorgang/{vorgang_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UnauthorisiertApi;

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

public class UnauthorisiertApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        UUID vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to retrieve
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

        try {
            vorgang result = apiInstance.vorgangGetById(vorgangId, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#vorgangGetById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID vorgangId = new UUID(); // UUID | Unique identifier (UUID) of the legislative process to retrieve
final Date ifModifiedSince = new Date(); // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

try {
    final result = await api_instance.vorgangGetById(vorgangId, ifModifiedSince);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->vorgangGetById: $e\n');
}

import org.openapitools.client.api.UnauthorisiertApi;

public class UnauthorisiertApiExample {
    public static void main(String[] args) {
        UnauthorisiertApi apiInstance = new UnauthorisiertApi();
        UUID vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to retrieve
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

        try {
            vorgang result = apiInstance.vorgangGetById(vorgangId, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UnauthorisiertApi#vorgangGetById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UnauthorisiertApi *apiInstance = [[UnauthorisiertApi alloc] init];
UUID *vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the legislative process to retrieve (default to null)
Date *ifModifiedSince = 2024-01-01T00:00Z; // Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)

[apiInstance vorgangGetByIdWith:vorgangId
    ifModifiedSince:ifModifiedSince
              completionHandler: ^(vorgang output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.UnauthorisiertApi()
var vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the legislative process to retrieve
var opts = {
  'ifModifiedSince': 2024-01-01T00:00Z // {Date} Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UnauthorisiertApi();
            var vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the legislative process to retrieve (default to null)
            var ifModifiedSince = 2024-01-01T00:00Z;  // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional)  (default to null)

            try {
                vorgang result = apiInstance.vorgangGetById(vorgangId, ifModifiedSince);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UnauthorisiertApi.vorgangGetById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UnauthorisiertApi();
$vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to retrieve
$ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

try {
    $result = $api_instance->vorgangGetById($vorgangId, $ifModifiedSince);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UnauthorisiertApi->vorgangGetById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UnauthorisiertApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UnauthorisiertApi->new();
my $vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the legislative process to retrieve
my $ifModifiedSince = 2024-01-01T00:00Z; # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

eval {
    my $result = $api_instance->vorgangGetById(vorgangId => $vorgangId, ifModifiedSince => $ifModifiedSince);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UnauthorisiertApi->vorgangGetById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UnauthorisiertApi()
vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the legislative process to retrieve (default to null)
ifModifiedSince = 2024-01-01T00:00Z # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)

try:
    api_response = api_instance.vorgang_get_by_id(vorgangId, ifModifiedSince=ifModifiedSince)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UnauthorisiertApi->vorgangGetById: %s\n" % e)
extern crate UnauthorisiertApi;

pub fn main() {
    let vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let ifModifiedSince = 2024-01-01T00:00Z; // Date

    let mut context = UnauthorisiertApi::Context::default();
    let result = client.vorgangGetById(vorgangId, ifModifiedSince, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vorgang_id*
UUID (uuid)
Unique identifier (UUID) of the legislative process to retrieve
Required
Header parameters
Name Description
If-Modified-Since
Date (date-time)
Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Vorgang

vorgangDelete

Administrative endpoint to completely remove a legislative process from the system. This operation cannot be undone.


/api/v2/vorgang/{vorgang_id}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 "http://localhost/api/v2/vorgang/{vorgang_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VorgangApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VorgangApi apiInstance = new VorgangApi();
        UUID vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to delete

        try {
            apiInstance.vorgangDelete(vorgangId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VorgangApi#vorgangDelete");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID vorgangId = new UUID(); // UUID | Unique identifier (UUID) of the legislative process to delete

try {
    final result = await api_instance.vorgangDelete(vorgangId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->vorgangDelete: $e\n');
}

import org.openapitools.client.api.VorgangApi;

public class VorgangApiExample {
    public static void main(String[] args) {
        VorgangApi apiInstance = new VorgangApi();
        UUID vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to delete

        try {
            apiInstance.vorgangDelete(vorgangId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VorgangApi#vorgangDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
VorgangApi *apiInstance = [[VorgangApi alloc] init];
UUID *vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the legislative process to delete (default to null)

[apiInstance vorgangDeleteWith:vorgangId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.VorgangApi()
var vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the legislative process to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.vorgangDelete(vorgangId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class vorgangDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new VorgangApi();
            var vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the legislative process to delete (default to null)

            try {
                apiInstance.vorgangDelete(vorgangId);
            } catch (Exception e) {
                Debug.Print("Exception when calling VorgangApi.vorgangDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VorgangApi();
$vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to delete

try {
    $api_instance->vorgangDelete($vorgangId);
} catch (Exception $e) {
    echo 'Exception when calling VorgangApi->vorgangDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VorgangApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VorgangApi->new();
my $vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the legislative process to delete

eval {
    $api_instance->vorgangDelete(vorgangId => $vorgangId);
};
if ($@) {
    warn "Exception when calling VorgangApi->vorgangDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VorgangApi()
vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the legislative process to delete (default to null)

try:
    api_instance.vorgang_delete(vorgangId)
except ApiException as e:
    print("Exception when calling VorgangApi->vorgangDelete: %s\n" % e)
extern crate VorgangApi;

pub fn main() {
    let vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = VorgangApi::Context::default();
    let result = client.vorgangDelete(vorgangId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vorgang_id*
UUID (uuid)
Unique identifier (UUID) of the legislative process to delete
Required

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

vorgangGet

Retrieves a filterable list of legislative processes. Returns up to 64 processes per request, which can be filtered by various criteria including time range, parliament, and electoral period.


/api/v2/vorgang

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/vorgang?since=2024-01-01T00:00Z&until=2024-12-31T23:59:59Z&p=&wp=56&person=person_example&fach=fach_example&org=org_example&vgtyp=&page=56&per_page=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VorgangApi;

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

public class VorgangApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        VorgangApi apiInstance = new VorgangApi();
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        String person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
        String fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
        String org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.
        Vorgangstyp vgtyp = ; // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[vorgang] result = apiInstance.vorgangGet(ifModifiedSince, since, until, p, wp, person, fach, org, vgtyp, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VorgangApi#vorgangGet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Date ifModifiedSince = new Date(); // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
final Date since = new Date(); // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
final Date until = new Date(); // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
final Parlament p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
final Integer wp = new Integer(); // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
final String person = new String(); // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
final String fach = new String(); // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
final String org = new String(); // String | Filter by author organization. Returns items where an author belongs to the specified organization.
final Vorgangstyp vgtyp = new Vorgangstyp(); // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.
final Integer page = new Integer(); // Integer | Page number for paginated results. Starts at 1.
final Integer perPage = new Integer(); // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    final result = await api_instance.vorgangGet(ifModifiedSince, since, until, p, wp, person, fach, org, vgtyp, page, perPage);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->vorgangGet: $e\n');
}

import org.openapitools.client.api.VorgangApi;

public class VorgangApiExample {
    public static void main(String[] args) {
        VorgangApi apiInstance = new VorgangApi();
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
        Date since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
        Date until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
        Parlament p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
        Integer wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
        String person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
        String fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
        String org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.
        Vorgangstyp vgtyp = ; // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.
        Integer page = 56; // Integer | Page number for paginated results. Starts at 1.
        Integer perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

        try {
            array[vorgang] result = apiInstance.vorgangGet(ifModifiedSince, since, until, p, wp, person, fach, org, vgtyp, page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VorgangApi#vorgangGet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
VorgangApi *apiInstance = [[VorgangApi alloc] init];
Date *ifModifiedSince = 2024-01-01T00:00Z; // Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
Date *since = 2024-01-01T00:00Z; // Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
Date *until = 2024-12-31T23:59:59Z; // Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
Parlament *p = ; // Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
Integer *wp = 56; // Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
String *person = person_example; // Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional) (default to null)
String *fach = fach_example; // Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional) (default to null)
String *org = org_example; // Filter by author organization. Returns items where an author belongs to the specified organization. (optional) (default to null)
Vorgangstyp *vgtyp = ; // Filter by legislative process type. Returns only items of the specified process type. (optional) (default to null)
Integer *page = 56; // Page number for paginated results. Starts at 1. (optional) (default to 1)
Integer *perPage = 56; // Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

[apiInstance vorgangGetWith:ifModifiedSince
    since:since
    until:until
    p:p
    wp:wp
    person:person
    fach:fach
    org:org
    vgtyp:vgtyp
    page:page
    perPage:perPage
              completionHandler: ^(array[vorgang] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.VorgangApi()
var opts = {
  'ifModifiedSince': 2024-01-01T00:00Z, // {Date} Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
  'since': 2024-01-01T00:00Z, // {Date} Filter results to include only items updated on or after this timestamp (inclusive lower bound)
  'until': 2024-12-31T23:59:59Z, // {Date} Filter results to include only items updated on or before this timestamp (inclusive upper bound)
  'p': , // {Parlament} Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
  'wp': 56, // {Integer} Filter by electoral period number. Returns only items from the specified electoral period.
  'person': person_example, // {String} Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
  'fach': fach_example, // {String} Filter by author's professional field. Returns items where an author has the specified professional expertise.
  'org': org_example, // {String} Filter by author organization. Returns items where an author belongs to the specified organization.
  'vgtyp': , // {Vorgangstyp} Filter by legislative process type. Returns only items of the specified process type.
  'page': 56, // {Integer} Page number for paginated results. Starts at 1.
  'perPage': 56 // {Integer} Number of items to return per page. Maximum value is capped at server-defined limit.
};

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

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

            // Create an instance of the API class
            var apiInstance = new VorgangApi();
            var ifModifiedSince = 2024-01-01T00:00Z;  // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional)  (default to null)
            var since = 2024-01-01T00:00Z;  // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional)  (default to null)
            var until = 2024-12-31T23:59:59Z;  // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional)  (default to null)
            var p = new Parlament(); // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional)  (default to null)
            var wp = 56;  // Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional)  (default to null)
            var person = person_example;  // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional)  (default to null)
            var fach = fach_example;  // String | Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional)  (default to null)
            var org = org_example;  // String | Filter by author organization. Returns items where an author belongs to the specified organization. (optional)  (default to null)
            var vgtyp = new Vorgangstyp(); // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type. (optional)  (default to null)
            var page = 56;  // Integer | Page number for paginated results. Starts at 1. (optional)  (default to 1)
            var perPage = 56;  // Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional)  (default to 32)

            try {
                array[vorgang] result = apiInstance.vorgangGet(ifModifiedSince, since, until, p, wp, person, fach, org, vgtyp, page, perPage);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VorgangApi.vorgangGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VorgangApi();
$ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
$since = 2024-01-01T00:00Z; // Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
$until = 2024-12-31T23:59:59Z; // Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
$p = ; // Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
$wp = 56; // Integer | Filter by electoral period number. Returns only items from the specified electoral period.
$person = person_example; // String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
$fach = fach_example; // String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
$org = org_example; // String | Filter by author organization. Returns items where an author belongs to the specified organization.
$vgtyp = ; // Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.
$page = 56; // Integer | Page number for paginated results. Starts at 1.
$perPage = 56; // Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

try {
    $result = $api_instance->vorgangGet($ifModifiedSince, $since, $until, $p, $wp, $person, $fach, $org, $vgtyp, $page, $perPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VorgangApi->vorgangGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VorgangApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VorgangApi->new();
my $ifModifiedSince = 2024-01-01T00:00Z; # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
my $since = 2024-01-01T00:00Z; # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound)
my $until = 2024-12-31T23:59:59Z; # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound)
my $p = ; # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
my $wp = 56; # Integer | Filter by electoral period number. Returns only items from the specified electoral period.
my $person = person_example; # String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
my $fach = fach_example; # String | Filter by author's professional field. Returns items where an author has the specified professional expertise.
my $org = org_example; # String | Filter by author organization. Returns items where an author belongs to the specified organization.
my $vgtyp = ; # Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type.
my $page = 56; # Integer | Page number for paginated results. Starts at 1.
my $perPage = 56; # Integer | Number of items to return per page. Maximum value is capped at server-defined limit.

eval {
    my $result = $api_instance->vorgangGet(ifModifiedSince => $ifModifiedSince, since => $since, until => $until, p => $p, wp => $wp, person => $person, fach => $fach, org => $org, vgtyp => $vgtyp, page => $page, perPage => $perPage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VorgangApi->vorgangGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.VorgangApi()
ifModifiedSince = 2024-01-01T00:00Z # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)
since = 2024-01-01T00:00Z # Date | Filter results to include only items updated on or after this timestamp (inclusive lower bound) (optional) (default to null)
until = 2024-12-31T23:59:59Z # Date | Filter results to include only items updated on or before this timestamp (inclusive upper bound) (optional) (default to null)
p =  # Parlament | Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag). (optional) (default to null)
wp = 56 # Integer | Filter by electoral period number. Returns only items from the specified electoral period. (optional) (default to null)
person = person_example # String | Filter by author name substring. Returns items where an author's name contains this string (case-insensitive). (optional) (default to null)
fach = fach_example # String | Filter by author's professional field. Returns items where an author has the specified professional expertise. (optional) (default to null)
org = org_example # String | Filter by author organization. Returns items where an author belongs to the specified organization. (optional) (default to null)
vgtyp =  # Vorgangstyp | Filter by legislative process type. Returns only items of the specified process type. (optional) (default to null)
page = 56 # Integer | Page number for paginated results. Starts at 1. (optional) (default to 1)
perPage = 56 # Integer | Number of items to return per page. Maximum value is capped at server-defined limit. (optional) (default to 32)

try:
    api_response = api_instance.vorgang_get(ifModifiedSince=ifModifiedSince, since=since, until=until, p=p, wp=wp, person=person, fach=fach, org=org, vgtyp=vgtyp, page=page, perPage=perPage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VorgangApi->vorgangGet: %s\n" % e)
extern crate VorgangApi;

pub fn main() {
    let ifModifiedSince = 2024-01-01T00:00Z; // Date
    let since = 2024-01-01T00:00Z; // Date
    let until = 2024-12-31T23:59:59Z; // Date
    let p = ; // Parlament
    let wp = 56; // Integer
    let person = person_example; // String
    let fach = fach_example; // String
    let org = org_example; // String
    let vgtyp = ; // Vorgangstyp
    let page = 56; // Integer
    let perPage = 56; // Integer

    let mut context = VorgangApi::Context::default();
    let result = client.vorgangGet(ifModifiedSince, since, until, p, wp, person, fach, org, vgtyp, page, perPage, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
If-Modified-Since
Date (date-time)
Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
Query parameters
Name Description
since
Date (date-time)
Filter results to include only items updated on or after this timestamp (inclusive lower bound)
until
Date (date-time)
Filter results to include only items updated on or before this timestamp (inclusive upper bound)
p
Parlament
Filter by parliament code. Returns only items related to the specified parliament (e.g., 'BT' for Bundestag).
wp
Integer
Filter by electoral period number. Returns only items from the specified electoral period.
person
String
Filter by author name substring. Returns items where an author's name contains this string (case-insensitive).
fach
String
Filter by author's professional field. Returns items where an author has the specified professional expertise.
org
String
Filter by author organization. Returns items where an author belongs to the specified organization.
vgtyp
Vorgangstyp
Filter by legislative process type. Returns only items of the specified process type.
page
Integer
Page number for paginated results. Starts at 1.
per_page
Integer
Number of items to return per page. Maximum value is capped at server-defined limit.

Responses

Name Type Format Description
X-Total-Count Integer
X-Total-Pages Integer
X-Page Integer
X-Per-Page Integer
Link String
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

vorgangGetById

Retrieves a specific legislative process by its unique identifier. Returns comprehensive details about the process including all its stations, associated documents, and metadata. If called by admin or higher, this returns a list of last scrapers/collectors touching the object


/api/v2/vorgang/{vorgang_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/v2/vorgang/{vorgang_id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VorgangApi;

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

public class VorgangApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        VorgangApi apiInstance = new VorgangApi();
        UUID vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to retrieve
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

        try {
            vorgang result = apiInstance.vorgangGetById(vorgangId, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VorgangApi#vorgangGetById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID vorgangId = new UUID(); // UUID | Unique identifier (UUID) of the legislative process to retrieve
final Date ifModifiedSince = new Date(); // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

try {
    final result = await api_instance.vorgangGetById(vorgangId, ifModifiedSince);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->vorgangGetById: $e\n');
}

import org.openapitools.client.api.VorgangApi;

public class VorgangApiExample {
    public static void main(String[] args) {
        VorgangApi apiInstance = new VorgangApi();
        UUID vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to retrieve
        Date ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

        try {
            vorgang result = apiInstance.vorgangGetById(vorgangId, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VorgangApi#vorgangGetById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
VorgangApi *apiInstance = [[VorgangApi alloc] init];
UUID *vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the legislative process to retrieve (default to null)
Date *ifModifiedSince = 2024-01-01T00:00Z; // Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)

[apiInstance vorgangGetByIdWith:vorgangId
    ifModifiedSince:ifModifiedSince
              completionHandler: ^(vorgang output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');

// Create an instance of the API class
var api = new LtzfApi.VorgangApi()
var vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the legislative process to retrieve
var opts = {
  'ifModifiedSince': 2024-01-01T00:00Z // {Date} Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.
};

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

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

            // Create an instance of the API class
            var apiInstance = new VorgangApi();
            var vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the legislative process to retrieve (default to null)
            var ifModifiedSince = 2024-01-01T00:00Z;  // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional)  (default to null)

            try {
                vorgang result = apiInstance.vorgangGetById(vorgangId, ifModifiedSince);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VorgangApi.vorgangGetById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VorgangApi();
$vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to retrieve
$ifModifiedSince = 2024-01-01T00:00Z; // Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

try {
    $result = $api_instance->vorgangGetById($vorgangId, $ifModifiedSince);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VorgangApi->vorgangGetById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VorgangApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VorgangApi->new();
my $vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the legislative process to retrieve
my $ifModifiedSince = 2024-01-01T00:00Z; # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

eval {
    my $result = $api_instance->vorgangGetById(vorgangId => $vorgangId, ifModifiedSince => $ifModifiedSince);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VorgangApi->vorgangGetById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.VorgangApi()
vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the legislative process to retrieve (default to null)
ifModifiedSince = 2024-01-01T00:00Z # Date | Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified. (optional) (default to null)

try:
    api_response = api_instance.vorgang_get_by_id(vorgangId, ifModifiedSince=ifModifiedSince)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VorgangApi->vorgangGetById: %s\n" % e)
extern crate VorgangApi;

pub fn main() {
    let vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let ifModifiedSince = 2024-01-01T00:00Z; // Date

    let mut context = VorgangApi::Context::default();
    let result = client.vorgangGetById(vorgangId, ifModifiedSince, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vorgang_id*
UUID (uuid)
Unique identifier (UUID) of the legislative process to retrieve
Required
Header parameters
Name Description
If-Modified-Since
Date (date-time)
Return only elements that were modified after the specified timestamp. If nothing was modified, returns 304 Not Modified.

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

vorgangIdPut

Administrative endpoint to directly set or replace a legislative process without merging or matching. Replaces the entire process data if it exists, or creates a new one if it doesn't.


/api/v2/vorgang/{vorgang_id}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/vorgang/{vorgang_id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VorgangApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VorgangApi apiInstance = new VorgangApi();
        UUID vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to create or update
        Vorgang vorgang = ; // Vorgang | 

        try {
            apiInstance.vorgangIdPut(vorgangId, vorgang);
        } catch (ApiException e) {
            System.err.println("Exception when calling VorgangApi#vorgangIdPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID vorgangId = new UUID(); // UUID | Unique identifier (UUID) of the legislative process to create or update
final Vorgang vorgang = new Vorgang(); // Vorgang | 

try {
    final result = await api_instance.vorgangIdPut(vorgangId, vorgang);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->vorgangIdPut: $e\n');
}

import org.openapitools.client.api.VorgangApi;

public class VorgangApiExample {
    public static void main(String[] args) {
        VorgangApi apiInstance = new VorgangApi();
        UUID vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to create or update
        Vorgang vorgang = ; // Vorgang | 

        try {
            apiInstance.vorgangIdPut(vorgangId, vorgang);
        } catch (ApiException e) {
            System.err.println("Exception when calling VorgangApi#vorgangIdPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
VorgangApi *apiInstance = [[VorgangApi alloc] init];
UUID *vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique identifier (UUID) of the legislative process to create or update (default to null)
Vorgang *vorgang = ; // 

[apiInstance vorgangIdPutWith:vorgangId
    vorgang:vorgang
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.VorgangApi()
var vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Unique identifier (UUID) of the legislative process to create or update
var vorgang = ; // {Vorgang} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.vorgangIdPut(vorgangId, vorgang, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class vorgangIdPutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new VorgangApi();
            var vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Unique identifier (UUID) of the legislative process to create or update (default to null)
            var vorgang = new Vorgang(); // Vorgang | 

            try {
                apiInstance.vorgangIdPut(vorgangId, vorgang);
            } catch (Exception e) {
                Debug.Print("Exception when calling VorgangApi.vorgangIdPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VorgangApi();
$vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique identifier (UUID) of the legislative process to create or update
$vorgang = ; // Vorgang | 

try {
    $api_instance->vorgangIdPut($vorgangId, $vorgang);
} catch (Exception $e) {
    echo 'Exception when calling VorgangApi->vorgangIdPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VorgangApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VorgangApi->new();
my $vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique identifier (UUID) of the legislative process to create or update
my $vorgang = WWW::OPenAPIClient::Object::Vorgang->new(); # Vorgang | 

eval {
    $api_instance->vorgangIdPut(vorgangId => $vorgangId, vorgang => $vorgang);
};
if ($@) {
    warn "Exception when calling VorgangApi->vorgangIdPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VorgangApi()
vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique identifier (UUID) of the legislative process to create or update (default to null)
vorgang =  # Vorgang | 

try:
    api_instance.vorgang_id_put(vorgangId, vorgang)
except ApiException as e:
    print("Exception when calling VorgangApi->vorgangIdPut: %s\n" % e)
extern crate VorgangApi;

pub fn main() {
    let vorgangId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let vorgang = ; // Vorgang

    let mut context = VorgangApi::Context::default();
    let result = client.vorgangIdPut(vorgangId, vorgang, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vorgang_id*
UUID (uuid)
Unique identifier (UUID) of the legislative process to create or update
Required
Body parameters
Name Description
vorgang *

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

vorgangPut

Collector interface for inserting a new legislative process. Processes are automatically deduplicated against existing data and merged if necessary. Used by data collection services to add new legislative processes to the system.


/api/v2/vorgang

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Content-Type: application/json" \
 "http://localhost/api/v2/vorgang" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VorgangApi;

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

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

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        VorgangApi apiInstance = new VorgangApi();
        UUID xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
        Vorgang vorgang = ; // Vorgang | 

        try {
            apiInstance.vorgangPut(xScraperId, vorgang);
        } catch (ApiException e) {
            System.err.println("Exception when calling VorgangApi#vorgangPut");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID xScraperId = new UUID(); // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
final Vorgang vorgang = new Vorgang(); // Vorgang | 

try {
    final result = await api_instance.vorgangPut(xScraperId, vorgang);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->vorgangPut: $e\n');
}

import org.openapitools.client.api.VorgangApi;

public class VorgangApiExample {
    public static void main(String[] args) {
        VorgangApi apiInstance = new VorgangApi();
        UUID xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
        Vorgang vorgang = ; // Vorgang | 

        try {
            apiInstance.vorgangPut(xScraperId, vorgang);
        } catch (ApiException e) {
            System.err.println("Exception when calling VorgangApi#vorgangPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
VorgangApi *apiInstance = [[VorgangApi alloc] init];
UUID *xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The Scraper ID to use for the request. Used to identify the scraper that submitted the request. (default to null)
Vorgang *vorgang = ; // 

[apiInstance vorgangPutWith:xScraperId
    vorgang:vorgang
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var LtzfApi = require('ltzf_api');
var defaultClient = LtzfApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new LtzfApi.VorgangApi()
var xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
var vorgang = ; // {Vorgang} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.vorgangPut(xScraperId, vorgang, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class vorgangPutExample
    {
        public void main()
        {
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new VorgangApi();
            var xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request. (default to null)
            var vorgang = new Vorgang(); // Vorgang | 

            try {
                apiInstance.vorgangPut(xScraperId, vorgang);
            } catch (Exception e) {
                Debug.Print("Exception when calling VorgangApi.vorgangPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VorgangApi();
$xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
$vorgang = ; // Vorgang | 

try {
    $api_instance->vorgangPut($xScraperId, $vorgang);
} catch (Exception $e) {
    echo 'Exception when calling VorgangApi->vorgangPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VorgangApi;

# Configure API key authorization: apiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VorgangApi->new();
my $xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
my $vorgang = WWW::OPenAPIClient::Object::Vorgang->new(); # Vorgang | 

eval {
    $api_instance->vorgangPut(xScraperId => $xScraperId, vorgang => $vorgang);
};
if ($@) {
    warn "Exception when calling VorgangApi->vorgangPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.VorgangApi()
xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The Scraper ID to use for the request. Used to identify the scraper that submitted the request. (default to null)
vorgang =  # Vorgang | 

try:
    api_instance.vorgang_put(xScraperId, vorgang)
except ApiException as e:
    print("Exception when calling VorgangApi->vorgangPut: %s\n" % e)
extern crate VorgangApi;

pub fn main() {
    let xScraperId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let vorgang = ; // Vorgang

    let mut context = VorgangApi::Context::default();
    let result = client.vorgangPut(xScraperId, vorgang, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
X-Scraper-Id*
UUID (uuid)
The Scraper ID to use for the request. Used to identify the scraper that submitted the request.
Required
Body parameters
Name Description
vorgang *

Complete representation of the legislative process to insert

Responses

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time

Name Type Format Description
X-RateLimit-Limit Integer
X-RateLimit-Remaining Integer
X-RateLimit-Reset Date date-time