Returns event data based on the `type` path parameter. Supports retrieving events (all or user-specific), event types, event categories, event settings, and calendar events.
- **all**: Returns all events grouped by filter (overview, ongoing, upcoming, past).
- **my**: Returns events the current user is registered for, grouped by filter.
- **event-types**: Returns available event type taxonomy terms.
- **event-categories**: Returns available event category taxonomy terms.
- **settings**: Returns event module settings including title, description, display configuration, and category colors.
- **calendar**: Returns events for a specific month, suitable for a calendar view.
curl -X GET \
-H "Authorization: Bearer [[accessToken]]" \
-H "Accept: application/json" \
"https://nextworkplace.staging/api/v1/event/{type}?filter=filter_example&event_type=&event_category=&ongoing_offset=56&upcoming_offset=56&past_offset=56&year=56&month=56&bookmarked_only=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OverviewPagesApi;
import java.io.File;
import java.util.*;
public class OverviewPagesApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
HttpBearerAuth JWT-Bearer = (HttpBearerAuth) defaultClient.getAuthentication("JWT-Bearer");
JWT-Bearer.setBearerToken("BEARER TOKEN");
// Create an instance of the API class
OverviewPagesApi apiInstance = new OverviewPagesApi();
String type = type_example; // String | The type of event data to retrieve.
String filter = filter_example; // String | Filter events by status. Only applies to `all` and `my` types.
EventTypeGetEventTypeParameter eventType = ; // EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
EventTypeGetEventTypeParameter eventCategory = ; // EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
Integer ongoingOffset = 56; // Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types.
Integer upcomingOffset = 56; // Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types.
Integer pastOffset = 56; // Integer | Pagination offset for past events. Only applies to `all` and `my` types.
Integer year = 56; // Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
Integer month = 56; // Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
Boolean bookmarkedOnly = true; // Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.
try {
_event__type__get_200_response result = apiInstance.eventTypeGet(type, filter, eventType, eventCategory, ongoingOffset, upcomingOffset, pastOffset, year, month, bookmarkedOnly);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OverviewPagesApi#eventTypeGet");
e.printStackTrace();
}
}
}
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String type = new String(); // String | The type of event data to retrieve.
final String filter = new String(); // String | Filter events by status. Only applies to `all` and `my` types.
final EventTypeGetEventTypeParameter eventType = new EventTypeGetEventTypeParameter(); // EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
final EventTypeGetEventTypeParameter eventCategory = new EventTypeGetEventTypeParameter(); // EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
final Integer ongoingOffset = new Integer(); // Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types.
final Integer upcomingOffset = new Integer(); // Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types.
final Integer pastOffset = new Integer(); // Integer | Pagination offset for past events. Only applies to `all` and `my` types.
final Integer year = new Integer(); // Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
final Integer month = new Integer(); // Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
final Boolean bookmarkedOnly = new Boolean(); // Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.
try {
final result = await api_instance.eventTypeGet(type, filter, eventType, eventCategory, ongoingOffset, upcomingOffset, pastOffset, year, month, bookmarkedOnly);
print(result);
} catch (e) {
print('Exception when calling DefaultApi->eventTypeGet: $e\n');
}
import org.openapitools.client.api.OverviewPagesApi;
public class OverviewPagesApiExample {
public static void main(String[] args) {
OverviewPagesApi apiInstance = new OverviewPagesApi();
String type = type_example; // String | The type of event data to retrieve.
String filter = filter_example; // String | Filter events by status. Only applies to `all` and `my` types.
EventTypeGetEventTypeParameter eventType = ; // EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
EventTypeGetEventTypeParameter eventCategory = ; // EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
Integer ongoingOffset = 56; // Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types.
Integer upcomingOffset = 56; // Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types.
Integer pastOffset = 56; // Integer | Pagination offset for past events. Only applies to `all` and `my` types.
Integer year = 56; // Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
Integer month = 56; // Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
Boolean bookmarkedOnly = true; // Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.
try {
_event__type__get_200_response result = apiInstance.eventTypeGet(type, filter, eventType, eventCategory, ongoingOffset, upcomingOffset, pastOffset, year, month, bookmarkedOnly);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OverviewPagesApi#eventTypeGet");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Create an instance of the API class
OverviewPagesApi *apiInstance = [[OverviewPagesApi alloc] init];
String *type = type_example; // The type of event data to retrieve. (default to null)
String *filter = filter_example; // Filter events by status. Only applies to `all` and `my` types. (optional) (default to overview)
EventTypeGetEventTypeParameter *eventType = ; // Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types. (optional) (default to null)
EventTypeGetEventTypeParameter *eventCategory = ; // Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types. (optional) (default to null)
Integer *ongoingOffset = 56; // Pagination offset for ongoing events. Only applies to `all` and `my` types. (optional) (default to 0)
Integer *upcomingOffset = 56; // Pagination offset for upcoming events. Only applies to `all` and `my` types. (optional) (default to 0)
Integer *pastOffset = 56; // Pagination offset for past events. Only applies to `all` and `my` types. (optional) (default to 0)
Integer *year = 56; // The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100. (optional) (default to null)
Integer *month = 56; // The month for calendar view. Required when type is `calendar`. Must be between 1 and 12. (optional) (default to null)
Boolean *bookmarkedOnly = true; // When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type. (optional) (default to false)
// Get event data by type.
[apiInstance eventTypeGetWith:type
filter:filter
eventType:eventType
eventCategory:eventCategory
ongoingOffset:ongoingOffset
upcomingOffset:upcomingOffset
pastOffset:pastOffset
year:year
month:month
bookmarkedOnly:bookmarkedOnly
completionHandler: ^(_event__type__get_200_response output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PiipeApi = require('piipe_api');
var defaultClient = PiipeApi.ApiClient.instance;
// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
var JWT-Bearer = defaultClient.authentications['JWT-Bearer'];
JWT-Bearer.accessToken = "YOUR ACCESS TOKEN";
// Create an instance of the API class
var api = new PiipeApi.OverviewPagesApi()
var type = type_example; // {String} The type of event data to retrieve.
var opts = {
'filter': filter_example, // {String} Filter events by status. Only applies to `all` and `my` types.
'eventType': , // {EventTypeGetEventTypeParameter} Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
'eventCategory': , // {EventTypeGetEventTypeParameter} Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
'ongoingOffset': 56, // {Integer} Pagination offset for ongoing events. Only applies to `all` and `my` types.
'upcomingOffset': 56, // {Integer} Pagination offset for upcoming events. Only applies to `all` and `my` types.
'pastOffset': 56, // {Integer} Pagination offset for past events. Only applies to `all` and `my` types.
'year': 56, // {Integer} The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
'month': 56, // {Integer} The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
'bookmarkedOnly': true // {Boolean} When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.eventTypeGet(type, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class eventTypeGetExample
{
public void main()
{
// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
// Create an instance of the API class
var apiInstance = new OverviewPagesApi();
var type = type_example; // String | The type of event data to retrieve. (default to null)
var filter = filter_example; // String | Filter events by status. Only applies to `all` and `my` types. (optional) (default to overview)
var eventType = new EventTypeGetEventTypeParameter(); // EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types. (optional) (default to null)
var eventCategory = new EventTypeGetEventTypeParameter(); // EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types. (optional) (default to null)
var ongoingOffset = 56; // Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types. (optional) (default to 0)
var upcomingOffset = 56; // Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types. (optional) (default to 0)
var pastOffset = 56; // Integer | Pagination offset for past events. Only applies to `all` and `my` types. (optional) (default to 0)
var year = 56; // Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100. (optional) (default to null)
var month = 56; // Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12. (optional) (default to null)
var bookmarkedOnly = true; // Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type. (optional) (default to false)
try {
// Get event data by type.
_event__type__get_200_response result = apiInstance.eventTypeGet(type, filter, eventType, eventCategory, ongoingOffset, upcomingOffset, pastOffset, year, month, bookmarkedOnly);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling OverviewPagesApi.eventTypeGet: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OverviewPagesApi();
$type = type_example; // String | The type of event data to retrieve.
$filter = filter_example; // String | Filter events by status. Only applies to `all` and `my` types.
$eventType = ; // EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
$eventCategory = ; // EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
$ongoingOffset = 56; // Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types.
$upcomingOffset = 56; // Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types.
$pastOffset = 56; // Integer | Pagination offset for past events. Only applies to `all` and `my` types.
$year = 56; // Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
$month = 56; // Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
$bookmarkedOnly = true; // Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.
try {
$result = $api_instance->eventTypeGet($type, $filter, $eventType, $eventCategory, $ongoingOffset, $upcomingOffset, $pastOffset, $year, $month, $bookmarkedOnly);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling OverviewPagesApi->eventTypeGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OverviewPagesApi;
# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OverviewPagesApi->new();
my $type = type_example; # String | The type of event data to retrieve.
my $filter = filter_example; # String | Filter events by status. Only applies to `all` and `my` types.
my $eventType = ; # EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
my $eventCategory = ; # EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types.
my $ongoingOffset = 56; # Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types.
my $upcomingOffset = 56; # Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types.
my $pastOffset = 56; # Integer | Pagination offset for past events. Only applies to `all` and `my` types.
my $year = 56; # Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100.
my $month = 56; # Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12.
my $bookmarkedOnly = true; # Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type.
eval {
my $result = $api_instance->eventTypeGet(type => $type, filter => $filter, eventType => $eventType, eventCategory => $eventCategory, ongoingOffset => $ongoingOffset, upcomingOffset => $upcomingOffset, pastOffset => $pastOffset, year => $year, month => $month, bookmarkedOnly => $bookmarkedOnly);
print Dumper($result);
};
if ($@) {
warn "Exception when calling OverviewPagesApi->eventTypeGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Configure Bearer (JWT access token) access token for authorization: JWT-Bearer
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Create an instance of the API class
api_instance = openapi_client.OverviewPagesApi()
type = type_example # String | The type of event data to retrieve. (default to null)
filter = filter_example # String | Filter events by status. Only applies to `all` and `my` types. (optional) (default to overview)
eventType = # EventTypeGetEventTypeParameter | Filter by event type term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types. (optional) (default to null)
eventCategory = # EventTypeGetEventTypeParameter | Filter by event category term ID. Pass `all` or omit for no filter. Applies to `all`, `my`, and `calendar` types. (optional) (default to null)
ongoingOffset = 56 # Integer | Pagination offset for ongoing events. Only applies to `all` and `my` types. (optional) (default to 0)
upcomingOffset = 56 # Integer | Pagination offset for upcoming events. Only applies to `all` and `my` types. (optional) (default to 0)
pastOffset = 56 # Integer | Pagination offset for past events. Only applies to `all` and `my` types. (optional) (default to 0)
year = 56 # Integer | The year for calendar view. Required when type is `calendar`. Must be between 2025 and 2100. (optional) (default to null)
month = 56 # Integer | The month for calendar view. Required when type is `calendar`. Must be between 1 and 12. (optional) (default to null)
bookmarkedOnly = true # Boolean | When `true`, only returns bookmarked events for the current user. Only applies to `calendar` type. (optional) (default to false)
try:
# Get event data by type.
api_response = api_instance.event_type_get(type, filter=filter, eventType=eventType, eventCategory=eventCategory, ongoingOffset=ongoingOffset, upcomingOffset=upcomingOffset, pastOffset=pastOffset, year=year, month=month, bookmarkedOnly=bookmarkedOnly)
pprint(api_response)
except ApiException as e:
print("Exception when calling OverviewPagesApi->eventTypeGet: %s\n" % e)
extern crate OverviewPagesApi;
pub fn main() {
let type = type_example; // String
let filter = filter_example; // String
let eventType = ; // EventTypeGetEventTypeParameter
let eventCategory = ; // EventTypeGetEventTypeParameter
let ongoingOffset = 56; // Integer
let upcomingOffset = 56; // Integer
let pastOffset = 56; // Integer
let year = 56; // Integer
let month = 56; // Integer
let bookmarkedOnly = true; // Boolean
let mut context = OverviewPagesApi::Context::default();
let result = client.eventTypeGet(type, filter, eventType, eventCategory, ongoingOffset, upcomingOffset, pastOffset, year, month, bookmarkedOnly, &context).wait();
println!("{:?}", result);
}