Skip to content

ReportTemplateApi.md

Latest commit

 

History

History
453 lines (310 loc) · 14.7 KB

ReportTemplateApi.md

File metadata and controls

453 lines (310 loc) · 14.7 KB

SynergiTech\Staffology\ReportTemplateApi

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

Method HTTP request Description
createReportTemplate() POST /employers/{employerId}/reporttemplate Create Report Template (beta)
deleteReportTemplate() DELETE /employers/{employerId}/reporttemplate/{id} Delete Report Template (beta)
getContentDictionaryReportTemplate() GET /contentdictionary Get Content Dictionary For Report Template Column Type(beta)
getReportTemplate() GET /employers/{employerId}/reporttemplate/{id} Get Report Template (beta)
indexReportTemplate() GET /employers/{employerId}/reporttemplate List Report Templates (beta)
updateReportTemplate() PUT /employers/{employerId}/reporttemplate/{id} Update Report Template (beta)
validateReportTemplateColumnsReportTemplate() POST /column/validate Validate Report Template Columns(beta)

createReportTemplate()

createReportTemplate($employerId, $contractReportTemplateRequest): \SynergiTech\Staffology\Model\ContractReportTemplateResponse

Create Report Template (beta)

Creates a new Report Template for the Employer.

Example

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


// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new SynergiTech\Staffology\Api\ReportTemplateApi(
    // 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
);
$employerId = 'employerId_example'; // string | The Id of the Employer to which the Report Template belongs.
$contractReportTemplateRequest = new \SynergiTech\Staffology\Model\ContractReportTemplateRequest(); // \SynergiTech\Staffology\Model\ContractReportTemplateRequest

try {
    $result = $apiInstance->createReportTemplate($employerId, $contractReportTemplateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportTemplateApi->createReportTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
employerId string The Id of the Employer to which the Report Template belongs.
contractReportTemplateRequest \SynergiTech\Staffology\Model\ContractReportTemplateRequest [optional]

Return type

\SynergiTech\Staffology\Model\ContractReportTemplateResponse

Authorization

Basic

HTTP request headers

  • Content-Type: application/*+json, application/json, application/json-patch+json, text/json
  • Accept: application/json

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

deleteReportTemplate()

deleteReportTemplate($employerId, $id)

Delete Report Template (beta)

Deletes the specified Report Template.

Example

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


// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new SynergiTech\Staffology\Api\ReportTemplateApi(
    // 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
);
$employerId = 'employerId_example'; // string | The Id of the Employer to which the Report Template belongs.
$id = 'id_example'; // string | The Id of the Report Template which you want to fetch

try {
    $apiInstance->deleteReportTemplate($employerId, $id);
} catch (Exception $e) {
    echo 'Exception when calling ReportTemplateApi->deleteReportTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
employerId string The Id of the Employer to which the Report Template belongs.
id string The Id of the Report Template which you want to fetch

Return type

void (empty response body)

Authorization

Basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getContentDictionaryReportTemplate()

getContentDictionaryReportTemplate(): \SynergiTech\Staffology\Model\ContractReportTemplateContentDictionaryResponse[]

Get Content Dictionary For Report Template Column Type(beta)

Gets the content dictionary for ReportTemplate columns type for employee and employer.

Example

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


// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new SynergiTech\Staffology\Api\ReportTemplateApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\SynergiTech\Staffology\Model\ContractReportTemplateContentDictionaryResponse[]

Authorization

Basic

HTTP request headers

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

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

getReportTemplate()

getReportTemplate($employerId, $id): \SynergiTech\Staffology\Model\ContractReportTemplateResponse

Get Report Template (beta)

Gets the Report Template specified.

Example

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


// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new SynergiTech\Staffology\Api\ReportTemplateApi(
    // 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
);
$employerId = 'employerId_example'; // string | The Id of the Employer to which the Report Template belongs.
$id = 'id_example'; // string | The Id of the Report Template which you want to fetch

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

Parameters

Name Type Description Notes
employerId string The Id of the Employer to which the Report Template belongs.
id string The Id of the Report Template which you want to fetch

Return type

\SynergiTech\Staffology\Model\ContractReportTemplateResponse

Authorization

Basic

HTTP request headers

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

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

indexReportTemplate()

indexReportTemplate($employerId): \SynergiTech\Staffology\Model\Item[]

List Report Templates (beta)

Lists all Report Templates for an Employer.

Example

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


// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new SynergiTech\Staffology\Api\ReportTemplateApi(
    // 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
);
$employerId = 'employerId_example'; // string | The Id of the Employer to which the Report Template belongs.

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

Parameters

Name Type Description Notes
employerId string The Id of the Employer to which the Report Template belongs.

Return type

\SynergiTech\Staffology\Model\Item[]

Authorization

Basic

HTTP request headers

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

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

updateReportTemplate()

updateReportTemplate($employerId, $id, $contractReportTemplateRequest): \SynergiTech\Staffology\Model\ContractReportTemplateResponse

Update Report Template (beta)

Updates a Report Template for the Employer.

Example

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


// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new SynergiTech\Staffology\Api\ReportTemplateApi(
    // 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
);
$employerId = 'employerId_example'; // string | The Id of the Employer to which the Report Template belongs.
$id = 'id_example'; // string | The Id of the Report Template which you want to fetch
$contractReportTemplateRequest = new \SynergiTech\Staffology\Model\ContractReportTemplateRequest(); // \SynergiTech\Staffology\Model\ContractReportTemplateRequest

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

Parameters

Name Type Description Notes
employerId string The Id of the Employer to which the Report Template belongs.
id string The Id of the Report Template which you want to fetch
contractReportTemplateRequest \SynergiTech\Staffology\Model\ContractReportTemplateRequest [optional]

Return type

\SynergiTech\Staffology\Model\ContractReportTemplateResponse

Authorization

Basic

HTTP request headers

  • Content-Type: application/*+json, application/json, application/json-patch+json, text/json
  • Accept: application/json

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

validateReportTemplateColumnsReportTemplate()

validateReportTemplateColumnsReportTemplate($contractReportTemplateColumnRequest)

Validate Report Template Columns(beta)

Validates the specified Report Template columns.

Example

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


// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new SynergiTech\Staffology\Api\ReportTemplateApi(
    // 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
);
$contractReportTemplateColumnRequest = new \SynergiTech\Staffology\Model\ContractReportTemplateColumnRequest(); // \SynergiTech\Staffology\Model\ContractReportTemplateColumnRequest

try {
    $apiInstance->validateReportTemplateColumnsReportTemplate($contractReportTemplateColumnRequest);
} catch (Exception $e) {
    echo 'Exception when calling ReportTemplateApi->validateReportTemplateColumnsReportTemplate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
contractReportTemplateColumnRequest \SynergiTech\Staffology\Model\ContractReportTemplateColumnRequest [optional]

Return type

void (empty response body)

Authorization

Basic

HTTP request headers

  • Content-Type: application/*+json, application/json, application/json-patch+json, text/json
  • Accept: Not defined

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