SevUserApi.md

Itsmind\Sevdesk\SevUserApi

All URIs are relative to https://my.sevdesk.de/api/v1, except if the operation defines another base path.

Method	HTTP request	Description
getSevUserById()	GET /SevUser/{sevUserId}
getSevUsers()	GET /SevUser

getSevUserById()

getSevUserById($sev_user_id, $embed): \Itsmind\Sevdesk\Model\GetSevUserById200Response

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\SevUserApi(
    // 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
);
$sev_user_id = 56; // int
$embed = array('embed_example'); // string[] | Get some additional information. Embed can handle multiple values, they must be separated by comma.

try {
    $result = $apiInstance->getSevUserById($sev_user_id, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SevUserApi->getSevUserById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
sev_user_id	int
embed	string[]	Get some additional information. Embed can handle multiple values, they must be separated by comma.	[optional]

Return type

\Itsmind\Sevdesk\Model\GetSevUserById200Response

Authorization

api_key

HTTP request headers

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

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

getSevUsers()

getSevUsers($count_all, $offset, $limit, $embed, $ignore_roles): \Itsmind\Sevdesk\Model\GetSevUsers200Response

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\SevUserApi(
    // 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
);
$count_all = True; // bool | If all objects should be counted
$offset = 56; // int | Which offset to start with
$limit = 56; // int | The max number of objects to return
$embed = array('embed_example'); // string[] | Get some additional information. Embed can handle multiple values, they must be separated by comma.
$ignore_roles = new \Itsmind\Sevdesk\Model\\Itsmind\Sevdesk\Model\GetSevUsersIgnoreRolesParameter(); // \Itsmind\Sevdesk\Model\GetSevUsersIgnoreRolesParameter

try {
    $result = $apiInstance->getSevUsers($count_all, $offset, $limit, $embed, $ignore_roles);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SevUserApi->getSevUsers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
count_all	bool	If all objects should be counted	[optional]
offset	int	Which offset to start with	[optional]
limit	int	The max number of objects to return	[optional]
embed	string[]	Get some additional information. Embed can handle multiple values, they must be separated by comma.	[optional]
ignore_roles	\Itsmind\Sevdesk\Model\GetSevUsersIgnoreRolesParameter		[optional]

Return type

\Itsmind\Sevdesk\Model\GetSevUsers200Response

Authorization

api_key

HTTP request headers

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

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