All URIs are relative to http://localhost, except if the operation defines another base path.
Method | HTTP request | Description |
---|---|---|
activateAccount() | POST /account/activate | Activate an Account |
changeEmailAddressAccount() | POST /account/emailaddress | Change Email Address |
createApiKeyAccount() | POST /account/keys | Create ApiKey |
createDemoEmployerAccount() | POST /account/demo | Create Demo Employer |
deleteApiKeyAccount() | DELETE /account/keys/{id} | Delete ApiKey |
getAccount() | GET /account | Get Account Details |
getApiKeyAccount() | GET /account/keys/{id} | Get ApiKey |
getEmployerDefaultsAccount() | GET /account/employerdefaults | Get EmployerDefaults |
getInvitationsAccount() | GET /account/invitations | Get Invitations |
getTenantAccount() | GET /account/Tenant | Get Tenant |
getUserEmployersAccount() | GET /account/useremployers | List User Employers |
listApiKeysAccount() | GET /account/keys | List ApiKeys |
profileAccount() | POST /account/profile | Update Profile |
setEmployerDefaultsAccount() | PUT /account/employerdefaults | Set EmployerDefaults |
updatePhotoAccount() | POST /account/photo | Update Photo |
verifyAccount() | POST /account/verify | Re-send Verification Email |
verifyResponseAccount() | PUT /account/verify/respond | Verify Email Address |
activateAccount($brandCode, $autoActivate, $user): \SynergiTech\Staffology\Model\User
Activate an Account
New accounts need to be activated to confirm Terms and Conditions have been accepted.
<?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\AccountApi(
// 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
);
$brandCode = 'brandCode_example'; // string
$autoActivate = false; // bool | If autoActivate is set to true, the account activation should be automatically performed without any user interaction
$user = new \SynergiTech\Staffology\Model\User(); // \SynergiTech\Staffology\Model\User
try {
$result = $apiInstance->activateAccount($brandCode, $autoActivate, $user);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->activateAccount: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
brandCode | string | [optional] | |
autoActivate | bool | If autoActivate is set to true, the account activation should be automatically performed without any user interaction | [optional] [default to false] |
user | \SynergiTech\Staffology\Model\User | [optional] |
\SynergiTech\Staffology\Model\User
- 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]
changeEmailAddressAccount($emailAddress): \SynergiTech\Staffology\Model\User
Change Email Address
The user.PendingEmailAddress will be set to the give address and a new verification email will be sent. Once the link in the email is clicked on then the user account will be updated to use the new email address
<?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\AccountApi(
// 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
);
$emailAddress = 'emailAddress_example'; // string
try {
$result = $apiInstance->changeEmailAddressAccount($emailAddress);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->changeEmailAddressAccount: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
emailAddress | string | [optional] |
\SynergiTech\Staffology\Model\User
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
createApiKeyAccount($item): \SynergiTech\Staffology\Model\Item
Create ApiKey
Creates a new APIKey. The only property that's required or used is Name. A new ApiKey will be generated and returned to you.
<?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\AccountApi(
// 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
);
$item = new \SynergiTech\Staffology\Model\Item(); // \SynergiTech\Staffology\Model\Item
try {
$result = $apiInstance->createApiKeyAccount($item);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->createApiKeyAccount: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
item | \SynergiTech\Staffology\Model\Item | [optional] |
\SynergiTech\Staffology\Model\Item
- 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]
createDemoEmployerAccount()
Create Demo Employer
Creates a demo employer for the user
<?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\AccountApi(
// 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
);
try {
$apiInstance->createDemoEmployerAccount();
} catch (Exception $e) {
echo 'Exception when calling AccountApi->createDemoEmployerAccount: ', $e->getMessage(), PHP_EOL;
}
This endpoint does not need any parameter.
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteApiKeyAccount($id)
Delete ApiKey
<?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\AccountApi(
// 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
);
$id = 'id_example'; // string
try {
$apiInstance->deleteApiKeyAccount($id);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->deleteApiKeyAccount: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAccount($defaults, $defaultsKey): \SynergiTech\Staffology\Model\User
Get Account Details
Returns the details for the authorised account.
<?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\AccountApi(
// 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
);
$defaults = 'defaults_example'; // string | You can leave this empty, it's for internal use only.
$defaultsKey = 'defaultsKey_example'; // string | You can leave this empty, it's for internal use only.
try {
$result = $apiInstance->getAccount($defaults, $defaultsKey);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
defaults | string | You can leave this empty, it's for internal use only. | [optional] |
defaultsKey | string | You can leave this empty, it's for internal use only. | [optional] |
\SynergiTech\Staffology\Model\User
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getApiKeyAccount($id): \SynergiTech\Staffology\Model\Item
Get ApiKey
<?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\AccountApi(
// 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
);
$id = 'id_example'; // string
try {
$result = $apiInstance->getApiKeyAccount($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->getApiKeyAccount: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | string |
\SynergiTech\Staffology\Model\Item
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getEmployerDefaultsAccount(): \SynergiTech\Staffology\Model\EmployerDefaults
Get EmployerDefaults
Get the EmployerDefaults for the currently authorised User.
<?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\AccountApi(
// 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
);
try {
$result = $apiInstance->getEmployerDefaultsAccount();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->getEmployerDefaultsAccount: ', $e->getMessage(), PHP_EOL;
}
This endpoint does not need any parameter.
\SynergiTech\Staffology\Model\EmployerDefaults
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getInvitationsAccount(): \SynergiTech\Staffology\Model\Item[]
Get Invitations
Returns any pending Invitations for the authorised user. If the email address isn't yet verified then the Name displayed in the Item will be the users email address instead of the company name. Invitations cannot be accepted until the email address for the user is verified.
<?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\AccountApi(
// 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
);
try {
$result = $apiInstance->getInvitationsAccount();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->getInvitationsAccount: ', $e->getMessage(), PHP_EOL;
}
This endpoint does not need any parameter.
\SynergiTech\Staffology\Model\Item[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getTenantAccount($tenantId, $key): \SynergiTech\Staffology\Model\Tenant
Get Tenant
Returns branding details for the specified tenant. This is used by the web app and is unlikely to be used by third-parties.
<?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\AccountApi(
// 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
);
$tenantId = 'tenantId_example'; // string
$key = 'key_example'; // string
try {
$result = $apiInstance->getTenantAccount($tenantId, $key);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->getTenantAccount: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
tenantId | string | [optional] | |
key | string | [optional] |
\SynergiTech\Staffology\Model\Tenant
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getUserEmployersAccount($id): \SynergiTech\Staffology\Model\EmployerItem[]
List User Employers
Returns a list of Employers that are associated to the given User
<?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\AccountApi(
// 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
);
$id = 56; // int | The Id of the user you want a list of employers for.
try {
$result = $apiInstance->getUserEmployersAccount($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->getUserEmployersAccount: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The Id of the user you want a list of employers for. | [optional] |
\SynergiTech\Staffology\Model\EmployerItem[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
listApiKeysAccount(): \SynergiTech\Staffology\Model\Item[]
List ApiKeys
<?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\AccountApi(
// 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
);
try {
$result = $apiInstance->listApiKeysAccount();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->listApiKeysAccount: ', $e->getMessage(), PHP_EOL;
}
This endpoint does not need any parameter.
\SynergiTech\Staffology\Model\Item[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
profileAccount($user): \SynergiTech\Staffology\Model\User
Update Profile
Updates your profile. Only Salutation, FirstName, LastName, JobType, JobTitle, TelephoneNumber, BusinessName, Industry, Address and DisplayPrefs fields are updated.
<?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\AccountApi(
// 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
);
$user = new \SynergiTech\Staffology\Model\User(); // \SynergiTech\Staffology\Model\User
try {
$result = $apiInstance->profileAccount($user);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->profileAccount: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
user | \SynergiTech\Staffology\Model\User | [optional] |
\SynergiTech\Staffology\Model\User
- 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]
setEmployerDefaultsAccount($employerDefaults): \SynergiTech\Staffology\Model\EmployerDefaults
Set EmployerDefaults
Set the EmployerDefaults for the currently authorised User.
<?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\AccountApi(
// 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
);
$employerDefaults = new \SynergiTech\Staffology\Model\EmployerDefaults(); // \SynergiTech\Staffology\Model\EmployerDefaults
try {
$result = $apiInstance->setEmployerDefaultsAccount($employerDefaults);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->setEmployerDefaultsAccount: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
employerDefaults | \SynergiTech\Staffology\Model\EmployerDefaults | [optional] |
\SynergiTech\Staffology\Model\EmployerDefaults
- 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]
updatePhotoAccount($file): \SynergiTech\Staffology\Model\User
Update Photo
Submit an image here and we'll upload it, resize it to 200px squared and set it as the image for your account.
<?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\AccountApi(
// 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
);
$file = '/path/to/file.txt'; // \SplFileObject
try {
$result = $apiInstance->updatePhotoAccount($file);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->updatePhotoAccount: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
file | \SplFileObject**\SplFileObject** | [optional] |
\SynergiTech\Staffology\Model\User
- Content-Type:
multipart/form-data
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
verifyAccount()
Re-send Verification Email
Users should receive an email to verify their email address when they first register or if they change their email address. However, this API endpoint can be used to re-send the email.
<?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\AccountApi(
// 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
);
try {
$apiInstance->verifyAccount();
} catch (Exception $e) {
echo 'Exception when calling AccountApi->verifyAccount: ', $e->getMessage(), PHP_EOL;
}
This endpoint does not need any parameter.
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
verifyResponseAccount($u, $k): bool
Verify Email Address
Used to process the link sent in an email to verify an email address.
<?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\AccountApi(
// 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
);
$u = 'u_example'; // string | The value from the link in the email.
$k = 'k_example'; // string | The value from the link in the email.
try {
$result = $apiInstance->verifyResponseAccount($u, $k);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->verifyResponseAccount: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
u | string | The value from the link in the email. | [optional] |
k | string | The value from the link in the email. | [optional] |
bool
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]