Skip to content

Latest commit

 

History

History
331 lines (228 loc) · 10.7 KB

OccupationalPolicyApi.md

File metadata and controls

331 lines (228 loc) · 10.7 KB

SynergiTech\Staffology\OccupationalPolicyApi

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

Method HTTP request Description
createOccupationalPolicy() POST /employers/{employerId}/occupationalpolicies Create Occupational Policy
deleteOccupationalPolicy() DELETE /employers/{employerId}/occupationalpolicies/{id} Delete Occupational Policy
getOccupationalPolicy() GET /employers/{employerId}/occupationalpolicies/{id} Get Occupational Policy
indexOccupationalPolicy() GET /employers/{employerId}/occupationalpolicies List Occupational Policies
updateOccupationalPolicy() PUT /employers/{employerId}/occupationalpolicies/{id} Update Occupational Policy

createOccupationalPolicy()

createOccupationalPolicy($employerId, $occupationalPolicy): \SynergiTech\Staffology\Model\OccupationalPolicy

Create Occupational Policy

Creates a new Occupational Policy 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\OccupationalPolicyApi(
    // 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 Employee belongs.
$occupationalPolicy = new \SynergiTech\Staffology\Model\OccupationalPolicy(); // \SynergiTech\Staffology\Model\OccupationalPolicy

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

Parameters

Name Type Description Notes
employerId string The Id of the Employer to which the Employee belongs.
occupationalPolicy \SynergiTech\Staffology\Model\OccupationalPolicy [optional]

Return type

\SynergiTech\Staffology\Model\OccupationalPolicy

Authorization

Basic

HTTP request headers

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

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

deleteOccupationalPolicy()

deleteOccupationalPolicy($employerId, $id)

Delete Occupational Policy

Deletes the specified Occupational Policy.

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\OccupationalPolicyApi(
    // 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 Occupational Policy belongs.
$id = 'id_example'; // string | The Id of the Occupational Policy which you want to fetch

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

Parameters

Name Type Description Notes
employerId string The Id of the Employer to which the Occupational Policy belongs.
id string The Id of the Occupational Policy 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]

getOccupationalPolicy()

getOccupationalPolicy($employerId, $id): \SynergiTech\Staffology\Model\OccupationalPolicy

Get Occupational Policy

Gets the Occupational Policy 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\OccupationalPolicyApi(
    // 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 Occupational Policy belongs.
$id = 'id_example'; // string | The Id of the Occupational Policy which you want to fetch

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

Parameters

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

Return type

\SynergiTech\Staffology\Model\OccupationalPolicy

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]

indexOccupationalPolicy()

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

List Occupational Policies

Lists all Occupational Policies 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\OccupationalPolicyApi(
    // 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 Employee belongs.

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

Parameters

Name Type Description Notes
employerId string The Id of the Employer to which the Employee 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]

updateOccupationalPolicy()

updateOccupationalPolicy($employerId, $id, $occupationalPolicy): \SynergiTech\Staffology\Model\OccupationalPolicy

Update Occupational Policy

Updates a Occupational Policy 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\OccupationalPolicyApi(
    // 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 Occupational Policy belongs.
$id = 'id_example'; // string | The Id of the Occupational Policy which you want to fetch
$occupationalPolicy = new \SynergiTech\Staffology\Model\OccupationalPolicy(); // \SynergiTech\Staffology\Model\OccupationalPolicy

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

Parameters

Name Type Description Notes
employerId string The Id of the Employer to which the Occupational Policy belongs.
id string The Id of the Occupational Policy which you want to fetch
occupationalPolicy \SynergiTech\Staffology\Model\OccupationalPolicy [optional]

Return type

\SynergiTech\Staffology\Model\OccupationalPolicy

Authorization

Basic

HTTP request headers

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

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