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

OmsorgCoreClient\RolesApi

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

Method	HTTP request	Description
apiRolesGet()	GET /api/roles
apiRolesIdDelete()	DELETE /api/roles/{id}
apiRolesIdGet()	GET /api/roles/{id}
apiRolesIdPermissionsPut()	PUT /api/roles/{id}/permissions
apiRolesPost()	POST /api/roles

apiRolesGet()

apiRolesGet(): \OmsorgCoreClient\Model\RoleResponse[]

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

Parameters

This endpoint does not need any parameter.

Return type

\OmsorgCoreClient\Model\RoleResponse[]

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]

apiRolesIdDelete()

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

apiRolesIdGet()

apiRolesIdGet($id): \OmsorgCoreClient\Model\RolePermissionsResponse

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

Parameters

Name	Type	Description	Notes
id	string

Return type

\OmsorgCoreClient\Model\RolePermissionsResponse

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]

apiRolesIdPermissionsPut()

apiRolesIdPermissionsPut($id, $update_role_permissions_request)

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\RolesApi(
    // 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_role_permissions_request = new \OmsorgCoreClient\Model\UpdateRolePermissionsRequest(); // \OmsorgCoreClient\Model\UpdateRolePermissionsRequest

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

Parameters

Name	Type	Description	Notes
id	string
update_role_permissions_request	\OmsorgCoreClient\Model\UpdateRolePermissionsRequest		[optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

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

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

apiRolesPost()

apiRolesPost($create_role_request): \OmsorgCoreClient\Model\RoleResponse

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\RolesApi(
    // 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_role_request = new \OmsorgCoreClient\Model\CreateRoleRequest(); // \OmsorgCoreClient\Model\CreateRoleRequest

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

Parameters

Name	Type	Description	Notes
create_role_request	\OmsorgCoreClient\Model\CreateRoleRequest		[optional]

Return type

\OmsorgCoreClient\Model\RoleResponse

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]