Skip to content
Snippets Groups Projects
Select Git revision
  • cad3fd33956e8daa1f368f06fc8da50b3d08bebe
  • master default
  • rename_category_group
  • php8.1_deprecations
  • v3.5
  • v3.3.1
  • v3.4
  • v3.3
  • v3.2
  • v3.1
  • v3.0
  • v2.4
  • v2.3
  • v2.2
  • v2.1
  • v2.0
  • v1.0
17 results

EventsApi.md

Blame
  • user avatar
    CarstenKarbach authored
    884557ae
    History

    Swagger\Client\EventsApi

    All URIs are relative to https://localhost

    Method HTTP request Description
    eventsGet GET /events
    eventsPost POST /events

    eventsGet

    \Swagger\Client\Model\Event[] eventsGet()

    Get a list of all events sent to this service.

    Example

    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $api_instance = new Swagger\Client\Api\EventsApi();
    
    try {
        $result = $api_instance->eventsGet();
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling EventsApi->eventsGet: ', $e->getMessage(), PHP_EOL;
    }
    ?>

    Parameters

    This endpoint does not need any parameter.

    Return type

    \Swagger\Client\Model\Event[]

    Authorization

    No authorization required

    HTTP request headers

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

    Back to top(#) Back to API list(../../README.md#documentation-for-api-endpoints) Back to Model list(../../README.md#documentation-for-models) Back to README(../../README.md)

    eventsPost

    string eventsPost($event)

    Send a new event.

    Example

    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $api_instance = new Swagger\Client\Api\EventsApi();
    $event = new \Swagger\Client\Model\Event(); // \Swagger\Client\Model\Event | The event, which happened and should be handled.
    
    try {
        $result = $api_instance->eventsPost($event);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling EventsApi->eventsPost: ', $e->getMessage(), PHP_EOL;
    }
    ?>

    Parameters

    Name Type Description Notes
    event \Swagger\Client\Model\Event The event, which happened and should be handled.

    Return type

    string

    Authorization

    No authorization required

    HTTP request headers

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

    Back to top(#) Back to API list(../../README.md#documentation-for-api-endpoints) Back to Model list(../../README.md#documentation-for-models) Back to README(../../README.md)