omsorg/omsorgWeb/mitarbeiter-app/api-client-php

omsorgcore-client-php

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/omsorgcore-client-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



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


$apiInstance = new OmsorgCoreClient\Api\AbsencesApi(
    // 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
);
$status = 'status_example'; // string
$type = 'type_example'; // string
$employee_id = 'employee_id_example'; // string
$page = 1; // int
$page_size = 20; // int

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

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AbsencesApi	apiAbsencesGet	GET /api/absences
AbsencesApi	apiAbsencesIdDecisionPost	POST /api/absences/{id}/decision
AbsencesApi	apiAbsencesIdDelete	DELETE /api/absences/{id}
AbsencesApi	apiAbsencesIdGet	GET /api/absences/{id}
AbsencesApi	apiAbsencesIdPut	PUT /api/absences/{id}
AbsencesApi	apiAbsencesPost	POST /api/absences
AdminEmailApi	apiAdminEmailPasswordResetTemplateGet	GET /api/admin/email/password-reset-template
AdminEmailApi	apiAdminEmailTestSendPost	POST /api/admin/email/test-send
AdminSessionsApi	apiAdminSessionsGet	GET /api/admin/sessions
AdminSessionsApi	apiAdminSessionsIdRevokePost	POST /api/admin/sessions/{id}/revoke
AdminSessionsApi	apiAdminSessionsRevokeAllPost	POST /api/admin/sessions/revoke-all
AuditLogApi	apiAuditLogGet	GET /api/audit-log
AuthApi	apiAuthChangePasswordPost	POST /api/auth/change-password
AuthApi	apiAuthForgotPasswordRequestPost	POST /api/auth/forgot-password/request
AuthApi	apiAuthForgotPasswordResetPost	POST /api/auth/forgot-password/reset
AuthApi	apiAuthForgotPasswordVerifyPost	POST /api/auth/forgot-password/verify
AuthApi	apiAuthLoginPost	POST /api/auth/login
AuthApi	apiAuthLogoutPost	POST /api/auth/logout
AuthApi	apiAuthMeGet	GET /api/auth/me
AuthApi	apiAuthPasswordPolicyGet	GET /api/auth/password-policy
AuthApi	apiAuthRefreshPost	POST /api/auth/refresh
ContractsApi	apiContractsGet	GET /api/contracts
ContractsApi	apiContractsIdDelete	DELETE /api/contracts/{id}
ContractsApi	apiContractsIdGet	GET /api/contracts/{id}
ContractsApi	apiContractsIdPut	PUT /api/contracts/{id}
ContractsApi	apiContractsPost	POST /api/contracts
DocumentsApi	apiDocumentsGet	GET /api/documents
DocumentsApi	apiDocumentsIdDelete	DELETE /api/documents/{id}
DocumentsApi	apiDocumentsIdDownloadGet	GET /api/documents/{id}/download
DocumentsApi	apiDocumentsIdPut	PUT /api/documents/{id}
DocumentsApi	apiDocumentsPost	POST /api/documents
EmployeeFacilityDistancesApi	apiFacilitiesFacilityIdEmployeeDistancesGet	GET /api/facilities/{facilityId}/employee-distances
EmployeeFacilityDistancesApi	apiFacilitiesFacilityIdEmployeeDistancesIdDelete	DELETE /api/facilities/{facilityId}/employee-distances/{id}
EmployeeFacilityDistancesApi	apiFacilitiesFacilityIdEmployeeDistancesIdPut	PUT /api/facilities/{facilityId}/employee-distances/{id}
EmployeeFacilityDistancesApi	apiFacilitiesFacilityIdEmployeeDistancesPost	POST /api/facilities/{facilityId}/employee-distances
EmployeesApi	apiEmployeesGet	GET /api/employees
EmployeesApi	apiEmployeesIdDelete	DELETE /api/employees/{id}
EmployeesApi	apiEmployeesIdGet	GET /api/employees/{id}
EmployeesApi	apiEmployeesIdPut	PUT /api/employees/{id}
EmployeesApi	apiEmployeesPost	POST /api/employees
FacilitiesApi	apiFacilitiesGet	GET /api/facilities
FacilitiesApi	apiFacilitiesIdDelete	DELETE /api/facilities/{id}
FacilitiesApi	apiFacilitiesIdGet	GET /api/facilities/{id}
FacilitiesApi	apiFacilitiesIdPut	PUT /api/facilities/{id}
FacilitiesApi	apiFacilitiesPost	POST /api/facilities
FacilityContactsApi	apiFacilitiesFacilityIdContactsGet	GET /api/facilities/{facilityId}/contacts
FacilityContactsApi	apiFacilitiesFacilityIdContactsIdDelete	DELETE /api/facilities/{facilityId}/contacts/{id}
FacilityContactsApi	apiFacilitiesFacilityIdContactsIdPut	PUT /api/facilities/{facilityId}/contacts/{id}
FacilityContactsApi	apiFacilitiesFacilityIdContactsPost	POST /api/facilities/{facilityId}/contacts
FacilityQualificationRatesApi	apiFacilitiesFacilityIdQualificationRatesGet	GET /api/facilities/{facilityId}/qualification-rates
FacilityQualificationRatesApi	apiFacilitiesFacilityIdQualificationRatesIdDelete	DELETE /api/facilities/{facilityId}/qualification-rates/{id}
FacilityQualificationRatesApi	apiFacilitiesFacilityIdQualificationRatesIdPut	PUT /api/facilities/{facilityId}/qualification-rates/{id}
FacilityQualificationRatesApi	apiFacilitiesFacilityIdQualificationRatesPost	POST /api/facilities/{facilityId}/qualification-rates
HealthApi	apiHealthGet	GET /api/health
MyFacilityDistancesApi	apiMeFacilityDistancesFacilitiesGet	GET /api/me/facility-distances/facilities
MyFacilityDistancesApi	apiMeFacilityDistancesGet	GET /api/me/facility-distances
MyFacilityDistancesApi	apiMeFacilityDistancesIdPut	PUT /api/me/facility-distances/{id}
MyFacilityDistancesApi	apiMeFacilityDistancesPost	POST /api/me/facility-distances
OrdersApi	apiOrdersGet	GET /api/orders
OrdersApi	apiOrdersIdDelete	DELETE /api/orders/{id}
OrdersApi	apiOrdersIdGet	GET /api/orders/{id}
OrdersApi	apiOrdersIdPut	PUT /api/orders/{id}
OrdersApi	apiOrdersPost	POST /api/orders
RolesApi	apiRolesGet	GET /api/roles
RolesApi	apiRolesIdDelete	DELETE /api/roles/{id}
RolesApi	apiRolesIdGet	GET /api/roles/{id}
RolesApi	apiRolesIdPermissionsPut	PUT /api/roles/{id}/permissions
RolesApi	apiRolesPost	POST /api/roles
TimeEntriesApi	apiTimeEntriesGet	GET /api/time-entries
TimeEntriesApi	apiTimeEntriesIdDecisionPost	POST /api/time-entries/{id}/decision
TimeEntriesApi	apiTimeEntriesIdDelete	DELETE /api/time-entries/{id}
TimeEntriesApi	apiTimeEntriesIdGet	GET /api/time-entries/{id}
TimeEntriesApi	apiTimeEntriesIdPut	PUT /api/time-entries/{id}
TimeEntriesApi	apiTimeEntriesIdSubmitPost	POST /api/time-entries/{id}/submit
TimeEntriesApi	apiTimeEntriesPost	POST /api/time-entries
TrashApi	apiTrashAbsencesGet	GET /api/trash/absences
TrashApi	apiTrashAbsencesIdRestorePost	POST /api/trash/absences/{id}/restore
TrashApi	apiTrashContractsGet	GET /api/trash/contracts
TrashApi	apiTrashContractsIdRestorePost	POST /api/trash/contracts/{id}/restore
TrashApi	apiTrashEmployeeFacilityDistancesGet	GET /api/trash/employee-facility-distances
TrashApi	apiTrashEmployeeFacilityDistancesIdRestorePost	POST /api/trash/employee-facility-distances/{id}/restore
TrashApi	apiTrashEmployeesGet	GET /api/trash/employees
TrashApi	apiTrashEmployeesIdRestorePost	POST /api/trash/employees/{id}/restore
TrashApi	apiTrashFacilitiesGet	GET /api/trash/facilities
TrashApi	apiTrashFacilitiesIdRestorePost	POST /api/trash/facilities/{id}/restore
TrashApi	apiTrashFacilityContactsGet	GET /api/trash/facility-contacts
TrashApi	apiTrashFacilityContactsIdRestorePost	POST /api/trash/facility-contacts/{id}/restore
TrashApi	apiTrashFacilityQualificationRatesGet	GET /api/trash/facility-qualification-rates
TrashApi	apiTrashFacilityQualificationRatesIdRestorePost	POST /api/trash/facility-qualification-rates/{id}/restore
TrashApi	apiTrashOrdersGet	GET /api/trash/orders
TrashApi	apiTrashOrdersIdRestorePost	POST /api/trash/orders/{id}/restore
TrashApi	apiTrashTimeEntriesGet	GET /api/trash/time-entries
TrashApi	apiTrashTimeEntriesIdRestorePost	POST /api/trash/time-entries/{id}/restore
UsersApi	apiUsersGet	GET /api/users
UsersApi	apiUsersIdPermissionOverridesGet	GET /api/users/{id}/permission-overrides
UsersApi	apiUsersIdPermissionOverridesOverrideIdDelete	DELETE /api/users/{id}/permission-overrides/{overrideId}
UsersApi	apiUsersIdPermissionOverridesPost	POST /api/users/{id}/permission-overrides
UsersApi	apiUsersIdPut	PUT /api/users/{id}
UsersApi	apiUsersIdResetPasswordPost	POST /api/users/{id}/reset-password
UsersApi	apiUsersPost	POST /api/users
ValueListsApi	apiValueListsGet	GET /api/value-lists
ValueListsApi	apiValueListsKeyItemsGet	GET /api/value-lists/{key}/items
ValueListsApi	apiValueListsKeyItemsIdDelete	DELETE /api/value-lists/{key}/items/{id}
ValueListsApi	apiValueListsKeyItemsIdPut	PUT /api/value-lists/{key}/items/{id}
ValueListsApi	apiValueListsKeyItemsIdUsagesGet	GET /api/value-lists/{key}/items/{id}/usages
ValueListsApi	apiValueListsKeyItemsPost	POST /api/value-lists/{key}/items
ValueListsApi	apiValueListsKeyTransitionsGet	GET /api/value-lists/{key}/transitions
ValueListsApi	apiValueListsKeyTransitionsPut	PUT /api/value-lists/{key}/transitions

