Swagger\Client\ValidateDocumentApi

All URIs are relative to https://api.cloudmersive.com

Method	HTTP request	Description
validateDocumentAutodetectValidation	POST /convert/validate/autodetect	Autodetect content type and validate
validateDocumentCsvValidation	POST /convert/validate/csv	Validate a CSV file document (CSV)
validateDocumentDocValidation	POST /convert/validate/doc	Validate a Word 97-2003 Legacy document (DOC)
validateDocumentDocxRepair	POST /convert/validate/docx/repair	Repair a Word document (DOCX) that contains errors
validateDocumentDocxValidation	POST /convert/validate/docx	Validate a Word document (DOCX)
validateDocumentEmlValidation	POST /convert/validate/eml	Validate if input file is a valid EML file
validateDocumentExecutableValidation	POST /convert/validate/executable	Validate if a file is executable
validateDocumentGZipValidation	POST /convert/validate/gzip	Validate a GZip Archive file (gzip or gz)
validateDocumentHtmlSsrfValidation	POST /convert/validate/html/ssrf-threat-check	Validate an HTML file and checks for SSRF threats
validateDocumentHtmlValidation	POST /convert/validate/html	Validate an HTML file
validateDocumentImageValidation	POST /convert/validate/image	Validate an Image File
validateDocumentJpgValidation	POST /convert/validate/jpg	Validate a JPG File
validateDocumentJsonValidation	POST /convert/validate/json	Validate a JSON file
validateDocumentMsgValidation	POST /convert/validate/msg	Validate if input file is a valid MSG file
validateDocumentPdfValidation	POST /convert/validate/pdf	Validate a PDF document file
validateDocumentPngValidation	POST /convert/validate/png	Validate a PNG File
validateDocumentPptValidation	POST /convert/validate/ppt	Validate a PowerPoint 97-2003 Legacy presentation (PPT)
validateDocumentPptxRepair	POST /convert/validate/pptx/repair	Repair a PowerPoint presentation (PPTX) that contains errors
validateDocumentPptxValidation	POST /convert/validate/pptx	Validate a PowerPoint presentation (PPTX)
validateDocumentRarValidation	POST /convert/validate/rar	Validate a RAR Archive file (RAR)
validateDocumentRtfValidation	POST /convert/validate/rtf	Validate a Rich Text Format document (RTF)
validateDocumentTarValidation	POST /convert/validate/tar	Validate a TAR Tarball Archive file (TAR)
validateDocumentTxtValidation	POST /convert/validate/txt	Validate an TXT file
validateDocumentXlsValidation	POST /convert/validate/xls	Validate a Excel 97-2003 Legacy spreadsheet (XLS)
validateDocumentXlsxRepair	POST /convert/validate/xlsx/repair	Repair an Excel spreadsheet (XLSX) that contains errors
validateDocumentXlsxValidation	POST /convert/validate/xlsx	Validate a Excel document (XLSX)
validateDocumentXmlValidation	POST /convert/validate/xml	Validate an XML file
validateDocumentXmlXxeThreatValidation	POST /convert/validate/xml/xxe-threats	Validate an XML file for XML External Entity (XXE) threats
validateDocumentZipValidation	POST /convert/validate/zip	Validate a Zip Archive file (zip)

validateDocumentAutodetectValidation

\Swagger\Client\Model\AutodetectDocumentValidationResult validateDocumentAutodetectValidation($input_file)

Autodetect content type and validate

Automatically detect the type of content, verify and validate that the content is indeed fully valid at depth, and then report the validation result.

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentAutodetectValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentAutodetectValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\AutodetectDocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentCsvValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentCsvValidation($input_file)

Validate a CSV file document (CSV)

Validate a CSV file document (CSV); if the document is not valid, identifies the errors in the document

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentCsvValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentCsvValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentDocValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentDocValidation($input_file)

Validate a Word 97-2003 Legacy document (DOC)

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentDocValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentDocValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentDocxRepair

string validateDocumentDocxRepair($input_file, $repair_mode)

Repair a Word document (DOCX) that contains errors

Repair a Word document (DOCX) that contains errors or corruption, if possible.

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.
$repair_mode = "repair_mode_example"; // string | Optional; Set to advanced to apply the most advanced repair mode, basic for basic repair mode.  Default is advanced.

