SynergiTech\Staffology\LoanApi

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

Method	HTTP request	Description
addDocumentLoan()	POST /employers/{employerId}/employees/{employeeId}/loans/{id}/documents	Add Document
createLoan()	POST /employers/{employerId}/employees/{employeeId}/loans	Create Loan
deleteDocumentLoan()	DELETE /employers/{employerId}/employees/{employeeId}/loans/{id}/documents/{documentId}	Delete Loan Document
deleteLoan()	DELETE /employers/{employerId}/employees/{employeeId}/loans/{id}	Delete Loan
getDocumentLoan()	GET /employers/{employerId}/employees/{employeeId}/loans/{id}/documents/{documentId}	Get Loan Document
getLoan()	GET /employers/{employerId}/employees/{employeeId}/loans/{id}	Get Loan
indexLoan()	GET /employers/{employerId}/employees/{employeeId}/loans	List Loans
updateLoan()	PUT /employers/{employerId}/employees/{employeeId}/loans/{id}	Update Loan

`addDocumentLoan()`

addDocumentLoan($employerId, $employeeId, $id, $file)

Add Document

Adds document to the Loan

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\LoanApi(
    // 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
$employeeId = 'employeeId_example'; // string
$id = 'id_example'; // string | The Id of the Loan you want to attach documents to
$file = '/path/to/file.txt'; // \SplFileObject

try {
    $apiInstance->addDocumentLoan($employerId, $employeeId, $id, $file);
} catch (Exception $e) {
    echo 'Exception when calling LoanApi->addDocumentLoan: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string
employeeId	string
id	string	The Id of the Loan you want to attach documents to
file	\SplFileObject\SplFileObject		[optional]

Return type

void (empty response body)

Authorization

Basic

HTTP request headers

Content-Type: multipart/form-data
Accept: Not defined

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

`createLoan()`

createLoan($employerId, $employeeId, $loan)

Create Loan

Creates a Loan for the Employee

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\LoanApi(
    // 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
$employeeId = 'employeeId_example'; // string
$loan = new \SynergiTech\Staffology\Model\Loan(); // \SynergiTech\Staffology\Model\Loan

try {
    $apiInstance->createLoan($employerId, $employeeId, $loan);
} catch (Exception $e) {
    echo 'Exception when calling LoanApi->createLoan: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
employerId	string
employeeId	string
loan	\SynergiTech\Staffology\Model\Loan	[optional]

Return type

void (empty response body)

Authorization

Basic

HTTP request headers

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

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

`deleteDocumentLoan()`

deleteDocumentLoan($employerId, $employeeId, $id, $documentId)

Delete Loan Document

Deletes the document specified by the documentId for the Loan specified by the Id

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\LoanApi(
    // 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
$employeeId = 'employeeId_example'; // string
$id = 'id_example'; // string
$documentId = 'documentId_example'; // string | The Id of the Document you want to delete.

try {
    $apiInstance->deleteDocumentLoan($employerId, $employeeId, $id, $documentId);
} catch (Exception $e) {
    echo 'Exception when calling LoanApi->deleteDocumentLoan: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
employerId	string
employeeId	string
id	string
documentId	string	The Id of the Document 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]

`deleteLoan()`

deleteLoan($employerId, $employeeId, $id)

Delete Loan

Deletes the Loan specified by the Id for the Employee specified by the EmployeeId

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\LoanApi(
    // 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
$employeeId = 'employeeId_example'; // string
$id = 'id_example'; // string | The Id of the Loan you want to delete.

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

Parameters

Name	Type	Description
employerId	string
employeeId	string
id	string	The Id of the Loan 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]

`getDocumentLoan()`

getDocumentLoan($employerId, $employeeId, $id, $documentId): \SplFileObject

Get Loan Document

Gets the document specified by the documentId for the Loan specified by the Id

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\LoanApi(
    // 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
$employeeId = 'employeeId_example'; // string
$id = 'id_example'; // string
$documentId = 'documentId_example'; // string | The Id of the Document you want to retrieve.

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

Parameters

Name	Type	Description
employerId	string
employeeId	string
id	string
documentId	string	The Id of the Document you want to retrieve.

Return type

\SplFileObject

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]

`getLoan()`

getLoan($employerId, $employeeId, $id): \SynergiTech\Staffology\Model\Loan

Get Loan

Gets the Loan specified by the Id for the Employee specified by the EmployeeId

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\LoanApi(
    // 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
$employeeId = 'employeeId_example'; // string
$id = 'id_example'; // string | The Id of the Loan you want to retrieve.

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

Parameters

Name	Type	Description
employerId	string
employeeId	string
id	string	The Id of the Loan you want to retrieve.

Return type

\SynergiTech\Staffology\Model\Loan

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]

`indexLoan()`

indexLoan($employerId, $employeeId): \SynergiTech\Staffology\Model\Item[]

List Loans

Lists all AttachmentOrders for the Employee

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\LoanApi(
    // 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
$employeeId = 'employeeId_example'; // string

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

Parameters

Name	Type	Description	Notes
employerId	string
employeeId	string

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]

`updateLoan()`

updateLoan($employerId, $employeeId, $id, $loan): \SynergiTech\Staffology\Model\Loan

Update Loan

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\LoanApi(
    // 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
$employeeId = 'employeeId_example'; // string
$id = 'id_example'; // string | The Id of the Loan you want to update.
$loan = new \SynergiTech\Staffology\Model\Loan(); // \SynergiTech\Staffology\Model\Loan

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

Parameters

Name	Type	Description	Notes
employerId	string
employeeId	string
id	string	The Id of the Loan you want to update.
loan	\SynergiTech\Staffology\Model\Loan		[optional]

Return type

\SynergiTech\Staffology\Model\Loan

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

LoanApi.md

Latest commit

History

LoanApi.md

File metadata and controls

SynergiTech\Staffology\LoanApi

addDocumentLoan()

Example

Parameters

Return type

Authorization

HTTP request headers

createLoan()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDocumentLoan()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteLoan()

Example

Parameters

Return type

Authorization

HTTP request headers

getDocumentLoan()

Example

Parameters

Return type

Authorization

HTTP request headers

getLoan()

Example

Parameters

Return type

Authorization

HTTP request headers

indexLoan()

Example

Parameters

Return type

Authorization

HTTP request headers

updateLoan()

Example

Parameters

Return type

Authorization

HTTP request headers

`addDocumentLoan()`

`createLoan()`

`deleteDocumentLoan()`

`deleteLoan()`

`getDocumentLoan()`

`getLoan()`

`indexLoan()`

`updateLoan()`