SynergiTech\Staffology\DepartmentApi

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

Method	HTTP request	Description
createDepartment()	POST /employers/{employerId}/departments	Create Department
deleteDepartment()	DELETE /employers/{employerId}/departments/{code}	Delete Department (deprecated)
deleteDepartmentDepartment()	DELETE /employers/{employerId}/departments/department	Delete Department
getDepartment()	GET /employers/{employerId}/departments/{code}	Get Department (deprecated)
getDepartmentDepartment()	GET /employers/{employerId}/departments/Department	Get Department
indexDepartment()	GET /employers/{employerId}/departments	List Departments
updateDepartment()	PUT /employers/{employerId}/departments/{code}	Update Department (deprecated)
updateDepartmentDepartment()	PUT /employers/{employerId}/departments/department	Update Department

`createDepartment()`

createDepartment($employerId, $department): \SynergiTech\Staffology\Model\Department

Create Department

Creates a new Department 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\DepartmentApi(
    // 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
$department = new \SynergiTech\Staffology\Model\Department(); // \SynergiTech\Staffology\Model\Department

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

Parameters

Name	Type	Description	Notes
employerId	string
department	\SynergiTech\Staffology\Model\Department		[optional]

Return type

\SynergiTech\Staffology\Model\Department

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]

`deleteDepartment()`

deleteDepartment($employerId, $code)

Delete Department (deprecated)

Deletes the specified Department.

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\DepartmentApi(
    // 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
$code = 'code_example'; // string

try {
    $apiInstance->deleteDepartment($employerId, $code);
} catch (Exception $e) {
    echo 'Exception when calling DepartmentApi->deleteDepartment: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string
code	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]

`deleteDepartmentDepartment()`

deleteDepartmentDepartment($employerId, $code)

Delete Department

Deletes the specified Department.

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\DepartmentApi(
    // 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
$code = 'code_example'; // string

try {
    $apiInstance->deleteDepartmentDepartment($employerId, $code);
} catch (Exception $e) {
    echo 'Exception when calling DepartmentApi->deleteDepartmentDepartment: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string
code	string		[optional]

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]

`getDepartment()`

getDepartment($employerId, $code): \SynergiTech\Staffology\Model\Department

Get Department (deprecated)

Gets the Department specified. Use the other GET endpoint that supports non-alphanumeric characters for a department code

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\DepartmentApi(
    // 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 Department belongs.
$code = 'code_example'; // string

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

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer to which the Department belongs.
code	string

Return type

\SynergiTech\Staffology\Model\Department

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]

`getDepartmentDepartment()`

getDepartmentDepartment($employerId, $code): \SynergiTech\Staffology\Model\Department

Get Department

Gets the Department 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\DepartmentApi(
    // 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 Department belongs.
$code = 'code_example'; // string | The code of the Department you want to retrieve.

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

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer to which the Department belongs.
code	string	The code of the Department you want to retrieve.	[optional]

Return type

\SynergiTech\Staffology\Model\Department

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]

`indexDepartment()`

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

List Departments

Lists all Departments 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\DepartmentApi(
    // 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 Departments

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

Parameters

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

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]

`updateDepartment()`

updateDepartment($employerId, $code, $department): \SynergiTech\Staffology\Model\Department

Update Department (deprecated)

Updates a Department 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\DepartmentApi(
    // 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
$code = 'code_example'; // string
$department = new \SynergiTech\Staffology\Model\Department(); // \SynergiTech\Staffology\Model\Department

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

Parameters

Name	Type	Notes
employerId	string
code	string
department	\SynergiTech\Staffology\Model\Department	[optional]

Return type

\SynergiTech\Staffology\Model\Department

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]

`updateDepartmentDepartment()`

updateDepartmentDepartment($employerId, $code, $department): \SynergiTech\Staffology\Model\Department

Update Department

Updates the details of an existing Department.

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\DepartmentApi(
    // 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
$code = 'code_example'; // string
$department = new \SynergiTech\Staffology\Model\Department(); // \SynergiTech\Staffology\Model\Department

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

Parameters

Name	Type	Notes
employerId	string
code	string	[optional]
department	\SynergiTech\Staffology\Model\Department	[optional]

Return type

\SynergiTech\Staffology\Model\Department

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]

Files

DepartmentApi.md

Latest commit

History

DepartmentApi.md

File metadata and controls

SynergiTech\Staffology\DepartmentApi

createDepartment()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDepartment()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDepartmentDepartment()

Example

Parameters

Return type

Authorization

HTTP request headers

getDepartment()

Example

Parameters

Return type

Authorization

HTTP request headers

getDepartmentDepartment()

Example

Parameters

Return type

Authorization

HTTP request headers

indexDepartment()

Example

Parameters

Return type

Authorization

HTTP request headers

updateDepartment()

Example

Parameters

Return type

Authorization

HTTP request headers

updateDepartmentDepartment()

Example

Parameters

Return type

Authorization

HTTP request headers

`createDepartment()`

`deleteDepartment()`

`deleteDepartmentDepartment()`

`getDepartment()`

`getDepartmentDepartment()`

`indexDepartment()`

`updateDepartment()`

`updateDepartmentDepartment()`