Models

• AbsenceDecisionRequest
• AbsenceResponse
• AbsenceResponsePagedResponse
• AddUserPermissionOverrideRequest
• AuditEventCategory
• AuditLogEntryResponse
• AuditLogEntryResponsePagedResponse
• ChangePasswordRequest
• ContractResponse
• ContractResponsePagedResponse
• CreateAbsenceRequest
• CreateContractRequest
• CreateEmployeeFacilityDistanceRequest
• CreateEmployeeRequest
• CreateFacilityContactRequest
• CreateFacilityQualificationRateRequest
• CreateFacilityRequest
• CreateMyFacilityDistanceRequest
• CreateOrderRequest
• CreateRoleRequest
• CreateTimeEntryRequest
• CreateUserRequest
• CreateValueListItemRequest
• DocumentResponse
• EmployeeFacilityDistanceResponse
• EmployeeResponse
• EmployeeResponsePagedResponse
• FacilityContactResponse
• FacilityOptionResponse
• FacilityQualificationRateResponse
• FacilityResponse
• FacilityResponsePagedResponse
• ForgotPasswordRequestRequest
• ForgotPasswordRequestResponse
• ForgotPasswordResetRequest
• ForgotPasswordVerifyRequest
• ForgotPasswordVerifyResponse
• LoginRequest
• LoginResponse
• LogoutRequest
• MeResponse
• ModuleType
• MyFacilityDistanceResponse
• OrderResponse
• OrderResponsePagedResponse
• PasswordPolicyResponse
• PasswordResetTemplateResponse
• PermissionAction
• PermissionDto
• PermissionEffect
• PermissionScope
• RefreshRequest
• ResetUserPasswordRequest
• RolePermissionsResponse
• RoleResponse
• SendTestEmailRequest
• SessionResponse
• TimeEntryDecisionRequest
• TimeEntryResponse
• TimeEntryResponsePagedResponse
• TrashAbsenceResponse
• TrashContractResponse
• TrashEmployeeFacilityDistanceResponse
• TrashEmployeeResponse
• TrashFacilityContactResponse
• TrashFacilityQualificationRateResponse
• TrashFacilityResponse
• TrashOrderResponse
• TrashTimeEntryResponse
• UpdateAbsenceRequest
• UpdateContractRequest
• UpdateDocumentRequest
• UpdateEmployeeFacilityDistanceRequest
• UpdateEmployeeRequest
• UpdateFacilityContactRequest
• UpdateFacilityQualificationRateRequest
• UpdateFacilityRequest
• UpdateMyFacilityDistanceRequest
• UpdateOrderRequest
• UpdateRolePermissionsRequest
• UpdateTimeEntryRequest
• UpdateUserRequest
• UpdateValueListItemRequest
• UserPermissionOverrideResponse
• UserResponse
• ValueListItemResponse
• ValueListResponse
• ValueListTransitionRequest
• ValueListTransitionResponse
• ValueListUsageResponse

Authorization

Authentication schemes defined for the API:

Bearer

• Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0
  • Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen