Skip to content

Latest commit

 

History

History
78 lines (55 loc) · 3.19 KB

DocumentApi.md

File metadata and controls

78 lines (55 loc) · 3.19 KB
Raw

Itsmind\Sevdesk\DocumentApi

All URIs are relative to https://my.sevdesk.de/api/v1, except if the operation defines another base path.

Method HTTP request Description
getDocuments() GET /Document Retrieve documents

getDocuments()

getDocuments($contact, $count_all, $offset, $limit, $embed): \Itsmind\Sevdesk\Model\GetDocuments200Response

Retrieve documents

There are a multitude of parameter which can be used to filter.
A few of them are attached but for a complete list please check out this list

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\DocumentApi(
    // 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
);
$contact = new \Itsmind\Sevdesk\Model\GetDocumentsContactParameter(); // GetDocumentsContactParameter | Retrieve all documents for this contact. The value of contact[objectName] must be 'Contact'.
$count_all = True; // bool | If all documents should be counted
$offset = 56; // int | Which offset to start with
$limit = 56; // int | The max number of objects to return
$embed = array('embed_example'); // string[] | Get some additional information. Embed can handle multiple values, they must be separated by comma.

try {
    $result = $apiInstance->getDocuments($contact, $count_all, $offset, $limit, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->getDocuments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
contact GetDocumentsContactParameter Retrieve all documents for this contact. The value of contact[objectName] must be 'Contact'. [optional]
count_all bool If all documents should be counted [optional]
offset int Which offset to start with [optional]
limit int The max number of objects to return [optional]
embed string[] Get some additional information. Embed can handle multiple values, they must be separated by comma. [optional]

Return type

\Itsmind\Sevdesk\Model\GetDocuments200Response

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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