SynergiTech\Staffology\AnalysisCategoryApi

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

Method	HTTP request	Description
createAnalysisCategory()	POST /employers/{employerId}/analysiscategories	Create AnalysisCategory
createAnalysisCategoryCodeAnalysisCategory()	POST /employers/{employerId}/analysiscategories/{analysisCategoryId}/categorycodes	Create AnalysisCategoryCode
deleteAnalysisCategory()	DELETE /employers/{employerId}/analysiscategories/{id}	Delete AnalysisCategory
deleteAnalysisCategoryCodeAnalysisCategory()	DELETE /employers/{employerId}/analysiscategories/{analysisCategoryId}/categorycodes/{code}	Delete AnalysisCategoryCode
getAnalysisCategory()	GET /employers/{employerId}/analysiscategories/{id}	Get AnalysisCategory
getAnalysisCategoryCodeAnalysisCategory()	GET /employers/{employerId}/analysiscategories/{analysisCategoryId}/categorycodes/{code}	Get AnalysisCategoryCode
getCodesAnalysisCategory()	GET /employers/{employerId}/analysiscategories/{analysisCategoryId}/categorycodes	List AnalysisCategoryCodes
indexAnalysisCategory()	GET /employers/{employerId}/analysiscategories	List AnalysisCategories
updateAnalysisCategory()	PUT /employers/{employerId}/analysiscategories/{id}	Update AnalysisCategory
updateAnalysisCategoryCodeAnalysisCategory()	PUT /employers/{employerId}/analysiscategories/{analysisCategoryId}/categorycodes/{code}	Update AnalysisCategoryCode

`createAnalysisCategory()`

createAnalysisCategory($employerId, $contractAnalysisCategoryRequest): \SynergiTech\Staffology\Model\ContractAnalysisCategoryResponse

Create AnalysisCategory

