Skip to content

WorkingPatternApi.md

Latest commit

 

History

History
331 lines (228 loc) · 10.1 KB

WorkingPatternApi.md

File metadata and controls

331 lines (228 loc) · 10.1 KB

SynergiTech\Staffology\WorkingPatternApi

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

Method HTTP request Description
createWorkingPattern() POST /employers/{employerId}/workingpatterns Create WorkingPattern
deleteWorkingPattern() DELETE /employers/{employerId}/workingpatterns/{id} Delete WorkingPattern
getAsyncWorkingPattern() GET /employers/{employerId}/workingpatterns/{id} Get WorkingPattern
indexAsyncWorkingPattern() GET /employers/{employerId}/workingpatterns List WorkingPatterns
updateWorkingPattern() PUT /employers/{employerId}/workingpatterns/{id} Update WorkingPattern

createWorkingPattern()

createWorkingPattern($employerId, $contractWorkingPatternRequest): \SynergiTech\Staffology\Model\WorkingPattern

Create WorkingPattern

Creates a new WorkingPattern 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\WorkingPatternApi(
    // 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
$contractWorkingPatternRequest = new \SynergiTech\Staffology\Model\ContractWorkingPatternRequest(); // \SynergiTech\Staffology\Model\ContractWorkingPatternRequest

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

Parameters

Name Type Description Notes
employerId string
contractWorkingPatternRequest \SynergiTech\Staffology\Model\ContractWorkingPatternRequest [optional]

Return type

\SynergiTech\Staffology\Model\WorkingPattern

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]

deleteWorkingPattern()

deleteWorkingPattern($employerId, $id)

Delete WorkingPattern

Deletes the specified WorkingPattern.

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\WorkingPatternApi(
    // 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
$id = 'id_example'; // string

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

Parameters

Name Type Description Notes
employerId string
id string

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]

getAsyncWorkingPattern()

getAsyncWorkingPattern($employerId, $id): \SynergiTech\Staffology\Model\ContractWorkingPatternResponse

Get WorkingPattern

Gets the WorkingPattern 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\WorkingPatternApi(
    // 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 WorkingPattern belongs.
$id = 'id_example'; // string | The id of the WorkingPattern you want to retrieve.

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

Parameters

Name Type Description Notes
employerId string The Id of the Employer to which the WorkingPattern belongs.
id string The id of the WorkingPattern you want to retrieve.

Return type

\SynergiTech\Staffology\Model\ContractWorkingPatternResponse

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]

indexAsyncWorkingPattern()

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

List WorkingPatterns

Lists all WorkingPattern for the Employer 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\WorkingPatternApi(
    // 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 list WorkingPattern

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

Parameters

Name Type Description Notes
employerId string The Id of the Employer for which you want to list WorkingPattern

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]

updateWorkingPattern()

updateWorkingPattern($employerId, $id, $contractWorkingPatternRequest): \SynergiTech\Staffology\Model\ContractWorkingPatternResponse

Update WorkingPattern

Updates the details of an existing WorkingPattern.

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\WorkingPatternApi(
    // 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
$id = 'id_example'; // string
$contractWorkingPatternRequest = new \SynergiTech\Staffology\Model\ContractWorkingPatternRequest(); // \SynergiTech\Staffology\Model\ContractWorkingPatternRequest

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

Parameters

Name Type Description Notes
employerId string
id string
contractWorkingPatternRequest \SynergiTech\Staffology\Model\ContractWorkingPatternRequest [optional]

Return type

\SynergiTech\Staffology\Model\ContractWorkingPatternResponse

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]