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

OmsorgCoreClient\ContractsApi

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

Method	HTTP request	Description
apiContractsGet()	GET /api/contracts
apiContractsIdDelete()	DELETE /api/contracts/{id}
apiContractsIdGet()	GET /api/contracts/{id}
apiContractsIdPut()	PUT /api/contracts/{id}
apiContractsPost()	POST /api/contracts

apiContractsGet()

apiContractsGet($search, $status, $employee_id, $facility_id, $page, $page_size): \OmsorgCoreClient\Model\ContractResponsePagedResponse

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\ContractsApi(
    // 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
$employee_id = 'employee_id_example'; // string
$facility_id = 'facility_id_example'; // string
$page = 1; // int
$page_size = 20; // int

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

Parameters

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

Return type

\OmsorgCoreClient\Model\ContractResponsePagedResponse

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]

apiContractsIdDelete()

apiContractsIdDelete($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\ContractsApi(
    // 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->apiContractsIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->apiContractsIdDelete: ', $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]

apiContractsIdGet()

apiContractsIdGet($id): \OmsorgCoreClient\Model\ContractResponse

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\ContractsApi(
    // 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->apiContractsIdGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->apiContractsIdGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string

Return type

\OmsorgCoreClient\Model\ContractResponse

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]

apiContractsIdPut()

apiContractsIdPut($id, $update_contract_request): \OmsorgCoreClient\Model\ContractResponse

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\ContractsApi(
    // 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_contract_request = new \OmsorgCoreClient\Model\UpdateContractRequest(); // \OmsorgCoreClient\Model\UpdateContractRequest

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

Parameters

Name	Type	Description	Notes
id	string
update_contract_request	\OmsorgCoreClient\Model\UpdateContractRequest		[optional]

Return type

\OmsorgCoreClient\Model\ContractResponse

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]

apiContractsPost()

apiContractsPost($create_contract_request): \OmsorgCoreClient\Model\ContractResponse

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\ContractsApi(
    // 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_contract_request = new \OmsorgCoreClient\Model\CreateContractRequest(); // \OmsorgCoreClient\Model\CreateContractRequest

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

Parameters

Name	Type	Description	Notes
create_contract_request	\OmsorgCoreClient\Model\CreateContractRequest		[optional]

Return type

\OmsorgCoreClient\Model\ContractResponse

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]