try {
    $result = $apiInstance->validateDocumentDocxRepair($input_file, $repair_mode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentDocxRepair: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.
repair_mode	string	Optional; Set to advanced to apply the most advanced repair mode, basic for basic repair mode. Default is advanced.	[optional]

Return type

string

Authorization

Apikey

HTTP request headers

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

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

validateDocumentDocxValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentDocxValidation($input_file)

Validate a Word document (DOCX)

Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentDocxValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentDocxValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentEmlValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentEmlValidation($input_file)

Validate if input file is a valid EML file

Validate if an input file is an EML email file; if the document is not valid

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentEmlValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentEmlValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentExecutableValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentExecutableValidation($input_file)

Validate if a file is executable

Validate if an input file is a binary executable file; if the document is not valid

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentExecutableValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentExecutableValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentGZipValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentGZipValidation($input_file)

Validate a GZip Archive file (gzip or gz)

Validate a GZip archive file (GZIP or GZ)

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentGZipValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentGZipValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentHtmlSsrfValidation

\Swagger\Client\Model\HtmlSsrfThreatCheckResult validateDocumentHtmlSsrfValidation($input_file)

Validate an HTML file and checks for SSRF threats

Validate an HTML document file and checks for SSRF (Server-side Request Forgery) threats in the file; if the document is not valid, identifies the errors in the document

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentHtmlSsrfValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentHtmlSsrfValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\HtmlSsrfThreatCheckResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentHtmlValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentHtmlValidation($input_file)

Validate an HTML file

Validate an HTML document file; if the document is not valid, identifies the errors in the document

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentHtmlValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentHtmlValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentImageValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentImageValidation($input_file)

Validate an Image File

Validate an image file; if the document is not valid, identifies the errors in the document. Formats supported include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentImageValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentImageValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentJpgValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentJpgValidation($input_file)

Validate a JPG File

Validate a JPEG image file; if the document is not valid, identifies the errors in the document..

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentJpgValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentJpgValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentJsonValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentJsonValidation($input_file)

Validate a JSON file

Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentJsonValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentJsonValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentMsgValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentMsgValidation($input_file)

Validate if input file is a valid MSG file

Validate if an input file is an MSG email file; if the document is not valid

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentMsgValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentMsgValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentPdfValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentPdfValidation($input_file)

Validate a PDF document file

Validate a PDF document; if the document is not valid, identifies the errors in the document. Also checks if the PDF is password protected.

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentPdfValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentPdfValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentPngValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentPngValidation($input_file)

Validate a PNG File

Validate a PNG image file; if the document is not valid, identifies the errors in the document.

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentPngValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentPngValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentPptValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentPptValidation($input_file)

Validate a PowerPoint 97-2003 Legacy presentation (PPT)

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentPptValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentPptValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentPptxRepair

string validateDocumentPptxRepair($input_file)

Repair a PowerPoint presentation (PPTX) that contains errors

Repair a PowerPoint presentation document (PPTX) that contains errors or corruption, if possible.

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentPptxRepair($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentPptxRepair: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

string

Authorization

Apikey

HTTP request headers

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

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

validateDocumentPptxValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentPptxValidation($input_file)

Validate a PowerPoint presentation (PPTX)

Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentPptxValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentPptxValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentRarValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentRarValidation($input_file)

Validate a RAR Archive file (RAR)

Validate a RAR archive file (RAR)

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentRarValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentRarValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentRtfValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentRtfValidation($input_file)

Validate a Rich Text Format document (RTF)

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentRtfValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentRtfValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentTarValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentTarValidation($input_file)

Validate a TAR Tarball Archive file (TAR)

Validate a TAR tarball archive file (TAR)

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentTarValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentTarValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentTxtValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentTxtValidation($input_file)

Validate an TXT file

Validate an TXT document file; if the document is not valid, identifies the errors in the document

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentTxtValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentTxtValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentXlsValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentXlsValidation($input_file)

Validate a Excel 97-2003 Legacy spreadsheet (XLS)

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentXlsValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentXlsValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentXlsxRepair

string validateDocumentXlsxRepair($input_file)

Repair an Excel spreadsheet (XLSX) that contains errors

Repair an Excel spreadsheet document (XLSX) that contains errors or corruption, if possible.

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentXlsxRepair($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentXlsxRepair: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

string

Authorization

Apikey

HTTP request headers

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

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

validateDocumentXlsxValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentXlsxValidation($input_file)

Validate a Excel document (XLSX)

Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentXlsxValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentXlsxValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentXmlValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentXmlValidation($input_file)

Validate an XML file

Validate an XML document file; if the document is not valid, identifies the errors in the document

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentXmlValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentXmlValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentXmlXxeThreatValidation

\Swagger\Client\Model\XxeThreatDetectionResult validateDocumentXmlXxeThreatValidation($input_file)

Validate an XML file for XML External Entity (XXE) threats

Validate an XML document file for XML External Entity (XXE) threats; if the document is not valid, identifies the errors in the document. XXE threats are a type of threat that exploits vulnerabilities in the XML standard relating to external or local entity URIs in XML documents.

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentXmlXxeThreatValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentXmlXxeThreatValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\XxeThreatDetectionResult

Authorization

Apikey

HTTP request headers

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

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

validateDocumentZipValidation

\Swagger\Client\Model\DocumentValidationResult validateDocumentZipValidation($input_file)

Validate a Zip Archive file (zip)

Validate a Zip archive file (ZIP)

Example

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

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

$apiInstance = new Swagger\Client\Api\ValidateDocumentApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

try {
    $result = $apiInstance->validateDocumentZipValidation($input_file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValidateDocumentApi->validateDocumentZipValidation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
input_file	\SplFileObject	Input file to perform the operation on.

Return type

\Swagger\Client\Model\DocumentValidationResult

Authorization

Apikey

HTTP request headers

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

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

Files

ValidateDocumentApi.md

Latest commit

History

ValidateDocumentApi.md

File metadata and controls

Swagger\Client\ValidateDocumentApi

validateDocumentAutodetectValidation

Example

Parameters

Return type

Authorization

HTTP request headers

validateDocumentCsvValidation

Example

Parameters

Return type

Authorization

HTTP request headers

validateDocumentDocValidation

Example

Parameters

Return type

Authorization

HTTP request headers

validateDocumentDocxRepair

Example

Parameters

Return type

Authorization

HTTP request headers

validateDocumentDocxValidation

Example

Parameters

Return type

Authorization

HTTP request headers

validateDocumentEmlValidation

Example

Parameters

Return type

Authorization

HTTP request headers

validateDocumentExecutableValidation

Example

Parameters

Return type

Authorization

HTTP request headers

validateDocumentGZipValidation

Example

Parameters

Return type

Authorization

HTTP request headers

validateDocumentHtmlSsrfValidation

Example

Parameters

Return type

Authorization

HTTP request headers

validateDocumentHtmlValidation

Example

Parameters

Return type

Authorization

HTTP request headers

validateDocumentImageValidation

Example

Parameters

Return type

Authorization

HTTP request headers

validateDocumentJpgValidation

Example

Parameters

Return type

Authorization

HTTP request headers

validateDocumentJsonValidation