omsorg/omsorgWeb/mitarbeiter-app/api-client-php/docs/Api/EmployeesApi.md

OmsorgCoreClient\EmployeesApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
apiEmployeesGet()	GET /api/employees
apiEmployeesIdDelete()	DELETE /api/employees/{id}
apiEmployeesIdGet()	GET /api/employees/{id}
apiEmployeesIdPut()	PUT /api/employees/{id}
apiEmployeesPost()	POST /api/employees

apiEmployeesGet()

apiEmployeesGet($search, $status, $employment_type, $page, $page_size): \OmsorgCoreClient\Model\EmployeeResponsePagedResponse

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\EmployeesApi(
    // 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
);
$search = 'search_example'; // string
$status = 'status_example'; // string
$employment_type = 'employment_type_example'; // string
$page = 1; // int
$page_size = 20; // int

try {
    $result = $apiInstance->apiEmployeesGet($search, $status, $employment_type, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployeesApi->apiEmployeesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
search	string		[optional]
status	string		[optional]
employment_type	string		[optional]
page	int		[optional] [default to 1]
page_size	int		[optional] [default to 20]

Return type

\OmsorgCoreClient\Model\EmployeeResponsePagedResponse

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json, text/json

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

apiEmployeesIdDelete()

apiEmployeesIdDelete($id)

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\EmployeesApi(
    // 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

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

Parameters

Name	Type	Description	Notes
id	string

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]

apiEmployeesIdGet()

apiEmployeesIdGet($id): \OmsorgCoreClient\Model\EmployeeResponse

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\EmployeesApi(
    // 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

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

Parameters

Name	Type	Description	Notes
id	string

Return type

\OmsorgCoreClient\Model\EmployeeResponse

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json, text/json

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

apiEmployeesIdPut()

apiEmployeesIdPut($id, $update_employee_request): \OmsorgCoreClient\Model\EmployeeResponse

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\EmployeesApi(
    // 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
$update_employee_request = new \OmsorgCoreClient\Model\UpdateEmployeeRequest(); // \OmsorgCoreClient\Model\UpdateEmployeeRequest

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

Parameters

Name	Type	Description	Notes
id	string
update_employee_request	\OmsorgCoreClient\Model\UpdateEmployeeRequest		[optional]

Return type

\OmsorgCoreClient\Model\EmployeeResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: text/plain, application/json, text/json

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

apiEmployeesPost()

apiEmployeesPost($create_employee_request): \OmsorgCoreClient\Model\EmployeeResponse

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\EmployeesApi(
    // 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
);
$create_employee_request = new \OmsorgCoreClient\Model\CreateEmployeeRequest(); // \OmsorgCoreClient\Model\CreateEmployeeRequest

try {
    $result = $apiInstance->apiEmployeesPost($create_employee_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployeesApi->apiEmployeesPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
create_employee_request	\OmsorgCoreClient\Model\CreateEmployeeRequest		[optional]

Return type

\OmsorgCoreClient\Model\EmployeeResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: text/plain, application/json, text/json

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