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

OmsorgCoreClient\DocumentsApi

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

Method	HTTP request	Description
apiDocumentsGet()	GET /api/documents
apiDocumentsIdDelete()	DELETE /api/documents/{id}
apiDocumentsIdDownloadGet()	GET /api/documents/{id}/download
apiDocumentsIdPut()	PUT /api/documents/{id}
apiDocumentsPost()	POST /api/documents

apiDocumentsGet()

apiDocumentsGet($entity_type, $entity_id): \OmsorgCoreClient\Model\DocumentResponse[]

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\DocumentsApi(
    // 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
);
$entity_type = 'entity_type_example'; // string
$entity_id = 'entity_id_example'; // string

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

Parameters

Name	Type	Description	Notes
entity_type	string		[optional]
entity_id	string		[optional]

Return type

\OmsorgCoreClient\Model\DocumentResponse[]

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]

apiDocumentsIdDelete()

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

apiDocumentsIdDownloadGet()

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

apiDocumentsIdPut()

apiDocumentsIdPut($id, $update_document_request): \OmsorgCoreClient\Model\DocumentResponse

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\DocumentsApi(
    // 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_document_request = new \OmsorgCoreClient\Model\UpdateDocumentRequest(); // \OmsorgCoreClient\Model\UpdateDocumentRequest

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

Parameters

Name	Type	Description	Notes
id	string
update_document_request	\OmsorgCoreClient\Model\UpdateDocumentRequest		[optional]

Return type

\OmsorgCoreClient\Model\DocumentResponse

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]

apiDocumentsPost()

apiDocumentsPost($entity_type, $entity_id, $category, $description, $file): \OmsorgCoreClient\Model\DocumentResponse

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\DocumentsApi(
    // 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
);
$entity_type = 'entity_type_example'; // string
$entity_id = 'entity_id_example'; // string
$category = 'category_example'; // string
$description = 'description_example'; // string
$file = '/path/to/file.txt'; // \SplFileObject

try {
    $result = $apiInstance->apiDocumentsPost($entity_type, $entity_id, $category, $description, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->apiDocumentsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
entity_type	string		[optional]
entity_id	string		[optional]
category	string		[optional]
description	string		[optional]
file	\SplFileObject**\SplFileObject**		[optional]

Return type

\OmsorgCoreClient\Model\DocumentResponse

Authorization

Bearer

HTTP request headers

• Content-Type: multipart/form-data
• Accept: text/plain, application/json, text/json

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