Swagger\Client\AbsenceApi

All URIs are relative to /

Method	HTTP request	Description
deleteDeleteAbsence	DELETE /api/absences/{id}	Delete an absence
deleteDeletePublicHoliday	DELETE /api/public-holidays/{id}	Delete a public holiday
deleteDeletePublicHolidayGroup	DELETE /api/public-holidays/group/{id}	Delete a public holiday group
getGetAbsences	GET /api/absences	Returns a collection of absences (sickness, vacation, time-off, other).
getGetAbsencesCalendar	GET /api/absences/calendar	Returns a collection of absences (sickness, vacation, time-off, other) for calendar integration.
getGetPublicHolidays	GET /api/public-holidays	Returns a collection of public holidays.
getGetPublicHolidaysCalendar	GET /api/public-holidays/calendar	Returns a collection of public holidays for calendar integration.
getKimaipluginWorkcontractApiAbsenceGetabsencetypes	GET /api/absences/types	Returns a collection of absences (sickness, vacation, time-off, other).
patchConfirmApprovalAbsence	PATCH /api/absences/{id}/confirm	Confirm an approval request
patchRejectApprovalAbsence	PATCH /api/absences/{id}/reject	Reject an approval request
patchRequestApprovalAbsence	PATCH /api/absences/{id}/request	Request an approval

deleteDeleteAbsence

deleteDeleteAbsence($id)

Delete an absence

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\AbsenceApi(
    // 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
);
$id = "id_example"; // string | Absence ID to delete

