Open Raadsinformatie API.

Attachments

downloadAttachmentById

Download specific attachment


/attachments/{attachmentId}/download

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/attachments/{attachmentId}/download"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentsApi;

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

public class AttachmentsApiExample {

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

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

        AttachmentsApi apiInstance = new AttachmentsApi();
        Integer attachmentId = 56; // Integer | Attachment ID
        try {
            byte[] result = apiInstance.downloadAttachmentById(attachmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentsApi#downloadAttachmentById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentsApi;

public class AttachmentsApiExample {

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

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

[apiInstance downloadAttachmentByIdWith:attachmentId
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.AttachmentsApi()
var attachmentId = 56; // {{Integer}} Attachment ID

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

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

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

            var apiInstance = new AttachmentsApi();
            var attachmentId = 56;  // Integer | Attachment ID

            try
            {
                byte[] result = apiInstance.downloadAttachmentById(attachmentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttachmentsApi.downloadAttachmentById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAttachmentsApi();
$attachmentId = 56; // Integer | Attachment ID

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

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

my $api_instance = WWW::SwaggerClient::AttachmentsApi->new();
my $attachmentId = 56; # Integer | Attachment ID

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

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

# create an instance of the API class
api_instance = swagger_client.AttachmentsApi()
attachmentId = 56 # Integer | Attachment ID

try: 
    api_response = api_instance.download_attachment_by_id(attachmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttachmentsApi->downloadAttachmentById: %s\n" % e)

Parameters

Path parameters
Name Description
attachmentId*
Integer
Attachment ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getAttachmentById

Retrieve specific attachment


/attachments/{attachmentId}

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/attachments/{attachmentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentsApi;

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

public class AttachmentsApiExample {

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

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

        AttachmentsApi apiInstance = new AttachmentsApi();
        Integer attachmentId = 56; // Integer | Attachment ID
        try {
            Attachment result = apiInstance.getAttachmentById(attachmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentsApi#getAttachmentById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentsApi;

public class AttachmentsApiExample {

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

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

[apiInstance getAttachmentByIdWith:attachmentId
              completionHandler: ^(Attachment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.AttachmentsApi()
var attachmentId = 56; // {{Integer}} Attachment ID

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

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

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

            var apiInstance = new AttachmentsApi();
            var attachmentId = 56;  // Integer | Attachment ID

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

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

$api_instance = new Swagger\Client\ApiAttachmentsApi();
$attachmentId = 56; // Integer | Attachment ID

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

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

my $api_instance = WWW::SwaggerClient::AttachmentsApi->new();
my $attachmentId = 56; # Integer | Attachment ID

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

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

# create an instance of the API class
api_instance = swagger_client.AttachmentsApi()
attachmentId = 56 # Integer | Attachment ID

try: 
    api_response = api_instance.get_attachment_by_id(attachmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttachmentsApi->getAttachmentById: %s\n" % e)

Parameters

Path parameters
Name Description
attachmentId*
Integer
Attachment ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getEventAttachments

Retrieve a list of attachments based on event


/events/{eventId}/attachments

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/events/{eventId}/attachments?id=&fileName=&isBundle=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentsApi;

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

public class AttachmentsApiExample {

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

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

        AttachmentsApi apiInstance = new AttachmentsApi();
        Integer eventId = 56; // Integer | Event ID
        Long id = 789; // Long | unique identifier of attachement
        String fileName = fileName_example; // String | name of file
        Long isBundle = 789; // Long | if this document is created of multiple documents
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Attachment] result = apiInstance.getEventAttachments(eventId, id, fileName, isBundle, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentsApi#getEventAttachments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AttachmentsApi;

public class AttachmentsApiExample {

    public static void main(String[] args) {
        AttachmentsApi apiInstance = new AttachmentsApi();
        Integer eventId = 56; // Integer | Event ID
        Long id = 789; // Long | unique identifier of attachement
        String fileName = fileName_example; // String | name of file
        Long isBundle = 789; // Long | if this document is created of multiple documents
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Attachment] result = apiInstance.getEventAttachments(eventId, id, fileName, isBundle, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentsApi#getEventAttachments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *eventId = 56; // Event ID
Long *id = 789; // unique identifier of attachement (optional)
String *fileName = fileName_example; // name of file (optional)
Long *isBundle = 789; // if this document is created of multiple documents (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getEventAttachmentsWith:eventId
    id:id
    fileName:fileName
    isBundle:isBundle
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Attachment] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.AttachmentsApi()
var eventId = 56; // {{Integer}} Event ID
var opts = { 
  'id': 789, // {{Long}} unique identifier of attachement
  'fileName': fileName_example, // {{String}} name of file
  'isBundle': 789, // {{Long}} if this document is created of multiple documents
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new AttachmentsApi();
            var eventId = 56;  // Integer | Event ID
            var id = 789;  // Long | unique identifier of attachement (optional) 
            var fileName = fileName_example;  // String | name of file (optional) 
            var isBundle = 789;  // Long | if this document is created of multiple documents (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Attachment] result = apiInstance.getEventAttachments(eventId, id, fileName, isBundle, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AttachmentsApi.getEventAttachments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiAttachmentsApi();
$eventId = 56; // Integer | Event ID
$id = 789; // Long | unique identifier of attachement
$fileName = fileName_example; // String | name of file
$isBundle = 789; // Long | if this document is created of multiple documents
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getEventAttachments($eventId, $id, $fileName, $isBundle, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentsApi->getEventAttachments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AttachmentsApi;

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

my $api_instance = WWW::SwaggerClient::AttachmentsApi->new();
my $eventId = 56; # Integer | Event ID
my $id = 789; # Long | unique identifier of attachement
my $fileName = fileName_example; # String | name of file
my $isBundle = 789; # Long | if this document is created of multiple documents
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getEventAttachments(eventId => $eventId, id => $id, fileName => $fileName, isBundle => $isBundle, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttachmentsApi->getEventAttachments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AttachmentsApi()
eventId = 56 # Integer | Event ID
id = 789 # Long | unique identifier of attachement (optional)
fileName = fileName_example # String | name of file (optional)
isBundle = 789 # Long | if this document is created of multiple documents (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_event_attachments(eventId, id=id, fileName=fileName, isBundle=isBundle, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttachmentsApi->getEventAttachments: %s\n" % e)

Parameters

Path parameters
Name Description
eventId*
Integer
Event ID
Required
Query parameters
Name Description
id
Long (int64)
unique identifier of attachement
fileName
String
name of file
isBundle
Long (int64)
if this document is created of multiple documents
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


DMUs

getDmuById

Retrieve specific decision making unit (Dutch; orgaan)


/dmus/{dmuId}

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/dmus/{dmuId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DMUsApi;

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

public class DMUsApiExample {

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

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

        DMUsApi apiInstance = new DMUsApi();
        Integer dmuId = 56; // Integer | DMU ID
        try {
            Dmu result = apiInstance.getDmuById(dmuId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DMUsApi#getDmuById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DMUsApi;

public class DMUsApiExample {

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

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

[apiInstance getDmuByIdWith:dmuId
              completionHandler: ^(Dmu output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.DMUsApi()
var dmuId = 56; // {{Integer}} DMU ID

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

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

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

            var apiInstance = new DMUsApi();
            var dmuId = 56;  // Integer | DMU ID

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

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

$api_instance = new Swagger\Client\ApiDMUsApi();
$dmuId = 56; // Integer | DMU ID

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

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

my $api_instance = WWW::SwaggerClient::DMUsApi->new();
my $dmuId = 56; # Integer | DMU ID

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

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

# create an instance of the API class
api_instance = swagger_client.DMUsApi()
dmuId = 56 # Integer | DMU ID

try: 
    api_response = api_instance.get_dmu_by_id(dmuId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DMUsApi->getDmuById: %s\n" % e)

Parameters

Path parameters
Name Description
dmuId*
Integer
DMU ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getDmus

Retrieve a list of decision making units (Dutch; organen).


/dmus/

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/dmus/?id=&name=&sortOrder=&sortOrder_from=&sortOrder_to=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DMUsApi;

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

public class DMUsApiExample {

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

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

        DMUsApi apiInstance = new DMUsApi();
        Long id = 789; // Long | Unique identifier of dmu
        String name = name_example; // String | Name of dmu
        Long sortOrder = 789; // Long | position of item in list of items
        Long sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
        Long sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Dmu] result = apiInstance.getDmus(id, name, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DMUsApi#getDmus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DMUsApi;

public class DMUsApiExample {

    public static void main(String[] args) {
        DMUsApi apiInstance = new DMUsApi();
        Long id = 789; // Long | Unique identifier of dmu
        String name = name_example; // String | Name of dmu
        Long sortOrder = 789; // Long | position of item in list of items
        Long sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
        Long sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Dmu] result = apiInstance.getDmus(id, name, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DMUsApi#getDmus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Unique identifier of dmu (optional)
String *name = name_example; // Name of dmu (optional)
Long *sortOrder = 789; // position of item in list of items (optional)
Long *sortOrderFrom = 789; // Filter on sortOrder that is equals or greater than value (optional)
Long *sortOrderTo = 789; // Filter on sortOrder that is equals or smaller than value (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getDmusWith:id
    name:name
    sortOrder:sortOrder
    sortOrderFrom:sortOrderFrom
    sortOrderTo:sortOrderTo
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Dmu] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.DMUsApi()
var opts = { 
  'id': 789, // {{Long}} Unique identifier of dmu
  'name': name_example, // {{String}} Name of dmu
  'sortOrder': 789, // {{Long}} position of item in list of items
  'sortOrderFrom': 789, // {{Long}} Filter on sortOrder that is equals or greater than value
  'sortOrderTo': 789, // {{Long}} Filter on sortOrder that is equals or smaller than value
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new DMUsApi();
            var id = 789;  // Long | Unique identifier of dmu (optional) 
            var name = name_example;  // String | Name of dmu (optional) 
            var sortOrder = 789;  // Long | position of item in list of items (optional) 
            var sortOrderFrom = 789;  // Long | Filter on sortOrder that is equals or greater than value (optional) 
            var sortOrderTo = 789;  // Long | Filter on sortOrder that is equals or smaller than value (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Dmu] result = apiInstance.getDmus(id, name, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DMUsApi.getDmus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDMUsApi();
$id = 789; // Long | Unique identifier of dmu
$name = name_example; // String | Name of dmu
$sortOrder = 789; // Long | position of item in list of items
$sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
$sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getDmus($id, $name, $sortOrder, $sortOrderFrom, $sortOrderTo, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DMUsApi->getDmus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DMUsApi;

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

my $api_instance = WWW::SwaggerClient::DMUsApi->new();
my $id = 789; # Long | Unique identifier of dmu
my $name = name_example; # String | Name of dmu
my $sortOrder = 789; # Long | position of item in list of items
my $sortOrderFrom = 789; # Long | Filter on sortOrder that is equals or greater than value
my $sortOrderTo = 789; # Long | Filter on sortOrder that is equals or smaller than value
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getDmus(id => $id, name => $name, sortOrder => $sortOrder, sortOrderFrom => $sortOrderFrom, sortOrderTo => $sortOrderTo, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DMUsApi->getDmus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.DMUsApi()
id = 789 # Long | Unique identifier of dmu (optional)
name = name_example # String | Name of dmu (optional)
sortOrder = 789 # Long | position of item in list of items (optional)
sortOrderFrom = 789 # Long | Filter on sortOrder that is equals or greater than value (optional)
sortOrderTo = 789 # Long | Filter on sortOrder that is equals or smaller than value (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_dmus(id=id, name=name, sortOrder=sortOrder, sortOrderFrom=sortOrderFrom, sortOrderTo=sortOrderTo, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DMUsApi->getDmus: %s\n" % e)

Parameters

Query parameters
Name Description
id
Long (int64)
Unique identifier of dmu
name
String
Name of dmu
sortOrder
Long (int64)
position of item in list of items
sortOrder_from
Long (int64)
Filter on sortOrder that is equals or greater than value
sortOrder_to
Long (int64)
Filter on sortOrder that is equals or smaller than value
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK


getMeetingsByDmuId

Retrieve a list of meetings based on decision making units (Dutch; organen).


/dmus/{dmuId}/meetings

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/dmus/{dmuId}/meetings?id=&date=&date_from=&date_to=&confidential=&location=&description=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DMUsApi;

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

public class DMUsApiExample {

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

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

        DMUsApi apiInstance = new DMUsApi();
        Integer dmuId = 56; // Integer | DMU ID
        Long id = 789; // Long | Unique identifier of meeting
        String date = date_example; // String | date
        date dateFrom = 2013-10-20; // date | Start date
        date dateTo = 2013-10-20; // date | End date
        Long confidential = 789; // Long | Filter on confidentiality, 0 stand for public and 0 for confidential
        String location = location_example; // String | Filter on location name
        String description = description_example; // String | Filter on description
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Meeting] result = apiInstance.getMeetingsByDmuId(dmuId, id, date, dateFrom, dateTo, confidential, location, description, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DMUsApi#getMeetingsByDmuId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DMUsApi;

public class DMUsApiExample {

    public static void main(String[] args) {
        DMUsApi apiInstance = new DMUsApi();
        Integer dmuId = 56; // Integer | DMU ID
        Long id = 789; // Long | Unique identifier of meeting
        String date = date_example; // String | date
        date dateFrom = 2013-10-20; // date | Start date
        date dateTo = 2013-10-20; // date | End date
        Long confidential = 789; // Long | Filter on confidentiality, 0 stand for public and 0 for confidential
        String location = location_example; // String | Filter on location name
        String description = description_example; // String | Filter on description
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Meeting] result = apiInstance.getMeetingsByDmuId(dmuId, id, date, dateFrom, dateTo, confidential, location, description, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DMUsApi#getMeetingsByDmuId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *dmuId = 56; // DMU ID
Long *id = 789; // Unique identifier of meeting (optional)
String *date = date_example; // date (optional)
date *dateFrom = 2013-10-20; // Start date (optional)
date *dateTo = 2013-10-20; // End date (optional)
Long *confidential = 789; // Filter on confidentiality, 0 stand for public and 0 for confidential (optional)
String *location = location_example; // Filter on location name (optional)
String *description = description_example; // Filter on description (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getMeetingsByDmuIdWith:dmuId
    id:id
    date:date
    dateFrom:dateFrom
    dateTo:dateTo
    confidential:confidential
    location:location
    description:description
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Meeting] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.DMUsApi()
var dmuId = 56; // {{Integer}} DMU ID
var opts = { 
  'id': 789, // {{Long}} Unique identifier of meeting
  'date': date_example, // {{String}} date
  'dateFrom': 2013-10-20, // {{date}} Start date
  'dateTo': 2013-10-20, // {{date}} End date
  'confidential': 789, // {{Long}} Filter on confidentiality, 0 stand for public and 0 for confidential
  'location': location_example, // {{String}} Filter on location name
  'description': description_example, // {{String}} Filter on description
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new DMUsApi();
            var dmuId = 56;  // Integer | DMU ID
            var id = 789;  // Long | Unique identifier of meeting (optional) 
            var date = date_example;  // String | date (optional) 
            var dateFrom = 2013-10-20;  // date | Start date (optional) 
            var dateTo = 2013-10-20;  // date | End date (optional) 
            var confidential = 789;  // Long | Filter on confidentiality, 0 stand for public and 0 for confidential (optional) 
            var location = location_example;  // String | Filter on location name (optional) 
            var description = description_example;  // String | Filter on description (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Meeting] result = apiInstance.getMeetingsByDmuId(dmuId, id, date, dateFrom, dateTo, confidential, location, description, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DMUsApi.getMeetingsByDmuId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDMUsApi();
$dmuId = 56; // Integer | DMU ID
$id = 789; // Long | Unique identifier of meeting
$date = date_example; // String | date
$dateFrom = 2013-10-20; // date | Start date
$dateTo = 2013-10-20; // date | End date
$confidential = 789; // Long | Filter on confidentiality, 0 stand for public and 0 for confidential
$location = location_example; // String | Filter on location name
$description = description_example; // String | Filter on description
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getMeetingsByDmuId($dmuId, $id, $date, $dateFrom, $dateTo, $confidential, $location, $description, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DMUsApi->getMeetingsByDmuId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DMUsApi;

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

my $api_instance = WWW::SwaggerClient::DMUsApi->new();
my $dmuId = 56; # Integer | DMU ID
my $id = 789; # Long | Unique identifier of meeting
my $date = date_example; # String | date
my $dateFrom = 2013-10-20; # date | Start date
my $dateTo = 2013-10-20; # date | End date
my $confidential = 789; # Long | Filter on confidentiality, 0 stand for public and 0 for confidential
my $location = location_example; # String | Filter on location name
my $description = description_example; # String | Filter on description
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getMeetingsByDmuId(dmuId => $dmuId, id => $id, date => $date, dateFrom => $dateFrom, dateTo => $dateTo, confidential => $confidential, location => $location, description => $description, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DMUsApi->getMeetingsByDmuId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.DMUsApi()
dmuId = 56 # Integer | DMU ID
id = 789 # Long | Unique identifier of meeting (optional)
date = date_example # String | date (optional)
dateFrom = 2013-10-20 # date | Start date (optional)
dateTo = 2013-10-20 # date | End date (optional)
confidential = 789 # Long | Filter on confidentiality, 0 stand for public and 0 for confidential (optional)
location = location_example # String | Filter on location name (optional)
description = description_example # String | Filter on description (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_meetings_by_dmu_id(dmuId, id=id, date=date, dateFrom=dateFrom, dateTo=dateTo, confidential=confidential, location=location, description=description, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DMUsApi->getMeetingsByDmuId: %s\n" % e)

Parameters

Path parameters
Name Description
dmuId*
Integer
DMU ID
Required
Query parameters
Name Description
id
Long (int64)
Unique identifier of meeting
date
String
date
date_from
date (date)
Start date
date_to
date (date)
End date
confidential
Long (int64)
Filter on confidentiality, 0 stand for public and 0 for confidential
location
String
Filter on location name
description
String
Filter on description
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK


Documents

downloadDocument

Download a document based on id


/documents/{documentId}/download

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/documents/{documentId}/download"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentsApi;

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

public class DocumentsApiExample {

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

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

        DocumentsApi apiInstance = new DocumentsApi();
        Integer documentId = 56; // Integer | Document ID
        try {
            byte[] result = apiInstance.downloadDocument(documentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#downloadDocument");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentsApi;

public class DocumentsApiExample {

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

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

[apiInstance downloadDocumentWith:documentId
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.DocumentsApi()
var documentId = 56; // {{Integer}} Document ID

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

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

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

            var apiInstance = new DocumentsApi();
            var documentId = 56;  // Integer | Document ID

            try
            {
                byte[] result = apiInstance.downloadDocument(documentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentsApi.downloadDocument: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDocumentsApi();
$documentId = 56; // Integer | Document ID

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

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

my $api_instance = WWW::SwaggerClient::DocumentsApi->new();
my $documentId = 56; # Integer | Document ID

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

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

# create an instance of the API class
api_instance = swagger_client.DocumentsApi()
documentId = 56 # Integer | Document ID

try: 
    api_response = api_instance.download_document(documentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->downloadDocument: %s\n" % e)

Parameters

Path parameters
Name Description
documentId*
Integer
Document ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getDocument

Retrieve document metadata based on id


/documents/{documentId}

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/documents/{documentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentsApi;

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

public class DocumentsApiExample {

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

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

        DocumentsApi apiInstance = new DocumentsApi();
        Integer documentId = 56; // Integer | Document ID
        try {
            Document result = apiInstance.getDocument(documentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#getDocument");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentsApi;

public class DocumentsApiExample {

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

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

[apiInstance getDocumentWith:documentId
              completionHandler: ^(Document output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.DocumentsApi()
var documentId = 56; // {{Integer}} Document ID

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

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

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

            var apiInstance = new DocumentsApi();
            var documentId = 56;  // Integer | Document ID

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

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

$api_instance = new Swagger\Client\ApiDocumentsApi();
$documentId = 56; // Integer | Document ID

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

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

my $api_instance = WWW::SwaggerClient::DocumentsApi->new();
my $documentId = 56; # Integer | Document ID

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

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

# create an instance of the API class
api_instance = swagger_client.DocumentsApi()
documentId = 56 # Integer | Document ID

try: 
    api_response = api_instance.get_document(documentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->getDocument: %s\n" % e)

Parameters

Path parameters
Name Description
documentId*
Integer
Document ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getMeetingDocuments

Retrieve a list of documents based on meeting


/meetings/{meetingId}/documents

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/meetings/{meetingId}/documents?id=&confidential=&fileName=&documentTypeLabel=&description=&fileSize=&fileSize_from=&fileSize_to=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentsApi;

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

public class DocumentsApiExample {

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

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

        DocumentsApi apiInstance = new DocumentsApi();
        Integer meetingId = 56; // Integer | Meeting ID
        Long id = 789; // Long | Filter unique identifier of document
        Long confidential = 789; // Long | Filter on confidentiality, 0 is public and 1 is confidential
        String fileName = fileName_example; // String | Filter on file name
        String documentTypeLabel = documentTypeLabel_example; // String | Filter on type of document
        String description = description_example; // String | Filter on description
        Long fileSize = 789; // Long | Filter on file size
        Long fileSizeFrom = 789; // Long | Filter on file size that is equals or creater than value
        Long fileSizeTo = 789; // Long | Filter on file size that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Document] result = apiInstance.getMeetingDocuments(meetingId, id, confidential, fileName, documentTypeLabel, description, fileSize, fileSizeFrom, fileSizeTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#getMeetingDocuments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentsApi;

public class DocumentsApiExample {

    public static void main(String[] args) {
        DocumentsApi apiInstance = new DocumentsApi();
        Integer meetingId = 56; // Integer | Meeting ID
        Long id = 789; // Long | Filter unique identifier of document
        Long confidential = 789; // Long | Filter on confidentiality, 0 is public and 1 is confidential
        String fileName = fileName_example; // String | Filter on file name
        String documentTypeLabel = documentTypeLabel_example; // String | Filter on type of document
        String description = description_example; // String | Filter on description
        Long fileSize = 789; // Long | Filter on file size
        Long fileSizeFrom = 789; // Long | Filter on file size that is equals or creater than value
        Long fileSizeTo = 789; // Long | Filter on file size that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Document] result = apiInstance.getMeetingDocuments(meetingId, id, confidential, fileName, documentTypeLabel, description, fileSize, fileSizeFrom, fileSizeTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#getMeetingDocuments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *meetingId = 56; // Meeting ID
Long *id = 789; // Filter unique identifier of document (optional)
Long *confidential = 789; // Filter on confidentiality, 0 is public and 1 is confidential (optional)
String *fileName = fileName_example; // Filter on file name (optional)
String *documentTypeLabel = documentTypeLabel_example; // Filter on type of document (optional)
String *description = description_example; // Filter on description (optional)
Long *fileSize = 789; // Filter on file size (optional)
Long *fileSizeFrom = 789; // Filter on file size that is equals or creater than value (optional)
Long *fileSizeTo = 789; // Filter on file size that is equals or smaller than value (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getMeetingDocumentsWith:meetingId
    id:id
    confidential:confidential
    fileName:fileName
    documentTypeLabel:documentTypeLabel
    description:description
    fileSize:fileSize
    fileSizeFrom:fileSizeFrom
    fileSizeTo:fileSizeTo
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Document] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.DocumentsApi()
var meetingId = 56; // {{Integer}} Meeting ID
var opts = { 
  'id': 789, // {{Long}} Filter unique identifier of document
  'confidential': 789, // {{Long}} Filter on confidentiality, 0 is public and 1 is confidential
  'fileName': fileName_example, // {{String}} Filter on file name
  'documentTypeLabel': documentTypeLabel_example, // {{String}} Filter on type of document
  'description': description_example, // {{String}} Filter on description
  'fileSize': 789, // {{Long}} Filter on file size
  'fileSizeFrom': 789, // {{Long}} Filter on file size that is equals or creater than value
  'fileSizeTo': 789, // {{Long}} Filter on file size that is equals or smaller than value
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new DocumentsApi();
            var meetingId = 56;  // Integer | Meeting ID
            var id = 789;  // Long | Filter unique identifier of document (optional) 
            var confidential = 789;  // Long | Filter on confidentiality, 0 is public and 1 is confidential (optional) 
            var fileName = fileName_example;  // String | Filter on file name (optional) 
            var documentTypeLabel = documentTypeLabel_example;  // String | Filter on type of document (optional) 
            var description = description_example;  // String | Filter on description (optional) 
            var fileSize = 789;  // Long | Filter on file size (optional) 
            var fileSizeFrom = 789;  // Long | Filter on file size that is equals or creater than value (optional) 
            var fileSizeTo = 789;  // Long | Filter on file size that is equals or smaller than value (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Document] result = apiInstance.getMeetingDocuments(meetingId, id, confidential, fileName, documentTypeLabel, description, fileSize, fileSizeFrom, fileSizeTo, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentsApi.getMeetingDocuments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDocumentsApi();
$meetingId = 56; // Integer | Meeting ID
$id = 789; // Long | Filter unique identifier of document
$confidential = 789; // Long | Filter on confidentiality, 0 is public and 1 is confidential
$fileName = fileName_example; // String | Filter on file name
$documentTypeLabel = documentTypeLabel_example; // String | Filter on type of document
$description = description_example; // String | Filter on description
$fileSize = 789; // Long | Filter on file size
$fileSizeFrom = 789; // Long | Filter on file size that is equals or creater than value
$fileSizeTo = 789; // Long | Filter on file size that is equals or smaller than value
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getMeetingDocuments($meetingId, $id, $confidential, $fileName, $documentTypeLabel, $description, $fileSize, $fileSizeFrom, $fileSizeTo, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->getMeetingDocuments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentsApi;

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

my $api_instance = WWW::SwaggerClient::DocumentsApi->new();
my $meetingId = 56; # Integer | Meeting ID
my $id = 789; # Long | Filter unique identifier of document
my $confidential = 789; # Long | Filter on confidentiality, 0 is public and 1 is confidential
my $fileName = fileName_example; # String | Filter on file name
my $documentTypeLabel = documentTypeLabel_example; # String | Filter on type of document
my $description = description_example; # String | Filter on description
my $fileSize = 789; # Long | Filter on file size
my $fileSizeFrom = 789; # Long | Filter on file size that is equals or creater than value
my $fileSizeTo = 789; # Long | Filter on file size that is equals or smaller than value
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getMeetingDocuments(meetingId => $meetingId, id => $id, confidential => $confidential, fileName => $fileName, documentTypeLabel => $documentTypeLabel, description => $description, fileSize => $fileSize, fileSizeFrom => $fileSizeFrom, fileSizeTo => $fileSizeTo, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentsApi->getMeetingDocuments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.DocumentsApi()
meetingId = 56 # Integer | Meeting ID
id = 789 # Long | Filter unique identifier of document (optional)
confidential = 789 # Long | Filter on confidentiality, 0 is public and 1 is confidential (optional)
fileName = fileName_example # String | Filter on file name (optional)
documentTypeLabel = documentTypeLabel_example # String | Filter on type of document (optional)
description = description_example # String | Filter on description (optional)
fileSize = 789 # Long | Filter on file size (optional)
fileSizeFrom = 789 # Long | Filter on file size that is equals or creater than value (optional)
fileSizeTo = 789 # Long | Filter on file size that is equals or smaller than value (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_meeting_documents(meetingId, id=id, confidential=confidential, fileName=fileName, documentTypeLabel=documentTypeLabel, description=description, fileSize=fileSize, fileSizeFrom=fileSizeFrom, fileSizeTo=fileSizeTo, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->getMeetingDocuments: %s\n" % e)

Parameters

Path parameters
Name Description
meetingId*
Integer
Meeting ID
Required
Query parameters
Name Description
id
Long (int64)
Filter unique identifier of document
confidential
Long (int64)
Filter on confidentiality, 0 is public and 1 is confidential
fileName
String
Filter on file name
documentTypeLabel
String
Filter on type of document
description
String
Filter on description
fileSize
Long (int64)
Filter on file size
fileSize_from
Long (int64)
Filter on file size that is equals or creater than value
fileSize_to
Long (int64)
Filter on file size that is equals or smaller than value
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getMeetingItemDocuments

Retrieve a list of documents based on meeting items


/meetingitems/{meetingItemId}/documents

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/meetingitems/{meetingItemId}/documents?id=&confidential=&fileName=&documentTypeLabel=&description=&fileSize=&fileSize_from=&fileSize_to=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentsApi;

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

public class DocumentsApiExample {

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

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

        DocumentsApi apiInstance = new DocumentsApi();
        Integer meetingItemId = 56; // Integer | Meeting item ID
        Long id = 789; // Long | Filter unique identifier of document
        Long confidential = 789; // Long | Filter on confidentiality, 0 is public and 1 is confidential
        String fileName = fileName_example; // String | Filter on file name
        String documentTypeLabel = documentTypeLabel_example; // String | Filter on type of document
        String description = description_example; // String | Filter on description
        Long fileSize = 789; // Long | Filter on file size
        Long fileSizeFrom = 789; // Long | Filter on file size that is equals or creater than value
        Long fileSizeTo = 789; // Long | Filter on file size that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Document] result = apiInstance.getMeetingItemDocuments(meetingItemId, id, confidential, fileName, documentTypeLabel, description, fileSize, fileSizeFrom, fileSizeTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#getMeetingItemDocuments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentsApi;

public class DocumentsApiExample {

    public static void main(String[] args) {
        DocumentsApi apiInstance = new DocumentsApi();
        Integer meetingItemId = 56; // Integer | Meeting item ID
        Long id = 789; // Long | Filter unique identifier of document
        Long confidential = 789; // Long | Filter on confidentiality, 0 is public and 1 is confidential
        String fileName = fileName_example; // String | Filter on file name
        String documentTypeLabel = documentTypeLabel_example; // String | Filter on type of document
        String description = description_example; // String | Filter on description
        Long fileSize = 789; // Long | Filter on file size
        Long fileSizeFrom = 789; // Long | Filter on file size that is equals or creater than value
        Long fileSizeTo = 789; // Long | Filter on file size that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Document] result = apiInstance.getMeetingItemDocuments(meetingItemId, id, confidential, fileName, documentTypeLabel, description, fileSize, fileSizeFrom, fileSizeTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentsApi#getMeetingItemDocuments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *meetingItemId = 56; // Meeting item ID
Long *id = 789; // Filter unique identifier of document (optional)
Long *confidential = 789; // Filter on confidentiality, 0 is public and 1 is confidential (optional)
String *fileName = fileName_example; // Filter on file name (optional)
String *documentTypeLabel = documentTypeLabel_example; // Filter on type of document (optional)
String *description = description_example; // Filter on description (optional)
Long *fileSize = 789; // Filter on file size (optional)
Long *fileSizeFrom = 789; // Filter on file size that is equals or creater than value (optional)
Long *fileSizeTo = 789; // Filter on file size that is equals or smaller than value (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getMeetingItemDocumentsWith:meetingItemId
    id:id
    confidential:confidential
    fileName:fileName
    documentTypeLabel:documentTypeLabel
    description:description
    fileSize:fileSize
    fileSizeFrom:fileSizeFrom
    fileSizeTo:fileSizeTo
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Document] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.DocumentsApi()
var meetingItemId = 56; // {{Integer}} Meeting item ID
var opts = { 
  'id': 789, // {{Long}} Filter unique identifier of document
  'confidential': 789, // {{Long}} Filter on confidentiality, 0 is public and 1 is confidential
  'fileName': fileName_example, // {{String}} Filter on file name
  'documentTypeLabel': documentTypeLabel_example, // {{String}} Filter on type of document
  'description': description_example, // {{String}} Filter on description
  'fileSize': 789, // {{Long}} Filter on file size
  'fileSizeFrom': 789, // {{Long}} Filter on file size that is equals or creater than value
  'fileSizeTo': 789, // {{Long}} Filter on file size that is equals or smaller than value
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new DocumentsApi();
            var meetingItemId = 56;  // Integer | Meeting item ID
            var id = 789;  // Long | Filter unique identifier of document (optional) 
            var confidential = 789;  // Long | Filter on confidentiality, 0 is public and 1 is confidential (optional) 
            var fileName = fileName_example;  // String | Filter on file name (optional) 
            var documentTypeLabel = documentTypeLabel_example;  // String | Filter on type of document (optional) 
            var description = description_example;  // String | Filter on description (optional) 
            var fileSize = 789;  // Long | Filter on file size (optional) 
            var fileSizeFrom = 789;  // Long | Filter on file size that is equals or creater than value (optional) 
            var fileSizeTo = 789;  // Long | Filter on file size that is equals or smaller than value (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Document] result = apiInstance.getMeetingItemDocuments(meetingItemId, id, confidential, fileName, documentTypeLabel, description, fileSize, fileSizeFrom, fileSizeTo, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentsApi.getMeetingItemDocuments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiDocumentsApi();
$meetingItemId = 56; // Integer | Meeting item ID
$id = 789; // Long | Filter unique identifier of document
$confidential = 789; // Long | Filter on confidentiality, 0 is public and 1 is confidential
$fileName = fileName_example; // String | Filter on file name
$documentTypeLabel = documentTypeLabel_example; // String | Filter on type of document
$description = description_example; // String | Filter on description
$fileSize = 789; // Long | Filter on file size
$fileSizeFrom = 789; // Long | Filter on file size that is equals or creater than value
$fileSizeTo = 789; // Long | Filter on file size that is equals or smaller than value
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getMeetingItemDocuments($meetingItemId, $id, $confidential, $fileName, $documentTypeLabel, $description, $fileSize, $fileSizeFrom, $fileSizeTo, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->getMeetingItemDocuments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentsApi;

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

my $api_instance = WWW::SwaggerClient::DocumentsApi->new();
my $meetingItemId = 56; # Integer | Meeting item ID
my $id = 789; # Long | Filter unique identifier of document
my $confidential = 789; # Long | Filter on confidentiality, 0 is public and 1 is confidential
my $fileName = fileName_example; # String | Filter on file name
my $documentTypeLabel = documentTypeLabel_example; # String | Filter on type of document
my $description = description_example; # String | Filter on description
my $fileSize = 789; # Long | Filter on file size
my $fileSizeFrom = 789; # Long | Filter on file size that is equals or creater than value
my $fileSizeTo = 789; # Long | Filter on file size that is equals or smaller than value
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getMeetingItemDocuments(meetingItemId => $meetingItemId, id => $id, confidential => $confidential, fileName => $fileName, documentTypeLabel => $documentTypeLabel, description => $description, fileSize => $fileSize, fileSizeFrom => $fileSizeFrom, fileSizeTo => $fileSizeTo, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentsApi->getMeetingItemDocuments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.DocumentsApi()
meetingItemId = 56 # Integer | Meeting item ID
id = 789 # Long | Filter unique identifier of document (optional)
confidential = 789 # Long | Filter on confidentiality, 0 is public and 1 is confidential (optional)
fileName = fileName_example # String | Filter on file name (optional)
documentTypeLabel = documentTypeLabel_example # String | Filter on type of document (optional)
description = description_example # String | Filter on description (optional)
fileSize = 789 # Long | Filter on file size (optional)
fileSizeFrom = 789 # Long | Filter on file size that is equals or creater than value (optional)
fileSizeTo = 789 # Long | Filter on file size that is equals or smaller than value (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_meeting_item_documents(meetingItemId, id=id, confidential=confidential, fileName=fileName, documentTypeLabel=documentTypeLabel, description=description, fileSize=fileSize, fileSizeFrom=fileSizeFrom, fileSizeTo=fileSizeTo, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->getMeetingItemDocuments: %s\n" % e)

Parameters

Path parameters
Name Description
meetingItemId*
Integer
Meeting item ID
Required
Query parameters
Name Description
id
Long (int64)
Filter unique identifier of document
confidential
Long (int64)
Filter on confidentiality, 0 is public and 1 is confidential
fileName
String
Filter on file name
documentTypeLabel
String
Filter on type of document
description
String
Filter on description
fileSize
Long (int64)
Filter on file size
fileSize_from
Long (int64)
Filter on file size that is equals or creater than value
fileSize_to
Long (int64)
Filter on file size that is equals or smaller than value
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


Events

getEventById

Retrieve specific event


/events/{eventId}

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/events/{eventId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

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

public class EventsApiExample {

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

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

        EventsApi apiInstance = new EventsApi();
        Integer eventId = 56; // Integer | Event ID
        try {
            Event result = apiInstance.getEventById(eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEventById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsApi;

public class EventsApiExample {

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

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

[apiInstance getEventByIdWith:eventId
              completionHandler: ^(Event output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.EventsApi()
var eventId = 56; // {{Integer}} Event ID

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

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

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

            var apiInstance = new EventsApi();
            var eventId = 56;  // Integer | Event ID

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

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

$api_instance = new Swagger\Client\ApiEventsApi();
$eventId = 56; // Integer | Event ID

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

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

my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $eventId = 56; # Integer | Event ID

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

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

# create an instance of the API class
api_instance = swagger_client.EventsApi()
eventId = 56 # Integer | Event ID

try: 
    api_response = api_instance.get_event_by_id(eventId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->getEventById: %s\n" % e)

Parameters

Path parameters
Name Description
eventId*
Integer
Event ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getEvents

Retrieve a list of events


/events

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/events?id=&title=&fragment=&location=&description=&publicationDate=&publicationDate_from=&publicationDate_to=&startDate=&startDate_from=&startDate_to=&endDate=&endDate_from=&endDate_to=&startTime=&startTime_from=&startTime_to=&endTime=&endTime_from=&endTime_to=&confidential=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

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

public class EventsApiExample {

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

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

        EventsApi apiInstance = new EventsApi();
        Long id = 789; // Long | unique identifier of event
        String title = title_example; // String | title of event
        String fragment = fragment_example; // String | url friendly title
        String location = location_example; // String | lcoation of event
        String description = description_example; // String | description of event
        date publicationDate = 2013-10-20; // date | date of publication
        date publicationDateFrom = 2013-10-20; // date | Filter on publicationDate that is equals or creater than value
        date publicationDateTo = 2013-10-20; // date | Filter on publicationDate that is equals or smaller than value
        date startDate = 2013-10-20; // date | date when event starts
        date startDateFrom = 2013-10-20; // date | Filter on startDate that is equals or greater than value
        date startDateTo = 2013-10-20; // date | Filter on startDate_from that is equals or smaller than value
        date endDate = 2013-10-20; // date | date when event ends
        date endDateFrom = 2013-10-20; // date | Filter on endDate that is equals or greater than value
        date endDateTo = 2013-10-20; // date | Filter on endDate that is equals or smaller than value
        String startTime = startTime_example; // String | time when event starts
        String startTimeFrom = startTimeFrom_example; // String | Filter on startTime that is equals or greater than value
        String startTimeTo = startTimeTo_example; // String | Filter on startTime that is equals or smaller than value
        String endTime = endTime_example; // String | time when event ends
        String endTimeFrom = endTimeFrom_example; // String | Filter on endTime that is equals or greater than value
        String endTimeTo = endTimeTo_example; // String | Filter on endTime that is equals or smaller than value
        Long confidential = 789; // Long | Filter on confidentiality, 0 is public and 1 is confidential
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Event] result = apiInstance.getEvents(id, title, fragment, location, description, publicationDate, publicationDateFrom, publicationDateTo, startDate, startDateFrom, startDateTo, endDate, endDateFrom, endDateTo, startTime, startTimeFrom, startTimeTo, endTime, endTimeFrom, endTimeTo, confidential, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEvents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        Long id = 789; // Long | unique identifier of event
        String title = title_example; // String | title of event
        String fragment = fragment_example; // String | url friendly title
        String location = location_example; // String | lcoation of event
        String description = description_example; // String | description of event
        date publicationDate = 2013-10-20; // date | date of publication
        date publicationDateFrom = 2013-10-20; // date | Filter on publicationDate that is equals or creater than value
        date publicationDateTo = 2013-10-20; // date | Filter on publicationDate that is equals or smaller than value
        date startDate = 2013-10-20; // date | date when event starts
        date startDateFrom = 2013-10-20; // date | Filter on startDate that is equals or greater than value
        date startDateTo = 2013-10-20; // date | Filter on startDate_from that is equals or smaller than value
        date endDate = 2013-10-20; // date | date when event ends
        date endDateFrom = 2013-10-20; // date | Filter on endDate that is equals or greater than value
        date endDateTo = 2013-10-20; // date | Filter on endDate that is equals or smaller than value
        String startTime = startTime_example; // String | time when event starts
        String startTimeFrom = startTimeFrom_example; // String | Filter on startTime that is equals or greater than value
        String startTimeTo = startTimeTo_example; // String | Filter on startTime that is equals or smaller than value
        String endTime = endTime_example; // String | time when event ends
        String endTimeFrom = endTimeFrom_example; // String | Filter on endTime that is equals or greater than value
        String endTimeTo = endTimeTo_example; // String | Filter on endTime that is equals or smaller than value
        Long confidential = 789; // Long | Filter on confidentiality, 0 is public and 1 is confidential
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Event] result = apiInstance.getEvents(id, title, fragment, location, description, publicationDate, publicationDateFrom, publicationDateTo, startDate, startDateFrom, startDateTo, endDate, endDateFrom, endDateTo, startTime, startTimeFrom, startTimeTo, endTime, endTimeFrom, endTimeTo, confidential, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEvents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // unique identifier of event (optional)
String *title = title_example; // title of event (optional)
String *fragment = fragment_example; // url friendly title (optional)
String *location = location_example; // lcoation of event (optional)
String *description = description_example; // description of event (optional)
date *publicationDate = 2013-10-20; // date of publication (optional)
date *publicationDateFrom = 2013-10-20; // Filter on publicationDate that is equals or creater than value (optional)
date *publicationDateTo = 2013-10-20; // Filter on publicationDate that is equals or smaller than value (optional)
date *startDate = 2013-10-20; // date when event starts (optional)
date *startDateFrom = 2013-10-20; // Filter on startDate that is equals or greater than value (optional)
date *startDateTo = 2013-10-20; // Filter on startDate_from that is equals or smaller than value (optional)
date *endDate = 2013-10-20; // date when event ends (optional)
date *endDateFrom = 2013-10-20; // Filter on endDate that is equals or greater than value (optional)
date *endDateTo = 2013-10-20; // Filter on endDate that is equals or smaller than value (optional)
String *startTime = startTime_example; // time when event starts (optional)
String *startTimeFrom = startTimeFrom_example; // Filter on startTime that is equals or greater than value (optional)
String *startTimeTo = startTimeTo_example; // Filter on startTime that is equals or smaller than value (optional)
String *endTime = endTime_example; // time when event ends (optional)
String *endTimeFrom = endTimeFrom_example; // Filter on endTime that is equals or greater than value (optional)
String *endTimeTo = endTimeTo_example; // Filter on endTime that is equals or smaller than value (optional)
Long *confidential = 789; // Filter on confidentiality, 0 is public and 1 is confidential (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getEventsWith:id
    title:title
    fragment:fragment
    location:location
    description:description
    publicationDate:publicationDate
    publicationDateFrom:publicationDateFrom
    publicationDateTo:publicationDateTo
    startDate:startDate
    startDateFrom:startDateFrom
    startDateTo:startDateTo
    endDate:endDate
    endDateFrom:endDateFrom
    endDateTo:endDateTo
    startTime:startTime
    startTimeFrom:startTimeFrom
    startTimeTo:startTimeTo
    endTime:endTime
    endTimeFrom:endTimeFrom
    endTimeTo:endTimeTo
    confidential:confidential
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Event] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.EventsApi()
var opts = { 
  'id': 789, // {{Long}} unique identifier of event
  'title': title_example, // {{String}} title of event
  'fragment': fragment_example, // {{String}} url friendly title
  'location': location_example, // {{String}} lcoation of event
  'description': description_example, // {{String}} description of event
  'publicationDate': 2013-10-20, // {{date}} date of publication
  'publicationDateFrom': 2013-10-20, // {{date}} Filter on publicationDate that is equals or creater than value
  'publicationDateTo': 2013-10-20, // {{date}} Filter on publicationDate that is equals or smaller than value
  'startDate': 2013-10-20, // {{date}} date when event starts
  'startDateFrom': 2013-10-20, // {{date}} Filter on startDate that is equals or greater than value
  'startDateTo': 2013-10-20, // {{date}} Filter on startDate_from that is equals or smaller than value
  'endDate': 2013-10-20, // {{date}} date when event ends
  'endDateFrom': 2013-10-20, // {{date}} Filter on endDate that is equals or greater than value
  'endDateTo': 2013-10-20, // {{date}} Filter on endDate that is equals or smaller than value
  'startTime': startTime_example, // {{String}} time when event starts
  'startTimeFrom': startTimeFrom_example, // {{String}} Filter on startTime that is equals or greater than value
  'startTimeTo': startTimeTo_example, // {{String}} Filter on startTime that is equals or smaller than value
  'endTime': endTime_example, // {{String}} time when event ends
  'endTimeFrom': endTimeFrom_example, // {{String}} Filter on endTime that is equals or greater than value
  'endTimeTo': endTimeTo_example, // {{String}} Filter on endTime that is equals or smaller than value
  'confidential': 789, // {{Long}} Filter on confidentiality, 0 is public and 1 is confidential
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new EventsApi();
            var id = 789;  // Long | unique identifier of event (optional) 
            var title = title_example;  // String | title of event (optional) 
            var fragment = fragment_example;  // String | url friendly title (optional) 
            var location = location_example;  // String | lcoation of event (optional) 
            var description = description_example;  // String | description of event (optional) 
            var publicationDate = 2013-10-20;  // date | date of publication (optional) 
            var publicationDateFrom = 2013-10-20;  // date | Filter on publicationDate that is equals or creater than value (optional) 
            var publicationDateTo = 2013-10-20;  // date | Filter on publicationDate that is equals or smaller than value (optional) 
            var startDate = 2013-10-20;  // date | date when event starts (optional) 
            var startDateFrom = 2013-10-20;  // date | Filter on startDate that is equals or greater than value (optional) 
            var startDateTo = 2013-10-20;  // date | Filter on startDate_from that is equals or smaller than value (optional) 
            var endDate = 2013-10-20;  // date | date when event ends (optional) 
            var endDateFrom = 2013-10-20;  // date | Filter on endDate that is equals or greater than value (optional) 
            var endDateTo = 2013-10-20;  // date | Filter on endDate that is equals or smaller than value (optional) 
            var startTime = startTime_example;  // String | time when event starts (optional) 
            var startTimeFrom = startTimeFrom_example;  // String | Filter on startTime that is equals or greater than value (optional) 
            var startTimeTo = startTimeTo_example;  // String | Filter on startTime that is equals or smaller than value (optional) 
            var endTime = endTime_example;  // String | time when event ends (optional) 
            var endTimeFrom = endTimeFrom_example;  // String | Filter on endTime that is equals or greater than value (optional) 
            var endTimeTo = endTimeTo_example;  // String | Filter on endTime that is equals or smaller than value (optional) 
            var confidential = 789;  // Long | Filter on confidentiality, 0 is public and 1 is confidential (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Event] result = apiInstance.getEvents(id, title, fragment, location, description, publicationDate, publicationDateFrom, publicationDateTo, startDate, startDateFrom, startDateTo, endDate, endDateFrom, endDateTo, startTime, startTimeFrom, startTimeTo, endTime, endTimeFrom, endTimeTo, confidential, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.getEvents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiEventsApi();
$id = 789; // Long | unique identifier of event
$title = title_example; // String | title of event
$fragment = fragment_example; // String | url friendly title
$location = location_example; // String | lcoation of event
$description = description_example; // String | description of event
$publicationDate = 2013-10-20; // date | date of publication
$publicationDateFrom = 2013-10-20; // date | Filter on publicationDate that is equals or creater than value
$publicationDateTo = 2013-10-20; // date | Filter on publicationDate that is equals or smaller than value
$startDate = 2013-10-20; // date | date when event starts
$startDateFrom = 2013-10-20; // date | Filter on startDate that is equals or greater than value
$startDateTo = 2013-10-20; // date | Filter on startDate_from that is equals or smaller than value
$endDate = 2013-10-20; // date | date when event ends
$endDateFrom = 2013-10-20; // date | Filter on endDate that is equals or greater than value
$endDateTo = 2013-10-20; // date | Filter on endDate that is equals or smaller than value
$startTime = startTime_example; // String | time when event starts
$startTimeFrom = startTimeFrom_example; // String | Filter on startTime that is equals or greater than value
$startTimeTo = startTimeTo_example; // String | Filter on startTime that is equals or smaller than value
$endTime = endTime_example; // String | time when event ends
$endTimeFrom = endTimeFrom_example; // String | Filter on endTime that is equals or greater than value
$endTimeTo = endTimeTo_example; // String | Filter on endTime that is equals or smaller than value
$confidential = 789; // Long | Filter on confidentiality, 0 is public and 1 is confidential
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getEvents($id, $title, $fragment, $location, $description, $publicationDate, $publicationDateFrom, $publicationDateTo, $startDate, $startDateFrom, $startDateTo, $endDate, $endDateFrom, $endDateTo, $startTime, $startTimeFrom, $startTimeTo, $endTime, $endTimeFrom, $endTimeTo, $confidential, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->getEvents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;

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

my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $id = 789; # Long | unique identifier of event
my $title = title_example; # String | title of event
my $fragment = fragment_example; # String | url friendly title
my $location = location_example; # String | lcoation of event
my $description = description_example; # String | description of event
my $publicationDate = 2013-10-20; # date | date of publication
my $publicationDateFrom = 2013-10-20; # date | Filter on publicationDate that is equals or creater than value
my $publicationDateTo = 2013-10-20; # date | Filter on publicationDate that is equals or smaller than value
my $startDate = 2013-10-20; # date | date when event starts
my $startDateFrom = 2013-10-20; # date | Filter on startDate that is equals or greater than value
my $startDateTo = 2013-10-20; # date | Filter on startDate_from that is equals or smaller than value
my $endDate = 2013-10-20; # date | date when event ends
my $endDateFrom = 2013-10-20; # date | Filter on endDate that is equals or greater than value
my $endDateTo = 2013-10-20; # date | Filter on endDate that is equals or smaller than value
my $startTime = startTime_example; # String | time when event starts
my $startTimeFrom = startTimeFrom_example; # String | Filter on startTime that is equals or greater than value
my $startTimeTo = startTimeTo_example; # String | Filter on startTime that is equals or smaller than value
my $endTime = endTime_example; # String | time when event ends
my $endTimeFrom = endTimeFrom_example; # String | Filter on endTime that is equals or greater than value
my $endTimeTo = endTimeTo_example; # String | Filter on endTime that is equals or smaller than value
my $confidential = 789; # Long | Filter on confidentiality, 0 is public and 1 is confidential
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getEvents(id => $id, title => $title, fragment => $fragment, location => $location, description => $description, publicationDate => $publicationDate, publicationDateFrom => $publicationDateFrom, publicationDateTo => $publicationDateTo, startDate => $startDate, startDateFrom => $startDateFrom, startDateTo => $startDateTo, endDate => $endDate, endDateFrom => $endDateFrom, endDateTo => $endDateTo, startTime => $startTime, startTimeFrom => $startTimeFrom, startTimeTo => $startTimeTo, endTime => $endTime, endTimeFrom => $endTimeFrom, endTimeTo => $endTimeTo, confidential => $confidential, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->getEvents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.EventsApi()
id = 789 # Long | unique identifier of event (optional)
title = title_example # String | title of event (optional)
fragment = fragment_example # String | url friendly title (optional)
location = location_example # String | lcoation of event (optional)
description = description_example # String | description of event (optional)
publicationDate = 2013-10-20 # date | date of publication (optional)
publicationDateFrom = 2013-10-20 # date | Filter on publicationDate that is equals or creater than value (optional)
publicationDateTo = 2013-10-20 # date | Filter on publicationDate that is equals or smaller than value (optional)
startDate = 2013-10-20 # date | date when event starts (optional)
startDateFrom = 2013-10-20 # date | Filter on startDate that is equals or greater than value (optional)
startDateTo = 2013-10-20 # date | Filter on startDate_from that is equals or smaller than value (optional)
endDate = 2013-10-20 # date | date when event ends (optional)
endDateFrom = 2013-10-20 # date | Filter on endDate that is equals or greater than value (optional)
endDateTo = 2013-10-20 # date | Filter on endDate that is equals or smaller than value (optional)
startTime = startTime_example # String | time when event starts (optional)
startTimeFrom = startTimeFrom_example # String | Filter on startTime that is equals or greater than value (optional)
startTimeTo = startTimeTo_example # String | Filter on startTime that is equals or smaller than value (optional)
endTime = endTime_example # String | time when event ends (optional)
endTimeFrom = endTimeFrom_example # String | Filter on endTime that is equals or greater than value (optional)
endTimeTo = endTimeTo_example # String | Filter on endTime that is equals or smaller than value (optional)
confidential = 789 # Long | Filter on confidentiality, 0 is public and 1 is confidential (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_events(id=id, title=title, fragment=fragment, location=location, description=description, publicationDate=publicationDate, publicationDateFrom=publicationDateFrom, publicationDateTo=publicationDateTo, startDate=startDate, startDateFrom=startDateFrom, startDateTo=startDateTo, endDate=endDate, endDateFrom=endDateFrom, endDateTo=endDateTo, startTime=startTime, startTimeFrom=startTimeFrom, startTimeTo=startTimeTo, endTime=endTime, endTimeFrom=endTimeFrom, endTimeTo=endTimeTo, confidential=confidential, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->getEvents: %s\n" % e)

Parameters

Query parameters
Name Description
id
Long (int64)
unique identifier of event
title
String
title of event
fragment
String
url friendly title
location
String
lcoation of event
description
String
description of event
publicationDate
date (date)
date of publication
publicationDate_from
date (date)
Filter on publicationDate that is equals or creater than value
publicationDate_to
date (date)
Filter on publicationDate that is equals or smaller than value
startDate
date (date)
date when event starts
startDate_from
date (date)
Filter on startDate that is equals or greater than value
startDate_to
date (date)
Filter on startDate_from that is equals or smaller than value
endDate
date (date)
date when event ends
endDate_from
date (date)
Filter on endDate that is equals or greater than value
endDate_to
date (date)
Filter on endDate that is equals or smaller than value
startTime
String
time when event starts
startTime_from
String
Filter on startTime that is equals or greater than value
startTime_to
String
Filter on startTime that is equals or smaller than value
endTime
String
time when event ends
endTime_from
String
Filter on endTime that is equals or greater than value
endTime_to
String
Filter on endTime that is equals or smaller than value
confidential
Long (int64)
Filter on confidentiality, 0 is public and 1 is confidential
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized


Groups

getGroupById

Retrieve specific group


/groups/{groupId}

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/groups/{groupId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

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

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

        GroupsApi apiInstance = new GroupsApi();
        Integer groupId = 56; // Integer | group ID
        try {
            Group result = apiInstance.getGroupById(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getGroupById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

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

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

[apiInstance getGroupByIdWith:groupId
              completionHandler: ^(Group output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.GroupsApi()
var groupId = 56; // {{Integer}} group ID

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

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

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

            var apiInstance = new GroupsApi();
            var groupId = 56;  // Integer | group ID

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

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

$api_instance = new Swagger\Client\ApiGroupsApi();
$groupId = 56; // Integer | group ID

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

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

my $api_instance = WWW::SwaggerClient::GroupsApi->new();
my $groupId = 56; # Integer | group ID

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

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

# create an instance of the API class
api_instance = swagger_client.GroupsApi()
groupId = 56 # Integer | group ID

try: 
    api_response = api_instance.get_group_by_id(groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->getGroupById: %s\n" % e)

Parameters

Path parameters
Name Description
groupId*
Integer
group ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getGroups

Retrieve a list of groups


/groups

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/groups?id=&name=&type=&sortOrder=&sortOrder_from=&sortOrder_to=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

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

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

        GroupsApi apiInstance = new GroupsApi();
        Long id = 789; // Long | unique identifier of group
        String name = name_example; // String | name of group
        String type = type_example; // String | type of group
        Long sortOrder = 789; // Long | position of item in list of items
        Long sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
        Long sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
        Long offset = 789; // Long | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Group] result = apiInstance.getGroups(id, name, type, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        Long id = 789; // Long | unique identifier of group
        String name = name_example; // String | name of group
        String type = type_example; // String | type of group
        Long sortOrder = 789; // Long | position of item in list of items
        Long sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
        Long sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
        Long offset = 789; // Long | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Group] result = apiInstance.getGroups(id, name, type, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getGroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // unique identifier of group (optional)
String *name = name_example; // name of group (optional)
String *type = type_example; // type of group (optional)
Long *sortOrder = 789; // position of item in list of items (optional)
Long *sortOrderFrom = 789; // Filter on sortOrder that is equals or greater than value (optional)
Long *sortOrderTo = 789; // Filter on sortOrder that is equals or smaller than value (optional)
Long *offset = 789; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getGroupsWith:id
    name:name
    type:type
    sortOrder:sortOrder
    sortOrderFrom:sortOrderFrom
    sortOrderTo:sortOrderTo
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Group] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.GroupsApi()
var opts = { 
  'id': 789, // {{Long}} unique identifier of group
  'name': name_example, // {{String}} name of group
  'type': type_example, // {{String}} type of group
  'sortOrder': 789, // {{Long}} position of item in list of items
  'sortOrderFrom': 789, // {{Long}} Filter on sortOrder that is equals or greater than value
  'sortOrderTo': 789, // {{Long}} Filter on sortOrder that is equals or smaller than value
  'offset': 789, // {{Long}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new GroupsApi();
            var id = 789;  // Long | unique identifier of group (optional) 
            var name = name_example;  // String | name of group (optional) 
            var type = type_example;  // String | type of group (optional) 
            var sortOrder = 789;  // Long | position of item in list of items (optional) 
            var sortOrderFrom = 789;  // Long | Filter on sortOrder that is equals or greater than value (optional) 
            var sortOrderTo = 789;  // Long | Filter on sortOrder that is equals or smaller than value (optional) 
            var offset = 789;  // Long | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Group] result = apiInstance.getGroups(id, name, type, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.getGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiGroupsApi();
$id = 789; // Long | unique identifier of group
$name = name_example; // String | name of group
$type = type_example; // String | type of group
$sortOrder = 789; // Long | position of item in list of items
$sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
$sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
$offset = 789; // Long | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getGroups($id, $name, $type, $sortOrder, $sortOrderFrom, $sortOrderTo, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->getGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupsApi;

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

my $api_instance = WWW::SwaggerClient::GroupsApi->new();
my $id = 789; # Long | unique identifier of group
my $name = name_example; # String | name of group
my $type = type_example; # String | type of group
my $sortOrder = 789; # Long | position of item in list of items
my $sortOrderFrom = 789; # Long | Filter on sortOrder that is equals or greater than value
my $sortOrderTo = 789; # Long | Filter on sortOrder that is equals or smaller than value
my $offset = 789; # Long | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getGroups(id => $id, name => $name, type => $type, sortOrder => $sortOrder, sortOrderFrom => $sortOrderFrom, sortOrderTo => $sortOrderTo, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->getGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.GroupsApi()
id = 789 # Long | unique identifier of group (optional)
name = name_example # String | name of group (optional)
type = type_example # String | type of group (optional)
sortOrder = 789 # Long | position of item in list of items (optional)
sortOrderFrom = 789 # Long | Filter on sortOrder that is equals or greater than value (optional)
sortOrderTo = 789 # Long | Filter on sortOrder that is equals or smaller than value (optional)
offset = 789 # Long | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_groups(id=id, name=name, type=type, sortOrder=sortOrder, sortOrderFrom=sortOrderFrom, sortOrderTo=sortOrderTo, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->getGroups: %s\n" % e)

Parameters

Query parameters
Name Description
id
Long (int64)
unique identifier of group
name
String
name of group
type
String
type of group
sortOrder
Long (int64)
position of item in list of items
sortOrder_from
Long (int64)
Filter on sortOrder that is equals or greater than value
sortOrder_to
Long (int64)
Filter on sortOrder that is equals or smaller than value
offset
Long (int64)
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized


Meetings

getMeetingById

Retrieve specific meeting


/meetings/{meetingId}

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/meetings/{meetingId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MeetingsApi;

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

public class MeetingsApiExample {

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

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

        MeetingsApi apiInstance = new MeetingsApi();
        Integer meetingId = 56; // Integer | Meeting ID
        try {
            Meeting result = apiInstance.getMeetingById(meetingId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeetingsApi#getMeetingById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MeetingsApi;

public class MeetingsApiExample {

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

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

[apiInstance getMeetingByIdWith:meetingId
              completionHandler: ^(Meeting output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.MeetingsApi()
var meetingId = 56; // {{Integer}} Meeting ID

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

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

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

            var apiInstance = new MeetingsApi();
            var meetingId = 56;  // Integer | Meeting ID

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

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

$api_instance = new Swagger\Client\ApiMeetingsApi();
$meetingId = 56; // Integer | Meeting ID

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

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

my $api_instance = WWW::SwaggerClient::MeetingsApi->new();
my $meetingId = 56; # Integer | Meeting ID

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

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

# create an instance of the API class
api_instance = swagger_client.MeetingsApi()
meetingId = 56 # Integer | Meeting ID

try: 
    api_response = api_instance.get_meeting_by_id(meetingId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MeetingsApi->getMeetingById: %s\n" % e)

Parameters

Path parameters
Name Description
meetingId*
Integer
Meeting ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getMeetingItem

Retrieve a specific meeting item


/meetingitems/{meetingItemId}

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/meetingitems/{meetingItemId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MeetingsApi;

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

public class MeetingsApiExample {

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

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

        MeetingsApi apiInstance = new MeetingsApi();
        Integer meetingItemId = 56; // Integer | Meeting item ID
        try {
            MeetingItem result = apiInstance.getMeetingItem(meetingItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeetingsApi#getMeetingItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MeetingsApi;

public class MeetingsApiExample {

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

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

[apiInstance getMeetingItemWith:meetingItemId
              completionHandler: ^(MeetingItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.MeetingsApi()
var meetingItemId = 56; // {{Integer}} Meeting item ID

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

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

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

            var apiInstance = new MeetingsApi();
            var meetingItemId = 56;  // Integer | Meeting item ID

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

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

$api_instance = new Swagger\Client\ApiMeetingsApi();
$meetingItemId = 56; // Integer | Meeting item ID

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

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

my $api_instance = WWW::SwaggerClient::MeetingsApi->new();
my $meetingItemId = 56; # Integer | Meeting item ID

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

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

# create an instance of the API class
api_instance = swagger_client.MeetingsApi()
meetingItemId = 56 # Integer | Meeting item ID

try: 
    api_response = api_instance.get_meeting_item(meetingItemId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MeetingsApi->getMeetingItem: %s\n" % e)

Parameters

Path parameters
Name Description
meetingItemId*
Integer
Meeting item ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getMeetingItems

Retrieve a list of meeting items based on meeting


/meetings/{meetingId}/meetingitems

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/meetings/{meetingId}/meetingitems?id=&sortOrder=&sortOrder_from=&sortOrder_to=&number=&description=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MeetingsApi;

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

public class MeetingsApiExample {

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

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

        MeetingsApi apiInstance = new MeetingsApi();
        Long meetingId = 789; // Long | Meeting ID
        Long id = 789; // Long | Filter unique identifier of meeting item
        String sortOrder = sortOrder_example; // String | Match with startTime that equals as value
        String sortOrderFrom = sortOrderFrom_example; // String | Get all startTime that is equal and greater than
        Integer sortOrderTo = 56; // Integer | Get all startTime that is equal and smaller than
        String number = number_example; // String | Filter on number of the meeting item
        String description = description_example; // String | Filter on description
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[MeetingItem] result = apiInstance.getMeetingItems(meetingId, id, sortOrder, sortOrderFrom, sortOrderTo, number, description, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeetingsApi#getMeetingItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MeetingsApi;

public class MeetingsApiExample {

    public static void main(String[] args) {
        MeetingsApi apiInstance = new MeetingsApi();
        Long meetingId = 789; // Long | Meeting ID
        Long id = 789; // Long | Filter unique identifier of meeting item
        String sortOrder = sortOrder_example; // String | Match with startTime that equals as value
        String sortOrderFrom = sortOrderFrom_example; // String | Get all startTime that is equal and greater than
        Integer sortOrderTo = 56; // Integer | Get all startTime that is equal and smaller than
        String number = number_example; // String | Filter on number of the meeting item
        String description = description_example; // String | Filter on description
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[MeetingItem] result = apiInstance.getMeetingItems(meetingId, id, sortOrder, sortOrderFrom, sortOrderTo, number, description, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeetingsApi#getMeetingItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *meetingId = 789; // Meeting ID
Long *id = 789; // Filter unique identifier of meeting item (optional)
String *sortOrder = sortOrder_example; // Match with startTime that equals as value (optional)
String *sortOrderFrom = sortOrderFrom_example; // Get all startTime that is equal and greater than (optional)
Integer *sortOrderTo = 56; // Get all startTime that is equal and smaller than (optional)
String *number = number_example; // Filter on number of the meeting item (optional)
String *description = description_example; // Filter on description (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getMeetingItemsWith:meetingId
    id:id
    sortOrder:sortOrder
    sortOrderFrom:sortOrderFrom
    sortOrderTo:sortOrderTo
    number:number
    description:description
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[MeetingItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.MeetingsApi()
var meetingId = 789; // {{Long}} Meeting ID
var opts = { 
  'id': 789, // {{Long}} Filter unique identifier of meeting item
  'sortOrder': sortOrder_example, // {{String}} Match with startTime that equals as value
  'sortOrderFrom': sortOrderFrom_example, // {{String}} Get all startTime that is equal and greater than
  'sortOrderTo': 56, // {{Integer}} Get all startTime that is equal and smaller than
  'number': number_example, // {{String}} Filter on number of the meeting item
  'description': description_example, // {{String}} Filter on description
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new MeetingsApi();
            var meetingId = 789;  // Long | Meeting ID
            var id = 789;  // Long | Filter unique identifier of meeting item (optional) 
            var sortOrder = sortOrder_example;  // String | Match with startTime that equals as value (optional) 
            var sortOrderFrom = sortOrderFrom_example;  // String | Get all startTime that is equal and greater than (optional) 
            var sortOrderTo = 56;  // Integer | Get all startTime that is equal and smaller than (optional) 
            var number = number_example;  // String | Filter on number of the meeting item (optional) 
            var description = description_example;  // String | Filter on description (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[MeetingItem] result = apiInstance.getMeetingItems(meetingId, id, sortOrder, sortOrderFrom, sortOrderTo, number, description, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MeetingsApi.getMeetingItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiMeetingsApi();
$meetingId = 789; // Long | Meeting ID
$id = 789; // Long | Filter unique identifier of meeting item
$sortOrder = sortOrder_example; // String | Match with startTime that equals as value
$sortOrderFrom = sortOrderFrom_example; // String | Get all startTime that is equal and greater than
$sortOrderTo = 56; // Integer | Get all startTime that is equal and smaller than
$number = number_example; // String | Filter on number of the meeting item
$description = description_example; // String | Filter on description
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getMeetingItems($meetingId, $id, $sortOrder, $sortOrderFrom, $sortOrderTo, $number, $description, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MeetingsApi->getMeetingItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MeetingsApi;

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

my $api_instance = WWW::SwaggerClient::MeetingsApi->new();
my $meetingId = 789; # Long | Meeting ID
my $id = 789; # Long | Filter unique identifier of meeting item
my $sortOrder = sortOrder_example; # String | Match with startTime that equals as value
my $sortOrderFrom = sortOrderFrom_example; # String | Get all startTime that is equal and greater than
my $sortOrderTo = 56; # Integer | Get all startTime that is equal and smaller than
my $number = number_example; # String | Filter on number of the meeting item
my $description = description_example; # String | Filter on description
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getMeetingItems(meetingId => $meetingId, id => $id, sortOrder => $sortOrder, sortOrderFrom => $sortOrderFrom, sortOrderTo => $sortOrderTo, number => $number, description => $description, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MeetingsApi->getMeetingItems: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.MeetingsApi()
meetingId = 789 # Long | Meeting ID
id = 789 # Long | Filter unique identifier of meeting item (optional)
sortOrder = sortOrder_example # String | Match with startTime that equals as value (optional)
sortOrderFrom = sortOrderFrom_example # String | Get all startTime that is equal and greater than (optional)
sortOrderTo = 56 # Integer | Get all startTime that is equal and smaller than (optional)
number = number_example # String | Filter on number of the meeting item (optional)
description = description_example # String | Filter on description (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_meeting_items(meetingId, id=id, sortOrder=sortOrder, sortOrderFrom=sortOrderFrom, sortOrderTo=sortOrderTo, number=number, description=description, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MeetingsApi->getMeetingItems: %s\n" % e)

Parameters

Path parameters
Name Description
meetingId*
Long (int64)
Meeting ID
Required
Query parameters
Name Description
id
Long (int64)
Filter unique identifier of meeting item
sortOrder
String
Match with startTime that equals as value
sortOrder_from
String
Get all startTime that is equal and greater than
sortOrder_to
Integer
Get all startTime that is equal and smaller than
number
String
Filter on number of the meeting item
description
String
Filter on description
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getMeetings

Retrieve a list of meetings


/meetings

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/meetings?id=&date=&date_from=&date_to=&startTime=&startTime_from=&startTime_to=&confidential=&location=&description=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MeetingsApi;

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

public class MeetingsApiExample {

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

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

        MeetingsApi apiInstance = new MeetingsApi();
        Long id = 789; // Long | Filter unique identifier of meeting
        date date = 2013-10-20; // date | Match with date that equals as value
        date dateFrom = 2013-10-20; // date | Get all meetings that is equal and greater than
        Integer dateTo = 56; // Integer | Get all meetings that is equal and smaller than
        String startTime = startTime_example; // String | Match with startTime that equals as value
        String startTimeFrom = startTimeFrom_example; // String | Get all startTime that is equal and greater than
        Integer startTimeTo = 56; // Integer | Get all startTime that is equal and smaller than
        Long confidential = 789; // Long | Filter on confidentiality, 0 is public and 1 is confidential
        String location = location_example; // String | Filter on location
        String description = description_example; // String | Filter on description
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Meeting] result = apiInstance.getMeetings(id, date, dateFrom, dateTo, startTime, startTimeFrom, startTimeTo, confidential, location, description, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeetingsApi#getMeetings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MeetingsApi;

public class MeetingsApiExample {

    public static void main(String[] args) {
        MeetingsApi apiInstance = new MeetingsApi();
        Long id = 789; // Long | Filter unique identifier of meeting
        date date = 2013-10-20; // date | Match with date that equals as value
        date dateFrom = 2013-10-20; // date | Get all meetings that is equal and greater than
        Integer dateTo = 56; // Integer | Get all meetings that is equal and smaller than
        String startTime = startTime_example; // String | Match with startTime that equals as value
        String startTimeFrom = startTimeFrom_example; // String | Get all startTime that is equal and greater than
        Integer startTimeTo = 56; // Integer | Get all startTime that is equal and smaller than
        Long confidential = 789; // Long | Filter on confidentiality, 0 is public and 1 is confidential
        String location = location_example; // String | Filter on location
        String description = description_example; // String | Filter on description
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Meeting] result = apiInstance.getMeetings(id, date, dateFrom, dateTo, startTime, startTimeFrom, startTimeTo, confidential, location, description, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MeetingsApi#getMeetings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Filter unique identifier of meeting (optional)
date *date = 2013-10-20; // Match with date that equals as value (optional)
date *dateFrom = 2013-10-20; // Get all meetings that is equal and greater than (optional)
Integer *dateTo = 56; // Get all meetings that is equal and smaller than (optional)
String *startTime = startTime_example; // Match with startTime that equals as value (optional)
String *startTimeFrom = startTimeFrom_example; // Get all startTime that is equal and greater than (optional)
Integer *startTimeTo = 56; // Get all startTime that is equal and smaller than (optional)
Long *confidential = 789; // Filter on confidentiality, 0 is public and 1 is confidential (optional)
String *location = location_example; // Filter on location (optional)
String *description = description_example; // Filter on description (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getMeetingsWith:id
    date:date
    dateFrom:dateFrom
    dateTo:dateTo
    startTime:startTime
    startTimeFrom:startTimeFrom
    startTimeTo:startTimeTo
    confidential:confidential
    location:location
    description:description
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Meeting] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.MeetingsApi()
var opts = { 
  'id': 789, // {{Long}} Filter unique identifier of meeting
  'date': 2013-10-20, // {{date}} Match with date that equals as value
  'dateFrom': 2013-10-20, // {{date}} Get all meetings that is equal and greater than
  'dateTo': 56, // {{Integer}} Get all meetings that is equal and smaller than
  'startTime': startTime_example, // {{String}} Match with startTime that equals as value
  'startTimeFrom': startTimeFrom_example, // {{String}} Get all startTime that is equal and greater than
  'startTimeTo': 56, // {{Integer}} Get all startTime that is equal and smaller than
  'confidential': 789, // {{Long}} Filter on confidentiality, 0 is public and 1 is confidential
  'location': location_example, // {{String}} Filter on location
  'description': description_example, // {{String}} Filter on description
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new MeetingsApi();
            var id = 789;  // Long | Filter unique identifier of meeting (optional) 
            var date = 2013-10-20;  // date | Match with date that equals as value (optional) 
            var dateFrom = 2013-10-20;  // date | Get all meetings that is equal and greater than (optional) 
            var dateTo = 56;  // Integer | Get all meetings that is equal and smaller than (optional) 
            var startTime = startTime_example;  // String | Match with startTime that equals as value (optional) 
            var startTimeFrom = startTimeFrom_example;  // String | Get all startTime that is equal and greater than (optional) 
            var startTimeTo = 56;  // Integer | Get all startTime that is equal and smaller than (optional) 
            var confidential = 789;  // Long | Filter on confidentiality, 0 is public and 1 is confidential (optional) 
            var location = location_example;  // String | Filter on location (optional) 
            var description = description_example;  // String | Filter on description (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Meeting] result = apiInstance.getMeetings(id, date, dateFrom, dateTo, startTime, startTimeFrom, startTimeTo, confidential, location, description, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MeetingsApi.getMeetings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiMeetingsApi();
$id = 789; // Long | Filter unique identifier of meeting
$date = 2013-10-20; // date | Match with date that equals as value
$dateFrom = 2013-10-20; // date | Get all meetings that is equal and greater than
$dateTo = 56; // Integer | Get all meetings that is equal and smaller than
$startTime = startTime_example; // String | Match with startTime that equals as value
$startTimeFrom = startTimeFrom_example; // String | Get all startTime that is equal and greater than
$startTimeTo = 56; // Integer | Get all startTime that is equal and smaller than
$confidential = 789; // Long | Filter on confidentiality, 0 is public and 1 is confidential
$location = location_example; // String | Filter on location
$description = description_example; // String | Filter on description
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getMeetings($id, $date, $dateFrom, $dateTo, $startTime, $startTimeFrom, $startTimeTo, $confidential, $location, $description, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MeetingsApi->getMeetings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MeetingsApi;

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

my $api_instance = WWW::SwaggerClient::MeetingsApi->new();
my $id = 789; # Long | Filter unique identifier of meeting
my $date = 2013-10-20; # date | Match with date that equals as value
my $dateFrom = 2013-10-20; # date | Get all meetings that is equal and greater than
my $dateTo = 56; # Integer | Get all meetings that is equal and smaller than
my $startTime = startTime_example; # String | Match with startTime that equals as value
my $startTimeFrom = startTimeFrom_example; # String | Get all startTime that is equal and greater than
my $startTimeTo = 56; # Integer | Get all startTime that is equal and smaller than
my $confidential = 789; # Long | Filter on confidentiality, 0 is public and 1 is confidential
my $location = location_example; # String | Filter on location
my $description = description_example; # String | Filter on description
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getMeetings(id => $id, date => $date, dateFrom => $dateFrom, dateTo => $dateTo, startTime => $startTime, startTimeFrom => $startTimeFrom, startTimeTo => $startTimeTo, confidential => $confidential, location => $location, description => $description, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MeetingsApi->getMeetings: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.MeetingsApi()
id = 789 # Long | Filter unique identifier of meeting (optional)
date = 2013-10-20 # date | Match with date that equals as value (optional)
dateFrom = 2013-10-20 # date | Get all meetings that is equal and greater than (optional)
dateTo = 56 # Integer | Get all meetings that is equal and smaller than (optional)
startTime = startTime_example # String | Match with startTime that equals as value (optional)
startTimeFrom = startTimeFrom_example # String | Get all startTime that is equal and greater than (optional)
startTimeTo = 56 # Integer | Get all startTime that is equal and smaller than (optional)
confidential = 789 # Long | Filter on confidentiality, 0 is public and 1 is confidential (optional)
location = location_example # String | Filter on location (optional)
description = description_example # String | Filter on description (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_meetings(id=id, date=date, dateFrom=dateFrom, dateTo=dateTo, startTime=startTime, startTimeFrom=startTimeFrom, startTimeTo=startTimeTo, confidential=confidential, location=location, description=description, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MeetingsApi->getMeetings: %s\n" % e)

Parameters

Query parameters
Name Description
id
Long (int64)
Filter unique identifier of meeting
date
date (date)
Match with date that equals as value
date_from
date (date)
Get all meetings that is equal and greater than
date_to
Integer (date)
Get all meetings that is equal and smaller than
startTime
String
Match with startTime that equals as value
startTime_from
String
Get all startTime that is equal and greater than
startTime_to
Integer
Get all startTime that is equal and smaller than
confidential
Long (int64)
Filter on confidentiality, 0 is public and 1 is confidential
location
String
Filter on location
description
String
Filter on description
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized


Persons

getPersonById

Retrieve specific person


/persons/{personId}

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/persons/{personId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonsApi;

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

public class PersonsApiExample {

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

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

        PersonsApi apiInstance = new PersonsApi();
        Integer personId = 56; // Integer | person ID
        try {
            Person result = apiInstance.getPersonById(personId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonsApi#getPersonById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonsApi;

public class PersonsApiExample {

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

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

[apiInstance getPersonByIdWith:personId
              completionHandler: ^(Person output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.PersonsApi()
var personId = 56; // {{Integer}} person ID

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

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

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

            var apiInstance = new PersonsApi();
            var personId = 56;  // Integer | person ID

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

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

$api_instance = new Swagger\Client\ApiPersonsApi();
$personId = 56; // Integer | person ID

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

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

my $api_instance = WWW::SwaggerClient::PersonsApi->new();
my $personId = 56; # Integer | person ID

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

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

# create an instance of the API class
api_instance = swagger_client.PersonsApi()
personId = 56 # Integer | person ID

try: 
    api_response = api_instance.get_person_by_id(personId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonsApi->getPersonById: %s\n" % e)

Parameters

Path parameters
Name Description
personId*
Integer
person ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getPersons

Retrieve a list of persons


/persons

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/persons?id=&lastName=&firstName=&preposition=&salutation=&email=&active=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonsApi;

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

public class PersonsApiExample {

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

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

        PersonsApi apiInstance = new PersonsApi();
        Long id = 789; // Long | Unique identifier if person
        String lastName = lastName_example; // String | Last name of user
        String firstName = firstName_example; // String | First name of user
        String preposition = preposition_example; // String | Preposition of user
        String salutation = salutation_example; // String | Salutation of user
        String email = email_example; // String | Email address of user
        Long active = 789; // Long | If user is still active, 0 stand for inactive and 1 for active
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Person] result = apiInstance.getPersons(id, lastName, firstName, preposition, salutation, email, active, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonsApi#getPersons");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonsApi;

public class PersonsApiExample {

    public static void main(String[] args) {
        PersonsApi apiInstance = new PersonsApi();
        Long id = 789; // Long | Unique identifier if person
        String lastName = lastName_example; // String | Last name of user
        String firstName = firstName_example; // String | First name of user
        String preposition = preposition_example; // String | Preposition of user
        String salutation = salutation_example; // String | Salutation of user
        String email = email_example; // String | Email address of user
        Long active = 789; // Long | If user is still active, 0 stand for inactive and 1 for active
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Person] result = apiInstance.getPersons(id, lastName, firstName, preposition, salutation, email, active, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonsApi#getPersons");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Unique identifier if person (optional)
String *lastName = lastName_example; // Last name of user (optional)
String *firstName = firstName_example; // First name of user (optional)
String *preposition = preposition_example; // Preposition of user (optional)
String *salutation = salutation_example; // Salutation of user (optional)
String *email = email_example; // Email address of user (optional)
Long *active = 789; // If user is still active, 0 stand for inactive and 1 for active (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getPersonsWith:id
    lastName:lastName
    firstName:firstName
    preposition:preposition
    salutation:salutation
    email:email
    active:active
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Person] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.PersonsApi()
var opts = { 
  'id': 789, // {{Long}} Unique identifier if person
  'lastName': lastName_example, // {{String}} Last name of user
  'firstName': firstName_example, // {{String}} First name of user
  'preposition': preposition_example, // {{String}} Preposition of user
  'salutation': salutation_example, // {{String}} Salutation of user
  'email': email_example, // {{String}} Email address of user
  'active': 789, // {{Long}} If user is still active, 0 stand for inactive and 1 for active
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new PersonsApi();
            var id = 789;  // Long | Unique identifier if person (optional) 
            var lastName = lastName_example;  // String | Last name of user (optional) 
            var firstName = firstName_example;  // String | First name of user (optional) 
            var preposition = preposition_example;  // String | Preposition of user (optional) 
            var salutation = salutation_example;  // String | Salutation of user (optional) 
            var email = email_example;  // String | Email address of user (optional) 
            var active = 789;  // Long | If user is still active, 0 stand for inactive and 1 for active (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Person] result = apiInstance.getPersons(id, lastName, firstName, preposition, salutation, email, active, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonsApi.getPersons: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPersonsApi();
$id = 789; // Long | Unique identifier if person
$lastName = lastName_example; // String | Last name of user
$firstName = firstName_example; // String | First name of user
$preposition = preposition_example; // String | Preposition of user
$salutation = salutation_example; // String | Salutation of user
$email = email_example; // String | Email address of user
$active = 789; // Long | If user is still active, 0 stand for inactive and 1 for active
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getPersons($id, $lastName, $firstName, $preposition, $salutation, $email, $active, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonsApi->getPersons: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonsApi;

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

my $api_instance = WWW::SwaggerClient::PersonsApi->new();
my $id = 789; # Long | Unique identifier if person
my $lastName = lastName_example; # String | Last name of user
my $firstName = firstName_example; # String | First name of user
my $preposition = preposition_example; # String | Preposition of user
my $salutation = salutation_example; # String | Salutation of user
my $email = email_example; # String | Email address of user
my $active = 789; # Long | If user is still active, 0 stand for inactive and 1 for active
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getPersons(id => $id, lastName => $lastName, firstName => $firstName, preposition => $preposition, salutation => $salutation, email => $email, active => $active, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonsApi->getPersons: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.PersonsApi()
id = 789 # Long | Unique identifier if person (optional)
lastName = lastName_example # String | Last name of user (optional)
firstName = firstName_example # String | First name of user (optional)
preposition = preposition_example # String | Preposition of user (optional)
salutation = salutation_example # String | Salutation of user (optional)
email = email_example # String | Email address of user (optional)
active = 789 # Long | If user is still active, 0 stand for inactive and 1 for active (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_persons(id=id, lastName=lastName, firstName=firstName, preposition=preposition, salutation=salutation, email=email, active=active, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonsApi->getPersons: %s\n" % e)

Parameters

Query parameters
Name Description
id
Long (int64)
Unique identifier if person
lastName
String
Last name of user
firstName
String
First name of user
preposition
String
Preposition of user
salutation
String
Salutation of user
email
String
Email address of user
active
Long (int64)
If user is still active, 0 stand for inactive and 1 for active
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized


getPersonsByDocument

Retrieve a list of persons that have access to the document


/documents/{documentId}/persons

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/documents/{documentId}/persons"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonsApi;

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

public class PersonsApiExample {

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

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

        PersonsApi apiInstance = new PersonsApi();
        Integer documentId = 56; // Integer | Document ID
        try {
            array[Person] result = apiInstance.getPersonsByDocument(documentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonsApi#getPersonsByDocument");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonsApi;

public class PersonsApiExample {

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

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

[apiInstance getPersonsByDocumentWith:documentId
              completionHandler: ^(array[Person] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.PersonsApi()
var documentId = 56; // {{Integer}} Document ID

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

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

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

            var apiInstance = new PersonsApi();
            var documentId = 56;  // Integer | Document ID

            try
            {
                array[Person] result = apiInstance.getPersonsByDocument(documentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonsApi.getPersonsByDocument: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPersonsApi();
$documentId = 56; // Integer | Document ID

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

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

my $api_instance = WWW::SwaggerClient::PersonsApi->new();
my $documentId = 56; # Integer | Document ID

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

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

# create an instance of the API class
api_instance = swagger_client.PersonsApi()
documentId = 56 # Integer | Document ID

try: 
    api_response = api_instance.get_persons_by_document(documentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonsApi->getPersonsByDocument: %s\n" % e)

Parameters

Path parameters
Name Description
documentId*
Integer
Document ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getPersonsByGroupId

Retrieve a list of members of an group


/groups/{groupId}/persons

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/groups/{groupId}/persons?id=&lastName=&firstName=&preposition=&salutation=&email=&active=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonsApi;

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

public class PersonsApiExample {

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

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

        PersonsApi apiInstance = new PersonsApi();
        Integer groupId = 56; // Integer | group ID
        Long id = 789; // Long | Unique identifier if person
        String lastName = lastName_example; // String | Last name of user
        String firstName = firstName_example; // String | First name of user
        String preposition = preposition_example; // String | Preposition of user
        String salutation = salutation_example; // String | Salutation of user
        String email = email_example; // String | Email address of user
        Boolean active = true; // Boolean | If user is still active
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Person] result = apiInstance.getPersonsByGroupId(groupId, id, lastName, firstName, preposition, salutation, email, active, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonsApi#getPersonsByGroupId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonsApi;

public class PersonsApiExample {

    public static void main(String[] args) {
        PersonsApi apiInstance = new PersonsApi();
        Integer groupId = 56; // Integer | group ID
        Long id = 789; // Long | Unique identifier if person
        String lastName = lastName_example; // String | Last name of user
        String firstName = firstName_example; // String | First name of user
        String preposition = preposition_example; // String | Preposition of user
        String salutation = salutation_example; // String | Salutation of user
        String email = email_example; // String | Email address of user
        Boolean active = true; // Boolean | If user is still active
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Person] result = apiInstance.getPersonsByGroupId(groupId, id, lastName, firstName, preposition, salutation, email, active, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonsApi#getPersonsByGroupId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *groupId = 56; // group ID
Long *id = 789; // Unique identifier if person (optional)
String *lastName = lastName_example; // Last name of user (optional)
String *firstName = firstName_example; // First name of user (optional)
String *preposition = preposition_example; // Preposition of user (optional)
String *salutation = salutation_example; // Salutation of user (optional)
String *email = email_example; // Email address of user (optional)
Boolean *active = true; // If user is still active (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getPersonsByGroupIdWith:groupId
    id:id
    lastName:lastName
    firstName:firstName
    preposition:preposition
    salutation:salutation
    email:email
    active:active
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Person] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.PersonsApi()
var groupId = 56; // {{Integer}} group ID
var opts = { 
  'id': 789, // {{Long}} Unique identifier if person
  'lastName': lastName_example, // {{String}} Last name of user
  'firstName': firstName_example, // {{String}} First name of user
  'preposition': preposition_example, // {{String}} Preposition of user
  'salutation': salutation_example, // {{String}} Salutation of user
  'email': email_example, // {{String}} Email address of user
  'active': true, // {{Boolean}} If user is still active
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new PersonsApi();
            var groupId = 56;  // Integer | group ID
            var id = 789;  // Long | Unique identifier if person (optional) 
            var lastName = lastName_example;  // String | Last name of user (optional) 
            var firstName = firstName_example;  // String | First name of user (optional) 
            var preposition = preposition_example;  // String | Preposition of user (optional) 
            var salutation = salutation_example;  // String | Salutation of user (optional) 
            var email = email_example;  // String | Email address of user (optional) 
            var active = true;  // Boolean | If user is still active (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Person] result = apiInstance.getPersonsByGroupId(groupId, id, lastName, firstName, preposition, salutation, email, active, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonsApi.getPersonsByGroupId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPersonsApi();
$groupId = 56; // Integer | group ID
$id = 789; // Long | Unique identifier if person
$lastName = lastName_example; // String | Last name of user
$firstName = firstName_example; // String | First name of user
$preposition = preposition_example; // String | Preposition of user
$salutation = salutation_example; // String | Salutation of user
$email = email_example; // String | Email address of user
$active = true; // Boolean | If user is still active
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getPersonsByGroupId($groupId, $id, $lastName, $firstName, $preposition, $salutation, $email, $active, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonsApi->getPersonsByGroupId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonsApi;

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

my $api_instance = WWW::SwaggerClient::PersonsApi->new();
my $groupId = 56; # Integer | group ID
my $id = 789; # Long | Unique identifier if person
my $lastName = lastName_example; # String | Last name of user
my $firstName = firstName_example; # String | First name of user
my $preposition = preposition_example; # String | Preposition of user
my $salutation = salutation_example; # String | Salutation of user
my $email = email_example; # String | Email address of user
my $active = true; # Boolean | If user is still active
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getPersonsByGroupId(groupId => $groupId, id => $id, lastName => $lastName, firstName => $firstName, preposition => $preposition, salutation => $salutation, email => $email, active => $active, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonsApi->getPersonsByGroupId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.PersonsApi()
groupId = 56 # Integer | group ID
id = 789 # Long | Unique identifier if person (optional)
lastName = lastName_example # String | Last name of user (optional)
firstName = firstName_example # String | First name of user (optional)
preposition = preposition_example # String | Preposition of user (optional)
salutation = salutation_example # String | Salutation of user (optional)
email = email_example # String | Email address of user (optional)
active = true # Boolean | If user is still active (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_persons_by_group_id(groupId, id=id, lastName=lastName, firstName=firstName, preposition=preposition, salutation=salutation, email=email, active=active, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonsApi->getPersonsByGroupId: %s\n" % e)

Parameters

Path parameters
Name Description
groupId*
Integer
group ID
Required
Query parameters
Name Description
id
Long (int64)
Unique identifier if person
lastName
String
Last name of user
firstName
String
First name of user
preposition
String
Preposition of user
salutation
String
Salutation of user
email
String
Email address of user
active
Boolean
If user is still active
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getPersonsByRoleId

Retrieve a list of persons who have a currently active position for a specific role


/roles/{roleId}/persons

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/roles/{roleId}/persons?id=&lastName=&firstName=&preposition=&salutation=&email=&active=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonsApi;

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

public class PersonsApiExample {

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

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

        PersonsApi apiInstance = new PersonsApi();
        Integer roleId = 56; // Integer | role ID
        Long id = 789; // Long | Unique identifier if person
        String lastName = lastName_example; // String | Last name of user
        String firstName = firstName_example; // String | First name of user
        String preposition = preposition_example; // String | Preposition of user
        String salutation = salutation_example; // String | Salutation of user
        String email = email_example; // String | Email address of user
        Boolean active = true; // Boolean | If user is still active
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Person] result = apiInstance.getPersonsByRoleId(roleId, id, lastName, firstName, preposition, salutation, email, active, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonsApi#getPersonsByRoleId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonsApi;

public class PersonsApiExample {

    public static void main(String[] args) {
        PersonsApi apiInstance = new PersonsApi();
        Integer roleId = 56; // Integer | role ID
        Long id = 789; // Long | Unique identifier if person
        String lastName = lastName_example; // String | Last name of user
        String firstName = firstName_example; // String | First name of user
        String preposition = preposition_example; // String | Preposition of user
        String salutation = salutation_example; // String | Salutation of user
        String email = email_example; // String | Email address of user
        Boolean active = true; // Boolean | If user is still active
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Person] result = apiInstance.getPersonsByRoleId(roleId, id, lastName, firstName, preposition, salutation, email, active, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonsApi#getPersonsByRoleId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *roleId = 56; // role ID
Long *id = 789; // Unique identifier if person (optional)
String *lastName = lastName_example; // Last name of user (optional)
String *firstName = firstName_example; // First name of user (optional)
String *preposition = preposition_example; // Preposition of user (optional)
String *salutation = salutation_example; // Salutation of user (optional)
String *email = email_example; // Email address of user (optional)
Boolean *active = true; // If user is still active (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getPersonsByRoleIdWith:roleId
    id:id
    lastName:lastName
    firstName:firstName
    preposition:preposition
    salutation:salutation
    email:email
    active:active
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Person] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.PersonsApi()
var roleId = 56; // {{Integer}} role ID
var opts = { 
  'id': 789, // {{Long}} Unique identifier if person
  'lastName': lastName_example, // {{String}} Last name of user
  'firstName': firstName_example, // {{String}} First name of user
  'preposition': preposition_example, // {{String}} Preposition of user
  'salutation': salutation_example, // {{String}} Salutation of user
  'email': email_example, // {{String}} Email address of user
  'active': true, // {{Boolean}} If user is still active
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new PersonsApi();
            var roleId = 56;  // Integer | role ID
            var id = 789;  // Long | Unique identifier if person (optional) 
            var lastName = lastName_example;  // String | Last name of user (optional) 
            var firstName = firstName_example;  // String | First name of user (optional) 
            var preposition = preposition_example;  // String | Preposition of user (optional) 
            var salutation = salutation_example;  // String | Salutation of user (optional) 
            var email = email_example;  // String | Email address of user (optional) 
            var active = true;  // Boolean | If user is still active (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Person] result = apiInstance.getPersonsByRoleId(roleId, id, lastName, firstName, preposition, salutation, email, active, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonsApi.getPersonsByRoleId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPersonsApi();
$roleId = 56; // Integer | role ID
$id = 789; // Long | Unique identifier if person
$lastName = lastName_example; // String | Last name of user
$firstName = firstName_example; // String | First name of user
$preposition = preposition_example; // String | Preposition of user
$salutation = salutation_example; // String | Salutation of user
$email = email_example; // String | Email address of user
$active = true; // Boolean | If user is still active
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getPersonsByRoleId($roleId, $id, $lastName, $firstName, $preposition, $salutation, $email, $active, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonsApi->getPersonsByRoleId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonsApi;

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

my $api_instance = WWW::SwaggerClient::PersonsApi->new();
my $roleId = 56; # Integer | role ID
my $id = 789; # Long | Unique identifier if person
my $lastName = lastName_example; # String | Last name of user
my $firstName = firstName_example; # String | First name of user
my $preposition = preposition_example; # String | Preposition of user
my $salutation = salutation_example; # String | Salutation of user
my $email = email_example; # String | Email address of user
my $active = true; # Boolean | If user is still active
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getPersonsByRoleId(roleId => $roleId, id => $id, lastName => $lastName, firstName => $firstName, preposition => $preposition, salutation => $salutation, email => $email, active => $active, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonsApi->getPersonsByRoleId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.PersonsApi()
roleId = 56 # Integer | role ID
id = 789 # Long | Unique identifier if person (optional)
lastName = lastName_example # String | Last name of user (optional)
firstName = firstName_example # String | First name of user (optional)
preposition = preposition_example # String | Preposition of user (optional)
salutation = salutation_example # String | Salutation of user (optional)
email = email_example # String | Email address of user (optional)
active = true # Boolean | If user is still active (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_persons_by_role_id(roleId, id=id, lastName=lastName, firstName=firstName, preposition=preposition, salutation=salutation, email=email, active=active, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonsApi->getPersonsByRoleId: %s\n" % e)

Parameters

Path parameters
Name Description
roleId*
Integer
role ID
Required
Query parameters
Name Description
id
Long (int64)
Unique identifier if person
lastName
String
Last name of user
firstName
String
First name of user
preposition
String
Preposition of user
salutation
String
Salutation of user
email
String
Email address of user
active
Boolean
If user is still active
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


Positions

getPositionById

Retrieve specific role


/positions/{positionId}

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/positions/{positionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PositionsApi;

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

public class PositionsApiExample {

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

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

        PositionsApi apiInstance = new PositionsApi();
        Integer positionId = 56; // Integer | position ID
        try {
            Position result = apiInstance.getPositionById(positionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PositionsApi#getPositionById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PositionsApi;

public class PositionsApiExample {

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

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

[apiInstance getPositionByIdWith:positionId
              completionHandler: ^(Position output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.PositionsApi()
var positionId = 56; // {{Integer}} position ID

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

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

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

            var apiInstance = new PositionsApi();
            var positionId = 56;  // Integer | position ID

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

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

$api_instance = new Swagger\Client\ApiPositionsApi();
$positionId = 56; // Integer | position ID

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

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

my $api_instance = WWW::SwaggerClient::PositionsApi->new();
my $positionId = 56; # Integer | position ID

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

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

# create an instance of the API class
api_instance = swagger_client.PositionsApi()
positionId = 56 # Integer | position ID

try: 
    api_response = api_instance.get_position_by_id(positionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PositionsApi->getPositionById: %s\n" % e)

Parameters

Path parameters
Name Description
positionId*
Integer
position ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getPositions

Retrieve a list of positions


/positions

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/positions?id=&personId=&roleId=&startDate=&startDate_from=&startDate_to=&endDate=&endDate_from=&endDate_to=&sortOrder=&sortOrder_from=&sortOrder_to=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PositionsApi;

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

public class PositionsApiExample {

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

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

        PositionsApi apiInstance = new PositionsApi();
        Long id = 789; // Long | Unique identifier of position
        Long personId = 789; // Long | Unique identifier of person
        Long roleId = 789; // Long | Unique identifier of role
        date startDate = 2013-10-20; // date | get all items that's equals as value
        date startDateFrom = 2013-10-20; // date | Filter on startDate that is equals or greater than value
        date startDateTo = 2013-10-20; // date | Filter on startDate that is equals or smaller than value
        date endDate = 2013-10-20; // date | get all items that's equals as value
        date endDateFrom = 2013-10-20; // date | Filter on endDate that is equals or greater than value
        date endDateTo = 2013-10-20; // date | Filter on endDate that is equals or smaller than value
        Long sortOrder = 789; // Long | position of item in list of items
        Long sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
        Long sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Position] result = apiInstance.getPositions(id, personId, roleId, startDate, startDateFrom, startDateTo, endDate, endDateFrom, endDateTo, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PositionsApi#getPositions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PositionsApi;

public class PositionsApiExample {

    public static void main(String[] args) {
        PositionsApi apiInstance = new PositionsApi();
        Long id = 789; // Long | Unique identifier of position
        Long personId = 789; // Long | Unique identifier of person
        Long roleId = 789; // Long | Unique identifier of role
        date startDate = 2013-10-20; // date | get all items that's equals as value
        date startDateFrom = 2013-10-20; // date | Filter on startDate that is equals or greater than value
        date startDateTo = 2013-10-20; // date | Filter on startDate that is equals or smaller than value
        date endDate = 2013-10-20; // date | get all items that's equals as value
        date endDateFrom = 2013-10-20; // date | Filter on endDate that is equals or greater than value
        date endDateTo = 2013-10-20; // date | Filter on endDate that is equals or smaller than value
        Long sortOrder = 789; // Long | position of item in list of items
        Long sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
        Long sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Position] result = apiInstance.getPositions(id, personId, roleId, startDate, startDateFrom, startDateTo, endDate, endDateFrom, endDateTo, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PositionsApi#getPositions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Unique identifier of position (optional)
Long *personId = 789; // Unique identifier of person (optional)
Long *roleId = 789; // Unique identifier of role (optional)
date *startDate = 2013-10-20; // get all items that's equals as value (optional)
date *startDateFrom = 2013-10-20; // Filter on startDate that is equals or greater than value (optional)
date *startDateTo = 2013-10-20; // Filter on startDate that is equals or smaller than value (optional)
date *endDate = 2013-10-20; // get all items that's equals as value (optional)
date *endDateFrom = 2013-10-20; // Filter on endDate that is equals or greater than value (optional)
date *endDateTo = 2013-10-20; // Filter on endDate that is equals or smaller than value (optional)
Long *sortOrder = 789; // position of item in list of items (optional)
Long *sortOrderFrom = 789; // Filter on sortOrder that is equals or greater than value (optional)
Long *sortOrderTo = 789; // Filter on sortOrder that is equals or smaller than value (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getPositionsWith:id
    personId:personId
    roleId:roleId
    startDate:startDate
    startDateFrom:startDateFrom
    startDateTo:startDateTo
    endDate:endDate
    endDateFrom:endDateFrom
    endDateTo:endDateTo
    sortOrder:sortOrder
    sortOrderFrom:sortOrderFrom
    sortOrderTo:sortOrderTo
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Position] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.PositionsApi()
var opts = { 
  'id': 789, // {{Long}} Unique identifier of position
  'personId': 789, // {{Long}} Unique identifier of person
  'roleId': 789, // {{Long}} Unique identifier of role
  'startDate': 2013-10-20, // {{date}} get all items that's equals as value
  'startDateFrom': 2013-10-20, // {{date}} Filter on startDate that is equals or greater than value
  'startDateTo': 2013-10-20, // {{date}} Filter on startDate that is equals or smaller than value
  'endDate': 2013-10-20, // {{date}} get all items that's equals as value
  'endDateFrom': 2013-10-20, // {{date}} Filter on endDate that is equals or greater than value
  'endDateTo': 2013-10-20, // {{date}} Filter on endDate that is equals or smaller than value
  'sortOrder': 789, // {{Long}} position of item in list of items
  'sortOrderFrom': 789, // {{Long}} Filter on sortOrder that is equals or greater than value
  'sortOrderTo': 789, // {{Long}} Filter on sortOrder that is equals or smaller than value
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new PositionsApi();
            var id = 789;  // Long | Unique identifier of position (optional) 
            var personId = 789;  // Long | Unique identifier of person (optional) 
            var roleId = 789;  // Long | Unique identifier of role (optional) 
            var startDate = 2013-10-20;  // date | get all items that's equals as value (optional) 
            var startDateFrom = 2013-10-20;  // date | Filter on startDate that is equals or greater than value (optional) 
            var startDateTo = 2013-10-20;  // date | Filter on startDate that is equals or smaller than value (optional) 
            var endDate = 2013-10-20;  // date | get all items that's equals as value (optional) 
            var endDateFrom = 2013-10-20;  // date | Filter on endDate that is equals or greater than value (optional) 
            var endDateTo = 2013-10-20;  // date | Filter on endDate that is equals or smaller than value (optional) 
            var sortOrder = 789;  // Long | position of item in list of items (optional) 
            var sortOrderFrom = 789;  // Long | Filter on sortOrder that is equals or greater than value (optional) 
            var sortOrderTo = 789;  // Long | Filter on sortOrder that is equals or smaller than value (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Position] result = apiInstance.getPositions(id, personId, roleId, startDate, startDateFrom, startDateTo, endDate, endDateFrom, endDateTo, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PositionsApi.getPositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPositionsApi();
$id = 789; // Long | Unique identifier of position
$personId = 789; // Long | Unique identifier of person
$roleId = 789; // Long | Unique identifier of role
$startDate = 2013-10-20; // date | get all items that's equals as value
$startDateFrom = 2013-10-20; // date | Filter on startDate that is equals or greater than value
$startDateTo = 2013-10-20; // date | Filter on startDate that is equals or smaller than value
$endDate = 2013-10-20; // date | get all items that's equals as value
$endDateFrom = 2013-10-20; // date | Filter on endDate that is equals or greater than value
$endDateTo = 2013-10-20; // date | Filter on endDate that is equals or smaller than value
$sortOrder = 789; // Long | position of item in list of items
$sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
$sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getPositions($id, $personId, $roleId, $startDate, $startDateFrom, $startDateTo, $endDate, $endDateFrom, $endDateTo, $sortOrder, $sortOrderFrom, $sortOrderTo, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PositionsApi->getPositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PositionsApi;

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

my $api_instance = WWW::SwaggerClient::PositionsApi->new();
my $id = 789; # Long | Unique identifier of position
my $personId = 789; # Long | Unique identifier of person
my $roleId = 789; # Long | Unique identifier of role
my $startDate = 2013-10-20; # date | get all items that's equals as value
my $startDateFrom = 2013-10-20; # date | Filter on startDate that is equals or greater than value
my $startDateTo = 2013-10-20; # date | Filter on startDate that is equals or smaller than value
my $endDate = 2013-10-20; # date | get all items that's equals as value
my $endDateFrom = 2013-10-20; # date | Filter on endDate that is equals or greater than value
my $endDateTo = 2013-10-20; # date | Filter on endDate that is equals or smaller than value
my $sortOrder = 789; # Long | position of item in list of items
my $sortOrderFrom = 789; # Long | Filter on sortOrder that is equals or greater than value
my $sortOrderTo = 789; # Long | Filter on sortOrder that is equals or smaller than value
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getPositions(id => $id, personId => $personId, roleId => $roleId, startDate => $startDate, startDateFrom => $startDateFrom, startDateTo => $startDateTo, endDate => $endDate, endDateFrom => $endDateFrom, endDateTo => $endDateTo, sortOrder => $sortOrder, sortOrderFrom => $sortOrderFrom, sortOrderTo => $sortOrderTo, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PositionsApi->getPositions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.PositionsApi()
id = 789 # Long | Unique identifier of position (optional)
personId = 789 # Long | Unique identifier of person (optional)
roleId = 789 # Long | Unique identifier of role (optional)
startDate = 2013-10-20 # date | get all items that's equals as value (optional)
startDateFrom = 2013-10-20 # date | Filter on startDate that is equals or greater than value (optional)
startDateTo = 2013-10-20 # date | Filter on startDate that is equals or smaller than value (optional)
endDate = 2013-10-20 # date | get all items that's equals as value (optional)
endDateFrom = 2013-10-20 # date | Filter on endDate that is equals or greater than value (optional)
endDateTo = 2013-10-20 # date | Filter on endDate that is equals or smaller than value (optional)
sortOrder = 789 # Long | position of item in list of items (optional)
sortOrderFrom = 789 # Long | Filter on sortOrder that is equals or greater than value (optional)
sortOrderTo = 789 # Long | Filter on sortOrder that is equals or smaller than value (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_positions(id=id, personId=personId, roleId=roleId, startDate=startDate, startDateFrom=startDateFrom, startDateTo=startDateTo, endDate=endDate, endDateFrom=endDateFrom, endDateTo=endDateTo, sortOrder=sortOrder, sortOrderFrom=sortOrderFrom, sortOrderTo=sortOrderTo, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PositionsApi->getPositions: %s\n" % e)

Parameters

Query parameters
Name Description
id
Long (int64)
Unique identifier of position
personId
Long (int64)
Unique identifier of person
roleId
Long (int64)
Unique identifier of role
startDate
date (date)
get all items that's equals as value
startDate_from
date (date)
Filter on startDate that is equals or greater than value
startDate_to
date (date)
Filter on startDate that is equals or smaller than value
endDate
date (date)
get all items that's equals as value
endDate_from
date (date)
Filter on endDate that is equals or greater than value
endDate_to
date (date)
Filter on endDate that is equals or smaller than value
sortOrder
Long (int64)
position of item in list of items
sortOrder_from
Long (int64)
Filter on sortOrder that is equals or greater than value
sortOrder_to
Long (int64)
Filter on sortOrder that is equals or smaller than value
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized


getPositionsByPersonId

Retrieve a list of positions for a specific person


/persons/{personId}/positions

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/persons/{personId}/positions?id=&personId=&roleId=&startDate=&startDate_from=&startDate_to=&endDate=&endDate_from=&endDate_to=&sortOrder=&sortOrder_from=&sortOrder_to=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PositionsApi;

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

public class PositionsApiExample {

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

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

        PositionsApi apiInstance = new PositionsApi();
        Integer personId = 56; // Integer | person ID
        Long id = 789; // Long | Unique identifier of position
        Long personId2 = 789; // Long | Unique identifier of person
        Long roleId = 789; // Long | Unique identifier of role
        date startDate = 2013-10-20; // date | get all items that's equals as value
        date startDateFrom = 2013-10-20; // date | Filter on startDate that is equals or greater than value
        date startDateTo = 2013-10-20; // date | Filter on startDate that is equals or smaller than value
        date endDate = 2013-10-20; // date | get all items that's equals as value
        date endDateFrom = 2013-10-20; // date | Filter on endDate that is equals or greater than value
        date endDateTo = 2013-10-20; // date | Filter on endDate that is equals or smaller than value
        Long sortOrder = 789; // Long | position of item in list of items
        Long sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
        Long sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Position] result = apiInstance.getPositionsByPersonId(personId, id, personId2, roleId, startDate, startDateFrom, startDateTo, endDate, endDateFrom, endDateTo, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PositionsApi#getPositionsByPersonId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PositionsApi;

public class PositionsApiExample {

    public static void main(String[] args) {
        PositionsApi apiInstance = new PositionsApi();
        Integer personId = 56; // Integer | person ID
        Long id = 789; // Long | Unique identifier of position
        Long personId2 = 789; // Long | Unique identifier of person
        Long roleId = 789; // Long | Unique identifier of role
        date startDate = 2013-10-20; // date | get all items that's equals as value
        date startDateFrom = 2013-10-20; // date | Filter on startDate that is equals or greater than value
        date startDateTo = 2013-10-20; // date | Filter on startDate that is equals or smaller than value
        date endDate = 2013-10-20; // date | get all items that's equals as value
        date endDateFrom = 2013-10-20; // date | Filter on endDate that is equals or greater than value
        date endDateTo = 2013-10-20; // date | Filter on endDate that is equals or smaller than value
        Long sortOrder = 789; // Long | position of item in list of items
        Long sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
        Long sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Position] result = apiInstance.getPositionsByPersonId(personId, id, personId2, roleId, startDate, startDateFrom, startDateTo, endDate, endDateFrom, endDateTo, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PositionsApi#getPositionsByPersonId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *personId = 56; // person ID
Long *id = 789; // Unique identifier of position (optional)
Long *personId2 = 789; // Unique identifier of person (optional)
Long *roleId = 789; // Unique identifier of role (optional)
date *startDate = 2013-10-20; // get all items that's equals as value (optional)
date *startDateFrom = 2013-10-20; // Filter on startDate that is equals or greater than value (optional)
date *startDateTo = 2013-10-20; // Filter on startDate that is equals or smaller than value (optional)
date *endDate = 2013-10-20; // get all items that's equals as value (optional)
date *endDateFrom = 2013-10-20; // Filter on endDate that is equals or greater than value (optional)
date *endDateTo = 2013-10-20; // Filter on endDate that is equals or smaller than value (optional)
Long *sortOrder = 789; // position of item in list of items (optional)
Long *sortOrderFrom = 789; // Filter on sortOrder that is equals or greater than value (optional)
Long *sortOrderTo = 789; // Filter on sortOrder that is equals or smaller than value (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getPositionsByPersonIdWith:personId
    id:id
    personId2:personId2
    roleId:roleId
    startDate:startDate
    startDateFrom:startDateFrom
    startDateTo:startDateTo
    endDate:endDate
    endDateFrom:endDateFrom
    endDateTo:endDateTo
    sortOrder:sortOrder
    sortOrderFrom:sortOrderFrom
    sortOrderTo:sortOrderTo
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Position] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.PositionsApi()
var personId = 56; // {{Integer}} person ID
var opts = { 
  'id': 789, // {{Long}} Unique identifier of position
  'personId2': 789, // {{Long}} Unique identifier of person
  'roleId': 789, // {{Long}} Unique identifier of role
  'startDate': 2013-10-20, // {{date}} get all items that's equals as value
  'startDateFrom': 2013-10-20, // {{date}} Filter on startDate that is equals or greater than value
  'startDateTo': 2013-10-20, // {{date}} Filter on startDate that is equals or smaller than value
  'endDate': 2013-10-20, // {{date}} get all items that's equals as value
  'endDateFrom': 2013-10-20, // {{date}} Filter on endDate that is equals or greater than value
  'endDateTo': 2013-10-20, // {{date}} Filter on endDate that is equals or smaller than value
  'sortOrder': 789, // {{Long}} position of item in list of items
  'sortOrderFrom': 789, // {{Long}} Filter on sortOrder that is equals or greater than value
  'sortOrderTo': 789, // {{Long}} Filter on sortOrder that is equals or smaller than value
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new PositionsApi();
            var personId = 56;  // Integer | person ID
            var id = 789;  // Long | Unique identifier of position (optional) 
            var personId2 = 789;  // Long | Unique identifier of person (optional) 
            var roleId = 789;  // Long | Unique identifier of role (optional) 
            var startDate = 2013-10-20;  // date | get all items that's equals as value (optional) 
            var startDateFrom = 2013-10-20;  // date | Filter on startDate that is equals or greater than value (optional) 
            var startDateTo = 2013-10-20;  // date | Filter on startDate that is equals or smaller than value (optional) 
            var endDate = 2013-10-20;  // date | get all items that's equals as value (optional) 
            var endDateFrom = 2013-10-20;  // date | Filter on endDate that is equals or greater than value (optional) 
            var endDateTo = 2013-10-20;  // date | Filter on endDate that is equals or smaller than value (optional) 
            var sortOrder = 789;  // Long | position of item in list of items (optional) 
            var sortOrderFrom = 789;  // Long | Filter on sortOrder that is equals or greater than value (optional) 
            var sortOrderTo = 789;  // Long | Filter on sortOrder that is equals or smaller than value (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Position] result = apiInstance.getPositionsByPersonId(personId, id, personId2, roleId, startDate, startDateFrom, startDateTo, endDate, endDateFrom, endDateTo, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PositionsApi.getPositionsByPersonId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPositionsApi();
$personId = 56; // Integer | person ID
$id = 789; // Long | Unique identifier of position
$personId2 = 789; // Long | Unique identifier of person
$roleId = 789; // Long | Unique identifier of role
$startDate = 2013-10-20; // date | get all items that's equals as value
$startDateFrom = 2013-10-20; // date | Filter on startDate that is equals or greater than value
$startDateTo = 2013-10-20; // date | Filter on startDate that is equals or smaller than value
$endDate = 2013-10-20; // date | get all items that's equals as value
$endDateFrom = 2013-10-20; // date | Filter on endDate that is equals or greater than value
$endDateTo = 2013-10-20; // date | Filter on endDate that is equals or smaller than value
$sortOrder = 789; // Long | position of item in list of items
$sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
$sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getPositionsByPersonId($personId, $id, $personId2, $roleId, $startDate, $startDateFrom, $startDateTo, $endDate, $endDateFrom, $endDateTo, $sortOrder, $sortOrderFrom, $sortOrderTo, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PositionsApi->getPositionsByPersonId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PositionsApi;

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

my $api_instance = WWW::SwaggerClient::PositionsApi->new();
my $personId = 56; # Integer | person ID
my $id = 789; # Long | Unique identifier of position
my $personId2 = 789; # Long | Unique identifier of person
my $roleId = 789; # Long | Unique identifier of role
my $startDate = 2013-10-20; # date | get all items that's equals as value
my $startDateFrom = 2013-10-20; # date | Filter on startDate that is equals or greater than value
my $startDateTo = 2013-10-20; # date | Filter on startDate that is equals or smaller than value
my $endDate = 2013-10-20; # date | get all items that's equals as value
my $endDateFrom = 2013-10-20; # date | Filter on endDate that is equals or greater than value
my $endDateTo = 2013-10-20; # date | Filter on endDate that is equals or smaller than value
my $sortOrder = 789; # Long | position of item in list of items
my $sortOrderFrom = 789; # Long | Filter on sortOrder that is equals or greater than value
my $sortOrderTo = 789; # Long | Filter on sortOrder that is equals or smaller than value
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getPositionsByPersonId(personId => $personId, id => $id, personId2 => $personId2, roleId => $roleId, startDate => $startDate, startDateFrom => $startDateFrom, startDateTo => $startDateTo, endDate => $endDate, endDateFrom => $endDateFrom, endDateTo => $endDateTo, sortOrder => $sortOrder, sortOrderFrom => $sortOrderFrom, sortOrderTo => $sortOrderTo, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PositionsApi->getPositionsByPersonId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.PositionsApi()
personId = 56 # Integer | person ID
id = 789 # Long | Unique identifier of position (optional)
personId2 = 789 # Long | Unique identifier of person (optional)
roleId = 789 # Long | Unique identifier of role (optional)
startDate = 2013-10-20 # date | get all items that's equals as value (optional)
startDateFrom = 2013-10-20 # date | Filter on startDate that is equals or greater than value (optional)
startDateTo = 2013-10-20 # date | Filter on startDate that is equals or smaller than value (optional)
endDate = 2013-10-20 # date | get all items that's equals as value (optional)
endDateFrom = 2013-10-20 # date | Filter on endDate that is equals or greater than value (optional)
endDateTo = 2013-10-20 # date | Filter on endDate that is equals or smaller than value (optional)
sortOrder = 789 # Long | position of item in list of items (optional)
sortOrderFrom = 789 # Long | Filter on sortOrder that is equals or greater than value (optional)
sortOrderTo = 789 # Long | Filter on sortOrder that is equals or smaller than value (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_positions_by_person_id(personId, id=id, personId2=personId2, roleId=roleId, startDate=startDate, startDateFrom=startDateFrom, startDateTo=startDateTo, endDate=endDate, endDateFrom=endDateFrom, endDateTo=endDateTo, sortOrder=sortOrder, sortOrderFrom=sortOrderFrom, sortOrderTo=sortOrderTo, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PositionsApi->getPositionsByPersonId: %s\n" % e)

Parameters

Path parameters
Name Description
personId*
Integer
person ID
Required
Query parameters
Name Description
id
Long (int64)
Unique identifier of position
personId
Long (int64)
Unique identifier of person
roleId
Long (int64)
Unique identifier of role
startDate
date (date)
get all items that's equals as value
startDate_from
date (date)
Filter on startDate that is equals or greater than value
startDate_to
date (date)
Filter on startDate that is equals or smaller than value
endDate
date (date)
get all items that's equals as value
endDate_from
date (date)
Filter on endDate that is equals or greater than value
endDate_to
date (date)
Filter on endDate that is equals or smaller than value
sortOrder
Long (int64)
position of item in list of items
sortOrder_from
Long (int64)
Filter on sortOrder that is equals or greater than value
sortOrder_to
Long (int64)
Filter on sortOrder that is equals or smaller than value
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getPositionsByRoleId

Retrieve a list of positions for a specific role


/roles/{roleId}/positions

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/roles/{roleId}/positions?id=&personId=&roleId=&startDate=&startDate_from=&startDate_to=&endDate=&endDate_from=&endDate_to=&sortOrder=&sortOrder_from=&sortOrder_to=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PositionsApi;

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

public class PositionsApiExample {

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

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

        PositionsApi apiInstance = new PositionsApi();
        Integer roleId = 56; // Integer | role ID
        Long id = 789; // Long | Unique identifier of position
        Long personId = 789; // Long | Unique identifier of person
        Long roleId2 = 789; // Long | Unique identifier of role
        date startDate = 2013-10-20; // date | get all items that's equals as value
        date startDateFrom = 2013-10-20; // date | Filter on startDate that is equals or greater than value
        date startDateTo = 2013-10-20; // date | Filter on startDate that is equals or smaller than value
        date endDate = 2013-10-20; // date | get all items that's equals as value
        date endDateFrom = 2013-10-20; // date | Filter on endDate that is equals or greater than value
        date endDateTo = 2013-10-20; // date | Filter on endDate that is equals or smaller than value
        Long sortOrder = 789; // Long | position of item in list of items
        Long sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
        Long sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Position] result = apiInstance.getPositionsByRoleId(roleId, id, personId, roleId2, startDate, startDateFrom, startDateTo, endDate, endDateFrom, endDateTo, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PositionsApi#getPositionsByRoleId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PositionsApi;

public class PositionsApiExample {

    public static void main(String[] args) {
        PositionsApi apiInstance = new PositionsApi();
        Integer roleId = 56; // Integer | role ID
        Long id = 789; // Long | Unique identifier of position
        Long personId = 789; // Long | Unique identifier of person
        Long roleId2 = 789; // Long | Unique identifier of role
        date startDate = 2013-10-20; // date | get all items that's equals as value
        date startDateFrom = 2013-10-20; // date | Filter on startDate that is equals or greater than value
        date startDateTo = 2013-10-20; // date | Filter on startDate that is equals or smaller than value
        date endDate = 2013-10-20; // date | get all items that's equals as value
        date endDateFrom = 2013-10-20; // date | Filter on endDate that is equals or greater than value
        date endDateTo = 2013-10-20; // date | Filter on endDate that is equals or smaller than value
        Long sortOrder = 789; // Long | position of item in list of items
        Long sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
        Long sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Position] result = apiInstance.getPositionsByRoleId(roleId, id, personId, roleId2, startDate, startDateFrom, startDateTo, endDate, endDateFrom, endDateTo, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PositionsApi#getPositionsByRoleId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Integer *roleId = 56; // role ID
Long *id = 789; // Unique identifier of position (optional)
Long *personId = 789; // Unique identifier of person (optional)
Long *roleId2 = 789; // Unique identifier of role (optional)
date *startDate = 2013-10-20; // get all items that's equals as value (optional)
date *startDateFrom = 2013-10-20; // Filter on startDate that is equals or greater than value (optional)
date *startDateTo = 2013-10-20; // Filter on startDate that is equals or smaller than value (optional)
date *endDate = 2013-10-20; // get all items that's equals as value (optional)
date *endDateFrom = 2013-10-20; // Filter on endDate that is equals or greater than value (optional)
date *endDateTo = 2013-10-20; // Filter on endDate that is equals or smaller than value (optional)
Long *sortOrder = 789; // position of item in list of items (optional)
Long *sortOrderFrom = 789; // Filter on sortOrder that is equals or greater than value (optional)
Long *sortOrderTo = 789; // Filter on sortOrder that is equals or smaller than value (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getPositionsByRoleIdWith:roleId
    id:id
    personId:personId
    roleId2:roleId2
    startDate:startDate
    startDateFrom:startDateFrom
    startDateTo:startDateTo
    endDate:endDate
    endDateFrom:endDateFrom
    endDateTo:endDateTo
    sortOrder:sortOrder
    sortOrderFrom:sortOrderFrom
    sortOrderTo:sortOrderTo
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Position] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.PositionsApi()
var roleId = 56; // {{Integer}} role ID
var opts = { 
  'id': 789, // {{Long}} Unique identifier of position
  'personId': 789, // {{Long}} Unique identifier of person
  'roleId2': 789, // {{Long}} Unique identifier of role
  'startDate': 2013-10-20, // {{date}} get all items that's equals as value
  'startDateFrom': 2013-10-20, // {{date}} Filter on startDate that is equals or greater than value
  'startDateTo': 2013-10-20, // {{date}} Filter on startDate that is equals or smaller than value
  'endDate': 2013-10-20, // {{date}} get all items that's equals as value
  'endDateFrom': 2013-10-20, // {{date}} Filter on endDate that is equals or greater than value
  'endDateTo': 2013-10-20, // {{date}} Filter on endDate that is equals or smaller than value
  'sortOrder': 789, // {{Long}} position of item in list of items
  'sortOrderFrom': 789, // {{Long}} Filter on sortOrder that is equals or greater than value
  'sortOrderTo': 789, // {{Long}} Filter on sortOrder that is equals or smaller than value
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new PositionsApi();
            var roleId = 56;  // Integer | role ID
            var id = 789;  // Long | Unique identifier of position (optional) 
            var personId = 789;  // Long | Unique identifier of person (optional) 
            var roleId2 = 789;  // Long | Unique identifier of role (optional) 
            var startDate = 2013-10-20;  // date | get all items that's equals as value (optional) 
            var startDateFrom = 2013-10-20;  // date | Filter on startDate that is equals or greater than value (optional) 
            var startDateTo = 2013-10-20;  // date | Filter on startDate that is equals or smaller than value (optional) 
            var endDate = 2013-10-20;  // date | get all items that's equals as value (optional) 
            var endDateFrom = 2013-10-20;  // date | Filter on endDate that is equals or greater than value (optional) 
            var endDateTo = 2013-10-20;  // date | Filter on endDate that is equals or smaller than value (optional) 
            var sortOrder = 789;  // Long | position of item in list of items (optional) 
            var sortOrderFrom = 789;  // Long | Filter on sortOrder that is equals or greater than value (optional) 
            var sortOrderTo = 789;  // Long | Filter on sortOrder that is equals or smaller than value (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Position] result = apiInstance.getPositionsByRoleId(roleId, id, personId, roleId2, startDate, startDateFrom, startDateTo, endDate, endDateFrom, endDateTo, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PositionsApi.getPositionsByRoleId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiPositionsApi();
$roleId = 56; // Integer | role ID
$id = 789; // Long | Unique identifier of position
$personId = 789; // Long | Unique identifier of person
$roleId2 = 789; // Long | Unique identifier of role
$startDate = 2013-10-20; // date | get all items that's equals as value
$startDateFrom = 2013-10-20; // date | Filter on startDate that is equals or greater than value
$startDateTo = 2013-10-20; // date | Filter on startDate that is equals or smaller than value
$endDate = 2013-10-20; // date | get all items that's equals as value
$endDateFrom = 2013-10-20; // date | Filter on endDate that is equals or greater than value
$endDateTo = 2013-10-20; // date | Filter on endDate that is equals or smaller than value
$sortOrder = 789; // Long | position of item in list of items
$sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
$sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getPositionsByRoleId($roleId, $id, $personId, $roleId2, $startDate, $startDateFrom, $startDateTo, $endDate, $endDateFrom, $endDateTo, $sortOrder, $sortOrderFrom, $sortOrderTo, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PositionsApi->getPositionsByRoleId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PositionsApi;

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

my $api_instance = WWW::SwaggerClient::PositionsApi->new();
my $roleId = 56; # Integer | role ID
my $id = 789; # Long | Unique identifier of position
my $personId = 789; # Long | Unique identifier of person
my $roleId2 = 789; # Long | Unique identifier of role
my $startDate = 2013-10-20; # date | get all items that's equals as value
my $startDateFrom = 2013-10-20; # date | Filter on startDate that is equals or greater than value
my $startDateTo = 2013-10-20; # date | Filter on startDate that is equals or smaller than value
my $endDate = 2013-10-20; # date | get all items that's equals as value
my $endDateFrom = 2013-10-20; # date | Filter on endDate that is equals or greater than value
my $endDateTo = 2013-10-20; # date | Filter on endDate that is equals or smaller than value
my $sortOrder = 789; # Long | position of item in list of items
my $sortOrderFrom = 789; # Long | Filter on sortOrder that is equals or greater than value
my $sortOrderTo = 789; # Long | Filter on sortOrder that is equals or smaller than value
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getPositionsByRoleId(roleId => $roleId, id => $id, personId => $personId, roleId2 => $roleId2, startDate => $startDate, startDateFrom => $startDateFrom, startDateTo => $startDateTo, endDate => $endDate, endDateFrom => $endDateFrom, endDateTo => $endDateTo, sortOrder => $sortOrder, sortOrderFrom => $sortOrderFrom, sortOrderTo => $sortOrderTo, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PositionsApi->getPositionsByRoleId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.PositionsApi()
roleId = 56 # Integer | role ID
id = 789 # Long | Unique identifier of position (optional)
personId = 789 # Long | Unique identifier of person (optional)
roleId2 = 789 # Long | Unique identifier of role (optional)
startDate = 2013-10-20 # date | get all items that's equals as value (optional)
startDateFrom = 2013-10-20 # date | Filter on startDate that is equals or greater than value (optional)
startDateTo = 2013-10-20 # date | Filter on startDate that is equals or smaller than value (optional)
endDate = 2013-10-20 # date | get all items that's equals as value (optional)
endDateFrom = 2013-10-20 # date | Filter on endDate that is equals or greater than value (optional)
endDateTo = 2013-10-20 # date | Filter on endDate that is equals or smaller than value (optional)
sortOrder = 789 # Long | position of item in list of items (optional)
sortOrderFrom = 789 # Long | Filter on sortOrder that is equals or greater than value (optional)
sortOrderTo = 789 # Long | Filter on sortOrder that is equals or smaller than value (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_positions_by_role_id(roleId, id=id, personId=personId, roleId2=roleId2, startDate=startDate, startDateFrom=startDateFrom, startDateTo=startDateTo, endDate=endDate, endDateFrom=endDateFrom, endDateTo=endDateTo, sortOrder=sortOrder, sortOrderFrom=sortOrderFrom, sortOrderTo=sortOrderTo, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PositionsApi->getPositionsByRoleId: %s\n" % e)

Parameters

Path parameters
Name Description
roleId*
Integer
role ID
Required
Query parameters
Name Description
id
Long (int64)
Unique identifier of position
personId
Long (int64)
Unique identifier of person
roleId
Long (int64)
Unique identifier of role
startDate
date (date)
get all items that's equals as value
startDate_from
date (date)
Filter on startDate that is equals or greater than value
startDate_to
date (date)
Filter on startDate that is equals or smaller than value
endDate
date (date)
get all items that's equals as value
endDate_from
date (date)
Filter on endDate that is equals or greater than value
endDate_to
date (date)
Filter on endDate that is equals or smaller than value
sortOrder
Long (int64)
position of item in list of items
sortOrder_from
Long (int64)
Filter on sortOrder that is equals or greater than value
sortOrder_to
Long (int64)
Filter on sortOrder that is equals or smaller than value
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


Roles

getRoleById

Retrieve specific role


/roles/{roleId}

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/roles/{roleId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RolesApi;

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

public class RolesApiExample {

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

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

        RolesApi apiInstance = new RolesApi();
        Integer roleId = 56; // Integer | role ID
        try {
            Role result = apiInstance.getRoleById(roleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#getRoleById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RolesApi;

public class RolesApiExample {

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

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

[apiInstance getRoleByIdWith:roleId
              completionHandler: ^(Role output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.RolesApi()
var roleId = 56; // {{Integer}} role ID

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

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

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

            var apiInstance = new RolesApi();
            var roleId = 56;  // Integer | role ID

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

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

$api_instance = new Swagger\Client\ApiRolesApi();
$roleId = 56; // Integer | role ID

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

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

my $api_instance = WWW::SwaggerClient::RolesApi->new();
my $roleId = 56; # Integer | role ID

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

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

# create an instance of the API class
api_instance = swagger_client.RolesApi()
roleId = 56 # Integer | role ID

try: 
    api_response = api_instance.get_role_by_id(roleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RolesApi->getRoleById: %s\n" % e)

Parameters

Path parameters
Name Description
roleId*
Integer
role ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - The specified resource was not found


getRoles

Retrieve a list of roles


/roles

Usage and SDK Samples

curl -X GET "https://raad.burgerland.nl/api/v2/roles?id=&name=&sortOrder=&sortOrder_from=&sortOrder_to=&offset=&limit=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RolesApi;

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

public class RolesApiExample {

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

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

        RolesApi apiInstance = new RolesApi();
        Long id = 789; // Long | Unique identifier of role
        String name = name_example; // String | Name of role
        Long sortOrder = 789; // Long | position of item in list of items
        Long sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
        Long sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Role] result = apiInstance.getRoles(id, name, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#getRoles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RolesApi;

public class RolesApiExample {

    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        Long id = 789; // Long | Unique identifier of role
        String name = name_example; // String | Name of role
        Long sortOrder = 789; // Long | position of item in list of items
        Long sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
        Long sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
        Integer offset = 56; // Integer | The number of items to skip before starting to collect the result set
        Integer limit = 56; // Integer | The numbers of items to return
        String sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

        try {
            array[Role] result = apiInstance.getRoles(id, name, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#getRoles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: OAuth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Long *id = 789; // Unique identifier of role (optional)
String *name = name_example; // Name of role (optional)
Long *sortOrder = 789; // position of item in list of items (optional)
Long *sortOrderFrom = 789; // Filter on sortOrder that is equals or greater than value (optional)
Long *sortOrderTo = 789; // Filter on sortOrder that is equals or smaller than value (optional)
Integer *offset = 56; // The number of items to skip before starting to collect the result set (optional)
Integer *limit = 56; // The numbers of items to return (optional)
String *sort = sort_example; // Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

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

[apiInstance getRolesWith:id
    name:name
    sortOrder:sortOrder
    sortOrderFrom:sortOrderFrom
    sortOrderTo:sortOrderTo
    offset:offset
    limit:limit
    sort:sort
              completionHandler: ^(array[Role] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var OpenRaadsinformatieApi = require('open_raadsinformatie_api');
var defaultClient = OpenRaadsinformatieApi.ApiClient.instance;

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

var api = new OpenRaadsinformatieApi.RolesApi()
var opts = { 
  'id': 789, // {{Long}} Unique identifier of role
  'name': name_example, // {{String}} Name of role
  'sortOrder': 789, // {{Long}} position of item in list of items
  'sortOrderFrom': 789, // {{Long}} Filter on sortOrder that is equals or greater than value
  'sortOrderTo': 789, // {{Long}} Filter on sortOrder that is equals or smaller than value
  'offset': 56, // {{Integer}} The number of items to skip before starting to collect the result set
  'limit': 56, // {{Integer}} The numbers of items to return
  'sort': sort_example // {{String}} Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1

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

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

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

            var apiInstance = new RolesApi();
            var id = 789;  // Long | Unique identifier of role (optional) 
            var name = name_example;  // String | Name of role (optional) 
            var sortOrder = 789;  // Long | position of item in list of items (optional) 
            var sortOrderFrom = 789;  // Long | Filter on sortOrder that is equals or greater than value (optional) 
            var sortOrderTo = 789;  // Long | Filter on sortOrder that is equals or smaller than value (optional) 
            var offset = 56;  // Integer | The number of items to skip before starting to collect the result set (optional) 
            var limit = 56;  // Integer | The numbers of items to return (optional) 
            var sort = sort_example;  // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional) 

            try
            {
                array[Role] result = apiInstance.getRoles(id, name, sortOrder, sortOrderFrom, sortOrderTo, offset, limit, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RolesApi.getRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\ApiRolesApi();
$id = 789; // Long | Unique identifier of role
$name = name_example; // String | Name of role
$sortOrder = 789; // Long | position of item in list of items
$sortOrderFrom = 789; // Long | Filter on sortOrder that is equals or greater than value
$sortOrderTo = 789; // Long | Filter on sortOrder that is equals or smaller than value
$offset = 56; // Integer | The number of items to skip before starting to collect the result set
$limit = 56; // Integer | The numbers of items to return
$sort = sort_example; // String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


try {
    $result = $api_instance->getRoles($id, $name, $sortOrder, $sortOrderFrom, $sortOrderTo, $offset, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RolesApi->getRoles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RolesApi;

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

my $api_instance = WWW::SwaggerClient::RolesApi->new();
my $id = 789; # Long | Unique identifier of role
my $name = name_example; # String | Name of role
my $sortOrder = 789; # Long | position of item in list of items
my $sortOrderFrom = 789; # Long | Filter on sortOrder that is equals or greater than value
my $sortOrderTo = 789; # Long | Filter on sortOrder that is equals or smaller than value
my $offset = 56; # Integer | The number of items to skip before starting to collect the result set
my $limit = 56; # Integer | The numbers of items to return
my $sort = sort_example; # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1


eval { 
    my $result = $api_instance->getRoles(id => $id, name => $name, sortOrder => $sortOrder, sortOrderFrom => $sortOrderFrom, sortOrderTo => $sortOrderTo, offset => $offset, limit => $limit, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RolesApi->getRoles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.RolesApi()
id = 789 # Long | Unique identifier of role (optional)
name = name_example # String | Name of role (optional)
sortOrder = 789 # Long | position of item in list of items (optional)
sortOrderFrom = 789 # Long | Filter on sortOrder that is equals or greater than value (optional)
sortOrderTo = 789 # Long | Filter on sortOrder that is equals or smaller than value (optional)
offset = 56 # Integer | The number of items to skip before starting to collect the result set (optional)
limit = 56 # Integer | The numbers of items to return (optional)
sort = sort_example # String | Example sort orders:
  * `name_asc` - String ascending, from a to z
  * `name_desc` - String descending, from z to a
  * `id_asc` - ID ascending, 1 to 99999
  * `id_desc` - ID descending, 99999 to 1
 (optional)

try: 
    api_response = api_instance.get_roles(id=id, name=name, sortOrder=sortOrder, sortOrderFrom=sortOrderFrom, sortOrderTo=sortOrderTo, offset=offset, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RolesApi->getRoles: %s\n" % e)

Parameters

Query parameters
Name Description
id
Long (int64)
Unique identifier of role
name
String
Name of role
sortOrder
Long (int64)
position of item in list of items
sortOrder_from
Long (int64)
Filter on sortOrder that is equals or greater than value
sortOrder_to
Long (int64)
Filter on sortOrder that is equals or smaller than value
offset
Integer
The number of items to skip before starting to collect the result set
limit
Integer
The numbers of items to return
sort
String
Example sort orders: * `name_asc` - String ascending, from a to z * `name_desc` - String descending, from z to a * `id_asc` - ID ascending, 1 to 99999 * `id_desc` - ID descending, 99999 to 1

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized