Skip to content

Latest commit

 

History

History
108 lines (74 loc) · 3.35 KB

ProcessApi.md

File metadata and controls

108 lines (74 loc) · 3.35 KB
Raw

Swagger\Client\ProcessApi

All URIs are relative to https://api.mailvio.com/v3/

Method HTTP request Description
getProcess GET /processes/{processId} Return the informations for a process
getProcesses GET /processes Return all the processes for your account

getProcess

\Swagger\Client\Model\GetProcess getProcess($process_id)

Return the informations for a process

Example

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

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

$api_instance = new Swagger\Client\Api\ProcessApi();
$process_id = 789; // int | Id of the process

try {
    $result = $api_instance->getProcess($process_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessApi->getProcess: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
process_id int Id of the process

Return type

\Swagger\Client\Model\GetProcess

Authorization

api-key

HTTP request headers

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

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

getProcesses

\Swagger\Client\Model\GetProcesses getProcesses($limit, $offset)

Return all the processes for your account

Example

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

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

$api_instance = new Swagger\Client\Api\ProcessApi();
$limit = 10; // int | Number limitation for the result returned
$offset = 0; // int | Beginning point in the list to retrieve from.

try {
    $result = $api_instance->getProcesses($limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessApi->getProcesses: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
limit int Number limitation for the result returned [optional] [default to 10]
offset int Beginning point in the list to retrieve from. [optional] [default to 0]

Return type

\Swagger\Client\Model\GetProcesses

Authorization

api-key

HTTP request headers

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

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