Equisoft\SDK\EquisoftConnect\LegacyDocumentApi

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

Method	HTTP request	Description
legacyDocumentAddDocument()	POST /apps/api/kronos.document.add	Create a new document.
legacyDocumentDeleteDocument()	POST /apps/api/kronos.document.delete	Delete a document and it's related files.
legacyDocumentDeleteDocumentFile()	POST /apps/api/kronos.document.deleteFile	Delete one file from a document.
legacyDocumentDownloadDocumentFile()	GET /apps/api/kronos.document.downloadFile	Download a file. File data is encoded in base64.
legacyDocumentGetDocument()	GET /apps/api/kronos.document.get	Get all data for a document record.
legacyDocumentGetDocumentList()	GET /apps/api/kronos.document.getList	Get a list of all documents.
legacyDocumentUpdateDocument()	POST /apps/api/kronos.document.update	Update a document.
legacyDocumentUploadDocumentFile()	POST /apps/api/kronos.document.uploadFile	Upload a new file in a document.

`legacyDocumentAddDocument()`

legacyDocumentAddDocument($legacyDocumentDocumentPayloadRequest): \Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateResponse

Create a new document.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyDocumentApi(
    // 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
);
$legacyDocumentDocumentPayloadRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentDocumentPayloadRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentDocumentPayloadRequest

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

Parameters

Name	Type	Description	Notes
legacyDocumentDocumentPayloadRequest	\Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentDocumentPayloadRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateResponse

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`legacyDocumentDeleteDocument()`

legacyDocumentDeleteDocument($id): \Equisoft\SDK\EquisoftConnect\Model\LegacyResponse

Delete a document and it's related files.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyDocumentApi(
    // 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 | Document identifier.

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

Parameters

Name	Type	Description	Notes
id	string	Document identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`legacyDocumentDeleteDocumentFile()`

legacyDocumentDeleteDocumentFile($id): \Equisoft\SDK\EquisoftConnect\Model\LegacyResponse

Delete one file from a document.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyDocumentApi(
    // 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 | Document file identifier.

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

Parameters

Name	Type	Description	Notes
id	string	Document file identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`legacyDocumentDownloadDocumentFile()`

legacyDocumentDownloadDocumentFile($id): \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentDownloadFileResponse

Download a file. File data is encoded in base64.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyDocumentApi(
    // 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 | Document file identifier.

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

Parameters

Name	Type	Description	Notes
id	string	Document file identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentDownloadFileResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`legacyDocumentGetDocument()`

legacyDocumentGetDocument($id): \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentGetResponse

Get all data for a document record.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyDocumentApi(
    // 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 | Document identifier.

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

Parameters

Name	Type	Description	Notes
id	string	Document identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentGetResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`legacyDocumentGetDocumentList()`

legacyDocumentGetDocumentList($lastModifiedTime, $optionsPayload): \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentGetListResponse

Get a list of all documents.

This will return basic information about the document. Please note that a document is similar to a folder and may contain one or many files.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyDocumentApi(
    // 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
);
$lastModifiedTime = 'lastModifiedTime_example'; // string | To Fetch all documents, which got modified / created after specified date. If the value \"auto\" is used, the last access date to this method will be used. Set the value to \"reset\" to reset the last access date.
$optionsPayload = new \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentGetListOptions(); // LegacyDocumentGetListOptions | Object containing the options to filter the list of documents.

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

Parameters

Name	Type	Description	Notes
lastModifiedTime	string	To Fetch all documents, which got modified / created after specified date. If the value "auto" is used, the last access date to this method will be used. Set the value to "reset" to reset the last access date.	[optional]
optionsPayload	LegacyDocumentGetListOptions	Object containing the options to filter the list of documents.	[optional]

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentGetListResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`legacyDocumentUpdateDocument()`

legacyDocumentUpdateDocument($legacyDocumentDocumentPayloadRequest): \Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateResponse

Update a document.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyDocumentApi(
    // 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
);
$legacyDocumentDocumentPayloadRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentDocumentPayloadRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentDocumentPayloadRequest

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

Parameters

Name	Type	Description	Notes
legacyDocumentDocumentPayloadRequest	\Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentDocumentPayloadRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateResponse

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`legacyDocumentUploadDocumentFile()`

legacyDocumentUploadDocumentFile($id, $legacyDocumentUploadDocumentFileRequest): \Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateResponse

Upload a new file in a document.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyDocumentApi(
    // 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 | Document identifier.
$legacyDocumentUploadDocumentFileRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentUploadDocumentFileRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentUploadDocumentFileRequest

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

Parameters

Name	Type	Description	Notes
id	string	Document identifier.
legacyDocumentUploadDocumentFileRequest	\Equisoft\SDK\EquisoftConnect\Model\LegacyDocumentUploadDocumentFileRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateResponse

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

LegacyDocumentApi.md

Latest commit

History

LegacyDocumentApi.md

File metadata and controls

Equisoft\SDK\EquisoftConnect\LegacyDocumentApi

legacyDocumentAddDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyDocumentDeleteDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyDocumentDeleteDocumentFile()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyDocumentDownloadDocumentFile()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyDocumentGetDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyDocumentGetDocumentList()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyDocumentUpdateDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyDocumentUploadDocumentFile()

Example

Parameters

Return type

Authorization

HTTP request headers

`legacyDocumentAddDocument()`

`legacyDocumentDeleteDocument()`

`legacyDocumentDeleteDocumentFile()`

`legacyDocumentDownloadDocumentFile()`

`legacyDocumentGetDocument()`

`legacyDocumentGetDocumentList()`

`legacyDocumentUpdateDocument()`

`legacyDocumentUploadDocumentFile()`