Skip to content

ObjectLeadApi.md

Latest commit

 

History

History
145 lines (99 loc) · 4.88 KB

ObjectLeadApi.md

File metadata and controls

145 lines (99 loc) · 4.88 KB

eZmaxAPI\ObjectLeadApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest, except if the operation defines another base path.

Method HTTP request Description
leadGetListV1() GET /1/object/lead/getList Retrieve Lead list
leadImportIntoEDMV1() POST /1/object/lead/{pkiLeadID}/importIntoEDM Import attachments into the Lead

leadGetListV1()

leadGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\LeadGetListV1Response

Retrieve Lead list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eLeadStatus | New
Dispatching
Assigned
Lost
Won |

Example

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


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


$apiInstance = new eZmaxAPI\Api\ObjectLeadApi(
    // 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
);
$eOrderBy = 'eOrderBy_example'; // string | Specify how you want the results to be sorted
$iRowMax = 56; // int
$iRowOffset = 0; // int
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage
$sFilter = 'sFilter_example'; // string

try {
    $result = $apiInstance->leadGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectLeadApi->leadGetListV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
eOrderBy string Specify how you want the results to be sorted [optional]
iRowMax int [optional]
iRowOffset int [optional] [default to 0]
acceptLanguage \eZmaxAPI\Model\HeaderAcceptLanguage [optional]
sFilter string [optional]

Return type

\eZmaxAPI\Model\LeadGetListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

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

leadImportIntoEDMV1()

leadImportIntoEDMV1($pkiLeadID, $leadImportIntoEDMV1Request): \eZmaxAPI\Model\LeadImportIntoEDMV1Response

Import attachments into the Lead

Example

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


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


$apiInstance = new eZmaxAPI\Api\ObjectLeadApi(
    // 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
);
$pkiLeadID = 56; // int
$leadImportIntoEDMV1Request = new \eZmaxAPI\Model\LeadImportIntoEDMV1Request(); // \eZmaxAPI\Model\LeadImportIntoEDMV1Request

try {
    $result = $apiInstance->leadImportIntoEDMV1($pkiLeadID, $leadImportIntoEDMV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectLeadApi->leadImportIntoEDMV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiLeadID int
leadImportIntoEDMV1Request \eZmaxAPI\Model\LeadImportIntoEDMV1Request

Return type

\eZmaxAPI\Model\LeadImportIntoEDMV1Response

Authorization

Authorization

HTTP request headers

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

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