Skip to content

Latest commit

 

History

History
131 lines (90 loc) · 4.24 KB

SystemParametersApi.md

File metadata and controls

131 lines (90 loc) · 4.24 KB
Raw

Equisoft\SDK\EquisoftConnect\SystemParametersApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method HTTP request Description
getCompanyDetails() GET /crm/api/v1/databases/{databaseUuid}/parameters/account/company Get company information about the enterprise or an alternate company
getCompanyLogo() GET /crm/api/v1/databases/{databaseUuid}/parameters/account/company/logo Get company logo

getCompanyDetails()

getCompanyDetails($databaseUuid, $companyId): \Equisoft\SDK\EquisoftConnect\Model\ParametersCompanyResponse

Get company information about the enterprise or an alternate company

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\SystemParametersApi(
    // 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
);
$databaseUuid = 'databaseUuid_example'; // string | Database unique identifier.
$companyId = 56; // int | Id of the company, leave unspecified to get the enterprise company

try {
    $result = $apiInstance->getCompanyDetails($databaseUuid, $companyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemParametersApi->getCompanyDetails: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
databaseUuid string Database unique identifier.
companyId int Id of the company, leave unspecified to get the enterprise company [optional]

Return type

\Equisoft\SDK\EquisoftConnect\Model\ParametersCompanyResponse

Authorization

OAuth2

HTTP request headers

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

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

getCompanyLogo()

getCompanyLogo($databaseUuid, $type, $companyId): \SplFileObject

Get company logo

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\SystemParametersApi(
    // 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
);
$databaseUuid = 'databaseUuid_example'; // string | Database unique identifier.
$type = 'web'; // string | type
$companyId = 56; // int | Id of the company, leave unspecified to get the enterprise company

try {
    $result = $apiInstance->getCompanyLogo($databaseUuid, $type, $companyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemParametersApi->getCompanyLogo: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
databaseUuid string Database unique identifier.
type string type [optional] [default to 'web']
companyId int Id of the company, leave unspecified to get the enterprise company [optional]

Return type

\SplFileObject

Authorization

OAuth2

HTTP request headers

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

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