Skip to content

Latest commit

 

History

History
161 lines (116 loc) · 7.52 KB

NotifikaceApi.md

File metadata and controls

161 lines (116 loc) · 7.52 KB
Raw

RaynetApiClient\NotifikaceApi

All URIs are relative to https://app.raynet.cz/api/v2, except if the operation defines another base path.

Method HTTP request Description
notificationDelete() DELETE /notification/{notificationId}/ smazání notifikace
notificationGet() GET /notification/ seznam notifikací

notificationDelete()

notificationDelete($notification_id)

smazání notifikace

Uživatelé mohou smazat jen vlastní notifikace, kdežto administrátor může smazat i cizí.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: instanceName
$config = RaynetApiClient\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RaynetApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = RaynetApiClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RaynetApiClient\Api\NotifikaceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$notification_id = 123; // int | ID notifikace

try {
    $apiInstance->notificationDelete($notification_id);
} catch (Exception $e) {
    echo 'Exception when calling NotifikaceApi->notificationDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
notification_id int ID notifikace

Return type

void (empty response body)

Authorization

instanceName, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

notificationGet()

notificationGet($offset, $limit, $sort_column, $sort_direction, $id, $date, $sender, $recipient, $flag, $read, $context)

seznam notifikací

Získání notifikací. Pokud není použit filtr recipient[CUSTOM]=all-recipient, tak jsou vráceny jen notifikace aktuálního uživatele. https://app.raynet.cz/api/v2/notification/?sender[EQ]=2

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: instanceName
$config = RaynetApiClient\Configuration::getDefaultConfiguration()->setApiKey('X-Instance-Name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RaynetApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Instance-Name', 'Bearer');

// Configure HTTP basic authorization: basicAuth
$config = RaynetApiClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new RaynetApiClient\Api\NotifikaceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$offset = 0; // int | Zobrazeni zaznamu od zacatku
$limit = 100; // int | Maximální počet vrácených záznamů je `1000`
$sort_column = 'sort_column_example'; // string | 
$sort_direction = 'sort_direction_example'; // string | 
$id = 56; // int | Filtrování podle ID. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`
$date = 'date_example'; // string | Filtrování podle data notifikace. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE`
$sender = 56; // int | Filtrování podle odesílatele. S operátorem `CUSTOM`
$recipient = 'recipient_example'; // string | Filtrování podle příjemce. V případě `recipient[CUSTOM]=all-recipient` operátoru umožní vyfiltrovat notifikace všech uživatelů. Tento filtr může použít pouze uživatel s rolí administrátor. Lze využít operátoru `EQ`, `NE`, `IN`, `CUSTOM`
$flag = True; // bool | Filtrování notifikací označených hvězdičkou. Lze využít operátoru `EQ`, `NE`.
$read = True; // bool | Filtrování přečtených notifikací. Lze využít operátoru `EQ`, `NE`.
$context = 'context_example'; // string | Filtrování podle kontextu notifikace, kde kontext musí být ve formátu NázevEntity#IdEntity (podporované názvy entit jsou: 'company', 'lead', 'person', 'businessCase', 'offer', 'salesOrder', 'product', 'project', 'invoice', 'task', 'email', 'event', 'letter', 'phoneCall', 'meeting')

try {
    $apiInstance->notificationGet($offset, $limit, $sort_column, $sort_direction, $id, $date, $sender, $recipient, $flag, $read, $context);
} catch (Exception $e) {
    echo 'Exception when calling NotifikaceApi->notificationGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
offset int Zobrazeni zaznamu od zacatku [optional]
limit int Maximální počet vrácených záznamů je `1000` [optional]
sort_column string [optional]
sort_direction string [optional]
id int Filtrování podle ID. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE` [optional]
date string Filtrování podle data notifikace. Lze využít operátoru `EQ`, `NE`, `GT`, `GE`, `LT`, `LE` [optional]
sender int Filtrování podle odesílatele. S operátorem `CUSTOM` [optional]
recipient string Filtrování podle příjemce. V případě `recipient[CUSTOM]=all-recipient` operátoru umožní vyfiltrovat notifikace všech uživatelů. Tento filtr může použít pouze uživatel s rolí administrátor. Lze využít operátoru `EQ`, `NE`, `IN`, `CUSTOM` [optional]
flag bool Filtrování notifikací označených hvězdičkou. Lze využít operátoru `EQ`, `NE`. [optional]
read bool Filtrování přečtených notifikací. Lze využít operátoru `EQ`, `NE`. [optional]
context string Filtrování podle kontextu notifikace, kde kontext musí být ve formátu NázevEntity#IdEntity (podporované názvy entit jsou: 'company', 'lead', 'person', 'businessCase', 'offer', 'salesOrder', 'product', 'project', 'invoice', 'task', 'email', 'event', 'letter', 'phoneCall', 'meeting') [optional]

Return type

void (empty response body)

Authorization

instanceName, basicAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]