Skip to content

Latest commit

 

History

History
341 lines (238 loc) · 12.9 KB

DraftDocumentsApi.md

File metadata and controls

341 lines (238 loc) · 12.9 KB

MagDv\Cargomart\DraftDocumentsApi

All URIs are relative to https://cargomart.ru.

Method HTTP request Description
createDraftDocument() POST /api/v2/draft-document Создание черновика документа.
deleteDraftDocumentById() DELETE /api/v2/draft-document/{id} Удаление черновика документа.
getDraftDocumentById() GET /api/v2/draft-document/{id} Получение черновика документа.
getDraftDocumentPdfById() GET /api/v2/draft-document/{id}/pdf Получение печатной формы черновика в формате PDF.
updateDraftDocumentById() PUT /api/v2/draft-document/{id} Замена данных черновика документа.

createDraftDocument()

createDraftDocument($draft_document_request): \MagDv\Cargomart\Dto\DraftDocumentResponse

Создание черновика документа.

Example

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


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

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


$apiInstance = new MagDv\Cargomart\Api\DraftDocumentsApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$draft_document_request = new \MagDv\Cargomart\Dto\DraftDocumentRequest(); // \MagDv\Cargomart\Dto\DraftDocumentRequest

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

Parameters

Name Type Description Notes
draft_document_request \MagDv\Cargomart\Dto\DraftDocumentRequest [optional]

Return type

\MagDv\Cargomart\Dto\DraftDocumentResponse

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

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

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

deleteDraftDocumentById()

deleteDraftDocumentById($id): \MagDv\Cargomart\Dto\EmptyDataResponse

Удаление черновика документа.

Example

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


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

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


$apiInstance = new MagDv\Cargomart\Api\DraftDocumentsApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | Идентификатор черновика документа.

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

Parameters

Name Type Description Notes
id string Идентификатор черновика документа.

Return type

\MagDv\Cargomart\Dto\EmptyDataResponse

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

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

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

getDraftDocumentById()

getDraftDocumentById($id): \MagDv\Cargomart\Dto\DraftDocumentResponse

Получение черновика документа.

Example

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


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

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


$apiInstance = new MagDv\Cargomart\Api\DraftDocumentsApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | Идентификатор черновика документа.

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

Parameters

Name Type Description Notes
id string Идентификатор черновика документа.

Return type

\MagDv\Cargomart\Dto\DraftDocumentResponse

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

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

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

getDraftDocumentPdfById()

getDraftDocumentPdfById($id, $preview): \SplFileObject

Получение печатной формы черновика в формате PDF.

Example

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


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

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


$apiInstance = new MagDv\Cargomart\Api\DraftDocumentsApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | Идентификатор черновика документа.
$preview = 56; // int | Флаг инлайн-просмотра (против скачивания).

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

Parameters

Name Type Description Notes
id string Идентификатор черновика документа.
preview int Флаг инлайн-просмотра (против скачивания). [optional]

Return type

\SplFileObject

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

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

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

updateDraftDocumentById()

updateDraftDocumentById($id, $draft_document_request): \MagDv\Cargomart\Dto\DraftDocumentResponse

Замена данных черновика документа.

Example

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


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

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


$apiInstance = new MagDv\Cargomart\Api\DraftDocumentsApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | Идентификатор черновика документа.
$draft_document_request = new \MagDv\Cargomart\Dto\DraftDocumentRequest(); // \MagDv\Cargomart\Dto\DraftDocumentRequest

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

Parameters

Name Type Description Notes
id string Идентификатор черновика документа.
draft_document_request \MagDv\Cargomart\Dto\DraftDocumentRequest [optional]

Return type

\MagDv\Cargomart\Dto\DraftDocumentResponse

Authorization

CookieTokenAuth, HeaderAuthorizationAuth

HTTP request headers

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

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