Equisoft\SDK\EquisoftConnect\LegacyContactApi

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

Method	HTTP request	Description
legacyContactAddContact()	POST /apps/api/kronos.contact.add	Create a new contact.
legacyContactDeleteContact()	POST /apps/api/kronos.contact.delete	Delete a contact.
legacyContactGetContact()	GET /apps/api/kronos.contact.get	Get complete record for a contact.
legacyContactGetContactAccessRights()	GET /apps/api/kronos.contact.getAccessRights	Get access rights for a contact.
legacyContactGetContactAccessRightsByExternalId()	GET /apps/api/kronos.contact.getAccessRightsByExternalId	Get access rights for a contact using external id.
legacyContactGetContactList()	GET /apps/api/kronos.contact.getList	Get a list of all contacts.
legacyContactGetDatagatewayUniverisContact()	GET /apps/api/kronos.contact.getDatagatewayUniverisContact	Get access rights for a contact using external key.
legacyContactPatchContact()	POST /apps/api/kronos.contact.patchContact	Patch a contact.
legacyContactUpdateContact()	POST /apps/api/kronos.contact.update	Update a contact.

`legacyContactAddContact()`

legacyContactAddContact($legacyContactContactPayloadRequest): \Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateResponse

Create a new contact.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyContactApi(
    // 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
);
$legacyContactContactPayloadRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyContactContactPayloadRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyContactContactPayloadRequest

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

Parameters

Name	Type	Description	Notes
legacyContactContactPayloadRequest	\Equisoft\SDK\EquisoftConnect\Model\LegacyContactContactPayloadRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateResponse

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`legacyContactDeleteContact()`

legacyContactDeleteContact($id): \Equisoft\SDK\EquisoftConnect\Model\LegacyResponse

Delete a contact.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyContactApi(
    // 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 | Contact identifier.

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

Parameters

Name	Type	Description	Notes
id	string	Contact identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`legacyContactGetContact()`

legacyContactGetContact($id): \Equisoft\SDK\EquisoftConnect\Model\LegacyContactGetResponse

Get complete record for a contact.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyContactApi(
    // 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 | Contact identifier.

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

Parameters

Name	Type	Description	Notes
id	string	Contact identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyContactGetResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`legacyContactGetContactAccessRights()`

legacyContactGetContactAccessRights($id): \Equisoft\SDK\EquisoftConnect\Model\LegacyContactGetAccessRightsResponse

Get access rights for a contact.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyContactApi(
    // 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 | Contact identifier.

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

Parameters

Name	Type	Description	Notes
id	string	Contact identifier.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyContactGetAccessRightsResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`legacyContactGetContactAccessRightsByExternalId()`

legacyContactGetContactAccessRightsByExternalId($externalId): \Equisoft\SDK\EquisoftConnect\Model\LegacyContactGetAccessRightsResponse

Get access rights for a contact using external id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyContactApi(
    // 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
);
$externalId = 'externalId_example'; // string | External id for the contact in the current consumer.

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

Parameters

Name	Type	Description	Notes
externalId	string	External id for the contact in the current consumer.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyContactGetAccessRightsResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`legacyContactGetContactList()`

legacyContactGetContactList($lastModifiedTime, $optionPayload): \Equisoft\SDK\EquisoftConnect\Model\LegacyContactGetListResponse

Get a list of all contacts.

This will return basic information about the contact. To get the complete record of a contact, you need to use the kronos.contact.get method.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyContactApi(
    // 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
);
$lastModifiedTime = 'lastModifiedTime_example'; // string | To Fetch all documents, which got modified / created after specified date. If the value \"auto\" is used, the last access date to this method will be used. Set the value to \"reset\" to reset the last access date.
$optionPayload = new \Equisoft\SDK\EquisoftConnect\Model\LegacyContactGetListOptions(); // LegacyContactGetListOptions | Object containing the options to filter the list of contacts.

try {
    $result = $apiInstance->legacyContactGetContactList($lastModifiedTime, $optionPayload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LegacyContactApi->legacyContactGetContactList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
lastModifiedTime	string	To Fetch all documents, which got modified / created after specified date. If the value "auto" is used, the last access date to this method will be used. Set the value to "reset" to reset the last access date.	[optional]
optionPayload	LegacyContactGetListOptions	Object containing the options to filter the list of contacts.	[optional]

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyContactGetListResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`legacyContactGetDatagatewayUniverisContact()`

legacyContactGetDatagatewayUniverisContact($externalKey): \Equisoft\SDK\EquisoftConnect\Model\LegacyContactGetResponse

Get access rights for a contact using external key.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyContactApi(
    // 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
);
$externalKey = 'externalKey_example'; // string | External key for the contact in the current consumer.

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

Parameters

Name	Type	Description	Notes
externalKey	string	External key for the contact in the current consumer.

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyContactGetResponse

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`legacyContactPatchContact()`

legacyContactPatchContact($contactId, $legacyContactPatchContactPayloadRequest): \Equisoft\SDK\EquisoftConnect\Model\LegacyContactPatchContactResponse

Patch a contact.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyContactApi(
    // 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
);
$contactId = 'contactId_example'; // string | Contact identifier.
$legacyContactPatchContactPayloadRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyContactPatchContactPayloadRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyContactPatchContactPayloadRequest

try {
    $result = $apiInstance->legacyContactPatchContact($contactId, $legacyContactPatchContactPayloadRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LegacyContactApi->legacyContactPatchContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contactId	string	Contact identifier.
legacyContactPatchContactPayloadRequest	\Equisoft\SDK\EquisoftConnect\Model\LegacyContactPatchContactPayloadRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyContactPatchContactResponse

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`legacyContactUpdateContact()`

legacyContactUpdateContact($legacyContactContactPayloadRequest): \Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateResponse

Update a contact.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\LegacyContactApi(
    // 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
);
$legacyContactContactPayloadRequest = new \Equisoft\SDK\EquisoftConnect\Model\LegacyContactContactPayloadRequest(); // \Equisoft\SDK\EquisoftConnect\Model\LegacyContactContactPayloadRequest

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

Parameters

Name	Type	Description	Notes
legacyContactContactPayloadRequest	\Equisoft\SDK\EquisoftConnect\Model\LegacyContactContactPayloadRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\LegacyAddUpdateResponse

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

LegacyContactApi.md

Latest commit

History

LegacyContactApi.md

File metadata and controls

Equisoft\SDK\EquisoftConnect\LegacyContactApi

legacyContactAddContact()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyContactDeleteContact()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyContactGetContact()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyContactGetContactAccessRights()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyContactGetContactAccessRightsByExternalId()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyContactGetContactList()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyContactGetDatagatewayUniverisContact()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyContactPatchContact()

Example

Parameters

Return type

Authorization

HTTP request headers

legacyContactUpdateContact()

Example

Parameters

Return type

Authorization

HTTP request headers

`legacyContactAddContact()`

`legacyContactDeleteContact()`

`legacyContactGetContact()`

`legacyContactGetContactAccessRights()`

`legacyContactGetContactAccessRightsByExternalId()`

`legacyContactGetContactList()`

`legacyContactGetDatagatewayUniverisContact()`

`legacyContactPatchContact()`

`legacyContactUpdateContact()`