Files
omsorg/omsorgWeb/mitarbeiter-app/api-client-php/docs/Api/FacilitiesApi.md
T
Felix KemmlerandClaude Sonnet 5 e9e96a57dc Add facilities, contracts, orders, value lists, audit log, and desktop app modules
Extends omsorgCore with full CRUD for Facility/Contract/Order plus
configurable value lists and an audit trail, and wires the omsorgapp
frontend up to the new facilities, settings, and audit-log modules;
includes a sidebar active-nav-item highlight.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-08-08 23:29:16 +02:00

7.2 KiB

OmsorgCoreClient\FacilitiesApi

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

Method HTTP request Description
apiFacilitiesGet() GET /api/facilities
apiFacilitiesIdGet() GET /api/facilities/{id}
apiFacilitiesIdPut() PUT /api/facilities/{id}
apiFacilitiesPost() POST /api/facilities

apiFacilitiesGet()

apiFacilitiesGet($search, $crm_status, $page, $page_size): \OmsorgCoreClient\Model\FacilityResponsePagedResponse

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\FacilitiesApi(
    // 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
$crm_status = 'crm_status_example'; // string
$page = 1; // int
$page_size = 20; // int

try {
    $result = $apiInstance->apiFacilitiesGet($search, $crm_status, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FacilitiesApi->apiFacilitiesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\OmsorgCoreClient\Model\FacilityResponsePagedResponse

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]

apiFacilitiesIdGet()

apiFacilitiesIdGet($id): \OmsorgCoreClient\Model\FacilityResponse

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

Parameters

Name Type Description Notes
id string

Return type

\OmsorgCoreClient\Model\FacilityResponse

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]

apiFacilitiesIdPut()

apiFacilitiesIdPut($id, $update_facility_request): \OmsorgCoreClient\Model\FacilityResponse

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\FacilitiesApi(
    // 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_facility_request = new \OmsorgCoreClient\Model\UpdateFacilityRequest(); // \OmsorgCoreClient\Model\UpdateFacilityRequest

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

Parameters

Name Type Description Notes
id string
update_facility_request \OmsorgCoreClient\Model\UpdateFacilityRequest [optional]

Return type

\OmsorgCoreClient\Model\FacilityResponse

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]

apiFacilitiesPost()

apiFacilitiesPost($create_facility_request): \OmsorgCoreClient\Model\FacilityResponse

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\FacilitiesApi(
    // 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_facility_request = new \OmsorgCoreClient\Model\CreateFacilityRequest(); // \OmsorgCoreClient\Model\CreateFacilityRequest

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

Parameters

Name Type Description Notes
create_facility_request \OmsorgCoreClient\Model\CreateFacilityRequest [optional]

Return type

\OmsorgCoreClient\Model\FacilityResponse

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]