try {
    $apiInstance->deleteDeleteAbsence($id);
} catch (Exception $e) {
    echo 'Exception when calling AbsenceApi->deleteDeleteAbsence: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Absence ID to delete

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

deleteDeletePublicHoliday

deleteDeletePublicHoliday($id)

Delete a public holiday

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\AbsenceApi(
    // 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
);
$id = "id_example"; // string | Publi holiday ID to delete

try {
    $apiInstance->deleteDeletePublicHoliday($id);
} catch (Exception $e) {
    echo 'Exception when calling AbsenceApi->deleteDeletePublicHoliday: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Publi holiday ID to delete

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

deleteDeletePublicHolidayGroup

deleteDeletePublicHolidayGroup($id)

Delete a public holiday group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\AbsenceApi(
    // 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
);
$id = "id_example"; // string | Public holiday group ID to delete

try {
    $apiInstance->deleteDeletePublicHolidayGroup($id);
} catch (Exception $e) {
    echo 'Exception when calling AbsenceApi->deleteDeletePublicHolidayGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Public holiday group ID to delete

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

getGetAbsences

\Swagger\Client\Model\Absence[] getGetAbsences($user, $begin, $end)

Returns a collection of absences (sickness, vacation, time-off, other).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\AbsenceApi(
    // 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
);
$user = "user_example"; // string | User ID to filter absences. Needs permission 'contract_other_profile' (default: current user)
$begin = "begin_example"; // string | Only absences after this date will be included (format: HTML5)
$end = "end_example"; // string | Only absences before this date will be included (format: HTML5)

try {
    $result = $apiInstance->getGetAbsences($user, $begin, $end);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AbsenceApi->getGetAbsences: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
user	string	User ID to filter absences. Needs permission 'contract_other_profile' (default: current user)	[optional]
begin	string	Only absences after this date will be included (format: HTML5)	[optional]
end	string	Only absences before this date will be included (format: HTML5)	[optional]

Return type

\Swagger\Client\Model\Absence[]

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getGetAbsencesCalendar

\Swagger\Client\Model\CalendarEvent[] getGetAbsencesCalendar($user, $begin, $end, $language)

Returns a collection of absences (sickness, vacation, time-off, other) for calendar integration.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\AbsenceApi(
    // 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
);
$user = "user_example"; // string | User ID to filter absences. Needs permission 'contract_other_profile' (default: current user)
$begin = "begin_example"; // string | Only absences after this date will be included (format: HTML5)
$end = "end_example"; // string | Only absences before this date will be included (format: HTML5)
$language = "language_example"; // string | The language to be used for displaying the absences (format: en or en_GB)

try {
    $result = $apiInstance->getGetAbsencesCalendar($user, $begin, $end, $language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AbsenceApi->getGetAbsencesCalendar: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
user	string	User ID to filter absences. Needs permission 'contract_other_profile' (default: current user)	[optional]
begin	string	Only absences after this date will be included (format: HTML5)	[optional]
end	string	Only absences before this date will be included (format: HTML5)	[optional]
language	string	The language to be used for displaying the absences (format: en or en_GB)	[optional]

Return type

\Swagger\Client\Model\CalendarEvent[]

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getGetPublicHolidays

\Swagger\Client\Model\PublicHoliday[] getGetPublicHolidays($group, $begin, $end)

Returns a collection of public holidays.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\AbsenceApi(
    // 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
);
$group = "group_example"; // string | Public holiday - group ID to filter. (default: default group)
$begin = "begin_example"; // string | Only absences after this date will be included (format: HTML5)
$end = "end_example"; // string | Only absences before this date will be included (format: HTML5)

try {
    $result = $apiInstance->getGetPublicHolidays($group, $begin, $end);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AbsenceApi->getGetPublicHolidays: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group	string	Public holiday - group ID to filter. (default: default group)	[optional]
begin	string	Only absences after this date will be included (format: HTML5)	[optional]
end	string	Only absences before this date will be included (format: HTML5)	[optional]

Return type

\Swagger\Client\Model\PublicHoliday[]

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getGetPublicHolidaysCalendar

\Swagger\Client\Model\CalendarEvent[] getGetPublicHolidaysCalendar($group, $begin, $end)

Returns a collection of public holidays for calendar integration.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\AbsenceApi(
    // 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
);
$group = "group_example"; // string | Public holiday - group ID to filter. (default: default group)
$begin = "begin_example"; // string | Only absences after this date will be included (format: HTML5)
$end = "end_example"; // string | Only absences before this date will be included (format: HTML5)

try {
    $result = $apiInstance->getGetPublicHolidaysCalendar($group, $begin, $end);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AbsenceApi->getGetPublicHolidaysCalendar: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
group	string	Public holiday - group ID to filter. (default: default group)	[optional]
begin	string	Only absences after this date will be included (format: HTML5)	[optional]
end	string	Only absences before this date will be included (format: HTML5)	[optional]

Return type

\Swagger\Client\Model\CalendarEvent[]

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getKimaipluginWorkcontractApiAbsenceGetabsencetypes

map[string,string] getKimaipluginWorkcontractApiAbsenceGetabsencetypes($language)

Returns a collection of absences (sickness, vacation, time-off, other).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\AbsenceApi(
    // 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
);
$language = "language_example"; // string | The language to be used for displaying the absences types (format: de or en_GB)

try {
    $result = $apiInstance->getKimaipluginWorkcontractApiAbsenceGetabsencetypes($language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AbsenceApi->getKimaipluginWorkcontractApiAbsenceGetabsencetypes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
language	string	The language to be used for displaying the absences types (format: de or en_GB)	[optional]

Return type

map[string,string]

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

patchConfirmApprovalAbsence

\Swagger\Client\Model\Absence patchConfirmApprovalAbsence($id)

Confirm an approval request

Confirm approval request for absence

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\AbsenceApi(
    // 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
);
$id = "id_example"; // string | Absence ID

try {
    $result = $apiInstance->patchConfirmApprovalAbsence($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AbsenceApi->patchConfirmApprovalAbsence: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Absence ID

Return type

\Swagger\Client\Model\Absence

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

patchRejectApprovalAbsence

\Swagger\Client\Model\Absence patchRejectApprovalAbsence($id)

Reject an approval request

Reject approval request for absence

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\AbsenceApi(
    // 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
);
$id = "id_example"; // string | Absence ID

try {
    $result = $apiInstance->patchRejectApprovalAbsence($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AbsenceApi->patchRejectApprovalAbsence: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Absence ID

Return type

\Swagger\Client\Model\Absence

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

patchRequestApprovalAbsence

\Swagger\Client\Model\Absence patchRequestApprovalAbsence($id)

Request an approval

Request approval for absence

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Swagger\Client\Api\AbsenceApi(
    // 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
);
$id = "id_example"; // string | Absence ID

try {
    $result = $apiInstance->patchRequestApprovalAbsence($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AbsenceApi->patchRequestApprovalAbsence: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	Absence ID

Return type

\Swagger\Client\Model\Absence

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

AbsenceApi.md

Latest commit

History

AbsenceApi.md

File metadata and controls

Swagger\Client\AbsenceApi

deleteDeleteAbsence

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDeletePublicHoliday

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDeletePublicHolidayGroup

Example

Parameters

Return type

Authorization

HTTP request headers

getGetAbsences

Example

Parameters

Return type

Authorization

HTTP request headers

getGetAbsencesCalendar

Example

Parameters

Return type

Authorization

HTTP request headers

getGetPublicHolidays

Example

Parameters

Return type

Authorization

HTTP request headers

getGetPublicHolidaysCalendar

Example

Parameters

Return type

Authorization

HTTP request headers

getKimaipluginWorkcontractApiAbsenceGetabsencetypes

Example

Parameters

Return type

Authorization

HTTP request headers

patchConfirmApprovalAbsence

Example

Parameters

Return type

Authorization

HTTP request headers

patchRejectApprovalAbsence

Example

Parameters

Return type

Authorization

HTTP request headers

patchRequestApprovalAbsence

Example

Parameters

Return type

Authorization

HTTP request headers