Skip to content

Latest commit

 

History

History
202 lines (139 loc) · 6.9 KB

JournalTemplateApi.md

File metadata and controls

202 lines (139 loc) · 6.9 KB

SynergiTech\Staffology\JournalTemplateApi

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

Method HTTP request Description
createJournalTemplate() POST /employers/{employerId}/journaltemplate Create Journal Template
getJournalTemplate() GET /employers/{employerId}/journaltemplate Get Journal Template
updateJournalTemplate() PUT /employers/{employerId}/journaltemplate/{id} Update Journal Template

createJournalTemplate()

createJournalTemplate($employerId, $contractJournalTemplateRequest): \SynergiTech\Staffology\Model\JournalTemplate

Create Journal Template

Create Journal Template 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\JournalTemplateApi(
    // 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 for which you want to create Journal Template
$contractJournalTemplateRequest = new \SynergiTech\Staffology\Model\ContractJournalTemplateRequest(); // \SynergiTech\Staffology\Model\ContractJournalTemplateRequest

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

Parameters

Name Type Description Notes
employerId string The Id of the Employer for which you want to create Journal Template
contractJournalTemplateRequest \SynergiTech\Staffology\Model\ContractJournalTemplateRequest [optional]

Return type

\SynergiTech\Staffology\Model\JournalTemplate

Authorization

Basic

HTTP request headers

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

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

getJournalTemplate()

getJournalTemplate($employerId): \SynergiTech\Staffology\Model\ContractJournalTemplateResponse

Get Journal Template

Get Journal Template 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\JournalTemplateApi(
    // 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 for which you want to get Journal Template

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

Parameters

Name Type Description Notes
employerId string The Id of the Employer for which you want to get Journal Template

Return type

\SynergiTech\Staffology\Model\ContractJournalTemplateResponse

Authorization

Basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

updateJournalTemplate()

updateJournalTemplate($employerId, $id, $contractJournalTemplateRequest): \SynergiTech\Staffology\Model\ContractJournalTemplateResponse

Update Journal Template

Updates Specified Journal 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\JournalTemplateApi(
    // 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 for which you want to update Journal Template
$id = 'id_example'; // string
$contractJournalTemplateRequest = new \SynergiTech\Staffology\Model\ContractJournalTemplateRequest(); // \SynergiTech\Staffology\Model\ContractJournalTemplateRequest

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

Parameters

Name Type Description Notes
employerId string The Id of the Employer for which you want to update Journal Template
id string
contractJournalTemplateRequest \SynergiTech\Staffology\Model\ContractJournalTemplateRequest [optional]

Return type

\SynergiTech\Staffology\Model\ContractJournalTemplateResponse

Authorization

Basic

HTTP request headers

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

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