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\AdminEmailApi(
    // 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
);

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

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
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	apiContractsIdGet	GET /api/contracts/{id}
ContractsApi	apiContractsIdPut	PUT /api/contracts/{id}
ContractsApi	apiContractsPost	POST /api/contracts
EmployeesApi	apiEmployeesGet	GET /api/employees
EmployeesApi	apiEmployeesIdGet	GET /api/employees/{id}
EmployeesApi	apiEmployeesIdPut	PUT /api/employees/{id}
EmployeesApi	apiEmployeesPost	POST /api/employees
FacilitiesApi	apiFacilitiesGet	GET /api/facilities
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	apiFacilitiesFacilityIdContactsIdPut	PUT /api/facilities/{facilityId}/contacts/{id}
FacilityContactsApi	apiFacilitiesFacilityIdContactsPost	POST /api/facilities/{facilityId}/contacts
HealthApi	apiHealthGet	GET /api/health
OrdersApi	apiOrdersGet	GET /api/orders
OrdersApi	apiOrdersIdGet	GET /api/orders/{id}
OrdersApi	apiOrdersIdPut	PUT /api/orders/{id}
OrdersApi	apiOrdersPost	POST /api/orders
RolesApi	apiRolesGet	GET /api/roles
RolesApi	apiRolesIdGet	GET /api/roles/{id}
RolesApi	apiRolesIdPermissionsPut	PUT /api/roles/{id}/permissions
RolesApi	apiRolesPost	POST /api/roles
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

• AddUserPermissionOverrideRequest
• AuditLogEntryResponse
• AuditLogEntryResponsePagedResponse
• ChangePasswordRequest
• ContractResponse
• ContractResponsePagedResponse
• CreateContractRequest
• CreateEmployeeRequest
• CreateFacilityContactRequest
• CreateFacilityRequest
• CreateOrderRequest
• CreateRoleRequest
• CreateUserRequest
• CreateValueListItemRequest
• EmployeeResponse
• EmployeeResponsePagedResponse
• FacilityContactResponse
• FacilityResponse
• FacilityResponsePagedResponse
• ForgotPasswordRequestRequest
• ForgotPasswordRequestResponse
• ForgotPasswordResetRequest
• ForgotPasswordVerifyRequest
• ForgotPasswordVerifyResponse
• LoginRequest
• LoginResponse
• LogoutRequest
• MeResponse
• OrderResponse
• OrderResponsePagedResponse
• PasswordPolicyResponse
• PasswordResetTemplateResponse
• PermissionDto
• RefreshRequest
• ResetUserPasswordRequest
• RolePermissionsResponse
• RoleResponse
• SendTestEmailRequest
• SessionResponse
• UpdateContractRequest
• UpdateEmployeeRequest
• UpdateFacilityContactRequest
• UpdateFacilityRequest
• UpdateOrderRequest
• UpdateRolePermissionsRequest
• 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