Create a new AnalysisCategory 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\AnalysisCategoryApi(
    // 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
$contractAnalysisCategoryRequest = new \SynergiTech\Staffology\Model\ContractAnalysisCategoryRequest(); // \SynergiTech\Staffology\Model\ContractAnalysisCategoryRequest

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

Parameters

Name	Type	Description	Notes
employerId	string
contractAnalysisCategoryRequest	\SynergiTech\Staffology\Model\ContractAnalysisCategoryRequest		[optional]

Return type

\SynergiTech\Staffology\Model\ContractAnalysisCategoryResponse

Authorization

Basic

HTTP request headers

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

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

`createAnalysisCategoryCodeAnalysisCategory()`

createAnalysisCategoryCodeAnalysisCategory($employerId, $analysisCategoryId, $contractAnalysisCategoryCodeRequest): \SynergiTech\Staffology\Model\ContractAnalysisCategoryCodeResponse

Create AnalysisCategoryCode

Create the details of an existing AnalysisCategoryCode.

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\AnalysisCategoryApi(
    // 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 Analysis category belongs.
$analysisCategoryId = 'analysisCategoryId_example'; // string | The Analysis category id for  which you want to create code
$contractAnalysisCategoryCodeRequest = new \SynergiTech\Staffology\Model\ContractAnalysisCategoryCodeRequest(); // \SynergiTech\Staffology\Model\ContractAnalysisCategoryCodeRequest

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

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer to which the Analysis category belongs.
analysisCategoryId	string	The Analysis category id for which you want to create code
contractAnalysisCategoryCodeRequest	\SynergiTech\Staffology\Model\ContractAnalysisCategoryCodeRequest		[optional]

Return type

\SynergiTech\Staffology\Model\ContractAnalysisCategoryCodeResponse

Authorization

Basic

HTTP request headers

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

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

`deleteAnalysisCategory()`

deleteAnalysisCategory($employerId, $id)

Delete AnalysisCategory

Deletes the specified AnalysisCategory.

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\AnalysisCategoryApi(
    // 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->deleteAnalysisCategory($employerId, $id);
} catch (Exception $e) {
    echo 'Exception when calling AnalysisCategoryApi->deleteAnalysisCategory: ', $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]

`deleteAnalysisCategoryCodeAnalysisCategory()`

deleteAnalysisCategoryCodeAnalysisCategory($employerId, $analysisCategoryId, $code)

Delete AnalysisCategoryCode

Deletes the specified AnalysisCategoryCode.

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\AnalysisCategoryApi(
    // 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
$analysisCategoryId = 'analysisCategoryId_example'; // string | The Id of the AnalysisCategory to which the Code belongs.
$code = 'code_example'; // string | The code of the AnalysisCategoryCode you want to delete.

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

Parameters

Name	Type	Description
employerId	string
analysisCategoryId	string	The Id of the AnalysisCategory to which the Code belongs.
code	string	The code of the AnalysisCategoryCode you want to delete.

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]

`getAnalysisCategory()`

getAnalysisCategory($employerId, $id): \SynergiTech\Staffology\Model\ContractAnalysisCategoryResponse

Get AnalysisCategory

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

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

Parameters

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

Return type

\SynergiTech\Staffology\Model\ContractAnalysisCategoryResponse

Authorization

Basic

HTTP request headers

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

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

`getAnalysisCategoryCodeAnalysisCategory()`

getAnalysisCategoryCodeAnalysisCategory($employerId, $analysisCategoryId, $code): \SynergiTech\Staffology\Model\ContractAnalysisCategoryCodeResponse

Get AnalysisCategoryCode

Gets the AnalysisCategoryCode 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\AnalysisCategoryApi(
    // 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
$analysisCategoryId = 'analysisCategoryId_example'; // string | The Id of the AnalysisCategory to which the Code belongs.
$code = 'code_example'; // string | The code of the AnalysisCategoryCode you want to retrieve.

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

Parameters

Name	Type	Description
employerId	string
analysisCategoryId	string	The Id of the AnalysisCategory to which the Code belongs.
code	string	The code of the AnalysisCategoryCode you want to retrieve.

Return type

\SynergiTech\Staffology\Model\ContractAnalysisCategoryCodeResponse

Authorization

Basic

HTTP request headers

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

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

`getCodesAnalysisCategory()`

getCodesAnalysisCategory($employerId, $analysisCategoryId): \SynergiTech\Staffology\Model\Item[]

List AnalysisCategoryCodes

Lists all AnalysisCategoryCodes for an Category.

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\AnalysisCategoryApi(
    // 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
$analysisCategoryId = 'analysisCategoryId_example'; // string | The Id of the Category for which you want to list Codes

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

Parameters

Name	Type	Description	Notes
employerId	string
analysisCategoryId	string	The Id of the Category for which you want to list Codes

Return type

\SynergiTech\Staffology\Model\Item[]

Authorization

Basic

HTTP request headers

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

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

`indexAnalysisCategory()`

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

List AnalysisCategories

Lists all AnalysisCategories 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\AnalysisCategoryApi(
    // 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 AnalysisCategories

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

Parameters

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

Return type

\SynergiTech\Staffology\Model\Item[]

Authorization

Basic

HTTP request headers

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

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

`updateAnalysisCategory()`

updateAnalysisCategory($employerId, $id, $contractAnalysisCategoryRequest): \SynergiTech\Staffology\Model\ContractAnalysisCategoryResponse

Update AnalysisCategory

Updates a AnalysisCategory 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\AnalysisCategoryApi(
    // 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
$contractAnalysisCategoryRequest = new \SynergiTech\Staffology\Model\ContractAnalysisCategoryRequest(); // \SynergiTech\Staffology\Model\ContractAnalysisCategoryRequest

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

Parameters

Name	Type	Notes
employerId	string
id	string
contractAnalysisCategoryRequest	\SynergiTech\Staffology\Model\ContractAnalysisCategoryRequest	[optional]

Return type

\SynergiTech\Staffology\Model\ContractAnalysisCategoryResponse

Authorization

Basic

HTTP request headers

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

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

`updateAnalysisCategoryCodeAnalysisCategory()`

updateAnalysisCategoryCodeAnalysisCategory($employerId, $analysisCategoryId, $code, $contractAnalysisCategoryCodeRequest): \SynergiTech\Staffology\Model\ContractAnalysisCategoryCodeResponse

Update AnalysisCategoryCode

Updates the details of an existing AnalysisCategoryCode.

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\AnalysisCategoryApi(
    // 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 Analysis category belongs.
$analysisCategoryId = 'analysisCategoryId_example'; // string | The Analysis category id for  which you want to update Analysis code
$code = 'code_example'; // string | The code of the Analysis category code you want to update.
$contractAnalysisCategoryCodeRequest = new \SynergiTech\Staffology\Model\ContractAnalysisCategoryCodeRequest(); // \SynergiTech\Staffology\Model\ContractAnalysisCategoryCodeRequest

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

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer to which the Analysis category belongs.
analysisCategoryId	string	The Analysis category id for which you want to update Analysis code
code	string	The code of the Analysis category code you want to update.
contractAnalysisCategoryCodeRequest	\SynergiTech\Staffology\Model\ContractAnalysisCategoryCodeRequest		[optional]

Return type

\SynergiTech\Staffology\Model\ContractAnalysisCategoryCodeResponse

Authorization

Basic

HTTP request headers

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

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

FilesExpand file tree

AnalysisCategoryApi.md

Latest commit

History

AnalysisCategoryApi.md

File metadata and controls

SynergiTech\Staffology\AnalysisCategoryApi

createAnalysisCategory()

Example

Parameters

Return type

Authorization

HTTP request headers

createAnalysisCategoryCodeAnalysisCategory()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAnalysisCategory()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAnalysisCategoryCodeAnalysisCategory()

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalysisCategory()

Example

Parameters

Return type

Authorization

HTTP request headers

getAnalysisCategoryCodeAnalysisCategory()

Example

Parameters

Return type

Authorization

HTTP request headers

getCodesAnalysisCategory()

Example

Parameters

Return type

Authorization

HTTP request headers

indexAnalysisCategory()

Example

Parameters

Return type

Authorization

HTTP request headers

updateAnalysisCategory()

Example

Parameters

Return type

Authorization

HTTP request headers

updateAnalysisCategoryCodeAnalysisCategory()

Example

Parameters

Return type

Authorization

HTTP request headers

`createAnalysisCategory()`

`createAnalysisCategoryCodeAnalysisCategory()`

`deleteAnalysisCategory()`

`deleteAnalysisCategoryCodeAnalysisCategory()`

`getAnalysisCategory()`

`getAnalysisCategoryCodeAnalysisCategory()`

`getCodesAnalysisCategory()`

`indexAnalysisCategory()`

`updateAnalysisCategory()`

`updateAnalysisCategoryCodeAnalysisCategory()`