KoronacloudApiV3.TicketingApi

All URIs are relative to https://www.koronacloud.com/web/api/v3

Method	HTTP request	Description
getEntryGate	GET /accounts/{koronaAccountId}/entryGates/{entryGateId}	returns the single entry gate
getEntryGates	GET /accounts/{koronaAccountId}/entryGates	lists all entry gates
getEvent	GET /accounts/{koronaAccountId}/events/{eventId}	return the single event
getEvents	GET /accounts/{koronaAccountId}/events	lists all events
getTicketDefinition	GET /accounts/{koronaAccountId}/ticketDefinitions/{ticketDefinitionId}	returns the single ticket definition
getTicketDefinitions	GET /accounts/{koronaAccountId}/ticketDefinitions	lists all ticket definitions

getEntryGate

EntryGate getEntryGate(entryGateId, koronaAccountId)

returns the single entry gate

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.TicketingApi();

var entryGateId = "entryGateId_example"; // String | id of the related object (important: id should match the uuid-format)

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getEntryGate(entryGateId, koronaAccountId, callback);

Parameters

Name	Type	Description	Notes
entryGateId	String	id of the related object (important: id should match the uuid-format)
koronaAccountId	String	account id of the korona.cloud account

Return type

EntryGate

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

getEntryGates

ResultListEntryGate getEntryGates(koronaAccountId, opts)

lists all entry gates

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.TicketingApi();

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account

var opts = { 
  'page': 56, // Number | number of the page to fetch
  'size': 56, // Number | amount of objects to return per page
  'sort': "sort_example", // String | attribute to sort by (multiple separated by comma; max. 5)
  'revision': 789, // Number | last revision number, objects with a greater revision than this will be returned
  'includeDeleted': true // Boolean | indicates deleted objects should be loaded or not (default: false)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getEntryGates(koronaAccountId, opts, callback);

Parameters

Name	Type	Description	Notes
koronaAccountId	String	account id of the korona.cloud account
page	Number	number of the page to fetch	[optional]
size	Number	amount of objects to return per page	[optional]
sort	String	attribute to sort by (multiple separated by comma; max. 5)	[optional]
revision	Number	last revision number, objects with a greater revision than this will be returned	[optional]
includeDeleted	Boolean	indicates deleted objects should be loaded or not (default: false)	[optional]

Return type

ResultListEntryGate

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

getEvent

Event getEvent(eventId, koronaAccountId)

return the single event

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.TicketingApi();

var eventId = "eventId_example"; // String | id of the related object (important: id should match the uuid-format)

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getEvent(eventId, koronaAccountId, callback);

Parameters

Name	Type	Description	Notes
eventId	String	id of the related object (important: id should match the uuid-format)
koronaAccountId	String	account id of the korona.cloud account

Return type

Event

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

getEvents

ResultListEvent getEvents(koronaAccountId, opts)

lists all events

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.TicketingApi();

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account

var opts = { 
  'page': 56, // Number | number of the page to fetch
  'size': 56, // Number | amount of objects to return per page
  'sort': "sort_example", // String | attribute to sort by (multiple separated by comma; max. 5)
  'revision': 789, // Number | last revision number, objects with a greater revision than this will be returned
  'includeDeleted': true // Boolean | indicates deleted objects should be loaded or not (default: false)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getEvents(koronaAccountId, opts, callback);

Parameters

Name	Type	Description	Notes
koronaAccountId	String	account id of the korona.cloud account
page	Number	number of the page to fetch	[optional]
size	Number	amount of objects to return per page	[optional]
sort	String	attribute to sort by (multiple separated by comma; max. 5)	[optional]
revision	Number	last revision number, objects with a greater revision than this will be returned	[optional]
includeDeleted	Boolean	indicates deleted objects should be loaded or not (default: false)	[optional]

Return type

ResultListEvent

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

getTicketDefinition

TicketDefinition getTicketDefinition(ticketDefinitionId, koronaAccountId)

returns the single ticket definition

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.TicketingApi();

var ticketDefinitionId = "ticketDefinitionId_example"; // String | id of the related object (important: id should match the uuid-format)

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getTicketDefinition(ticketDefinitionId, koronaAccountId, callback);

Parameters

Name	Type	Description	Notes
ticketDefinitionId	String	id of the related object (important: id should match the uuid-format)
koronaAccountId	String	account id of the korona.cloud account

Return type

TicketDefinition

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

getTicketDefinitions

ResultListTicketDefinition getTicketDefinitions(koronaAccountId, opts)

lists all ticket definitions

Example

var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new KoronacloudApiV3.TicketingApi();

var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account

var opts = { 
  'page': 56, // Number | number of the page to fetch
  'size': 56, // Number | amount of objects to return per page
  'sort': "sort_example", // String | attribute to sort by (multiple separated by comma; max. 5)
  'revision': 789, // Number | last revision number, objects with a greater revision than this will be returned
  'includeDeleted': true // Boolean | indicates deleted objects should be loaded or not (default: false)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getTicketDefinitions(koronaAccountId, opts, callback);

Parameters

Name	Type	Description	Notes
koronaAccountId	String	account id of the korona.cloud account
page	Number	number of the page to fetch	[optional]
size	Number	amount of objects to return per page	[optional]
sort	String	attribute to sort by (multiple separated by comma; max. 5)	[optional]
revision	Number	last revision number, objects with a greater revision than this will be returned	[optional]
includeDeleted	Boolean	indicates deleted objects should be loaded or not (default: false)	[optional]

Return type

ResultListTicketDefinition

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

Uh oh!

FilesExpand file tree

TicketingApi.md

Latest commit

History

TicketingApi.md

File metadata and controls

KoronacloudApiV3.TicketingApi

getEntryGate

Example

Parameters

Return type

Authorization

HTTP request headers

getEntryGates

Example

Parameters

Return type

Authorization

HTTP request headers

getEvent

Example

Parameters

Return type

Authorization

HTTP request headers

getEvents

Example

Parameters

Return type

Authorization

HTTP request headers

getTicketDefinition

Example

Parameters

Return type

Authorization

HTTP request headers

getTicketDefinitions

Example

Parameters

Return type

Authorization

HTTP request headers