Troi\ContactsApi

All URIs are relative to https://demo.troi.software/api/v2/rest, except if the operation defines another base path.

Method	HTTP request	Description
contactsGet()	GET /contacts	Fetch all contacts
contactsIdDelete()	DELETE /contacts/{id}	Delete contact
contactsIdGet()	GET /contacts/{id}	Fetch contact for the given ID
contactsIdPut()	PUT /contacts/{id}	Update contact
contactsPost()	POST /contacts	Save contact

`contactsGet()`

contactsGet($sync_item, $from, $size, $since, $favorites_only, $contact_type, $search, $search_field, $with_custom_fields, $parent_id, $is_associated_with_customer, $only_inactive, $external_id): \Troi\Model\ApiContact[]

Fetch all contacts

Example

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


// Configure HTTP basic authorization: basicAuth
$config = Troi\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Troi\Api\ContactsApi(
    // 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
);
$sync_item = false; // bool | Fetch Contacts and return them as Sync Item
$from = 0; // int | Fetch Contacts from the given ID, use togehter with \"from\"
$size = 100; // int | Fetch Contacts for the given size use together with \"size\"
$since = 0; // string | Fetch Contacts for the given date time (only items modified since ETag will be returned)
$favorites_only = true; // bool | Fetch favorites Contacts only
$contact_type = ApiContact:Person; // string | Fetch Contacts for the given Contact Type
$search = Troi; // string | Fetch Contacts for the given Search Term
$search_field = 'search_field_example'; // string | Fetch Contacts for the given Search Field  single value: searchField={\"categoryId\":392}  multiple values: searchField={\"categoryId\":[392,396]}  available search options: `categoryId` - string|array `firstName` - string `middleName` - string `lastName` - string `fullName` - string `privateEmail` - string `officeEmail` - string `companyEmail` - string `isDeleted` - bool
$with_custom_fields = 1; // int | Fetch Contacts for the given with Custom Field
$parent_id = 1; // int | Fetch Contacts for the given parent ID
$is_associated_with_customer = false; // bool | show all contacts that associated with some customer
$only_inactive = false; // bool | show all inactive contacts
$external_id = 12345678-90AB-CDEF-1234-567890ABCDEF; // string | <PUT SOME DESCRIPTION>

try {
    $result = $apiInstance->contactsGet($sync_item, $from, $size, $since, $favorites_only, $contact_type, $search, $search_field, $with_custom_fields, $parent_id, $is_associated_with_customer, $only_inactive, $external_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
sync_item	bool	Fetch Contacts and return them as Sync Item	[optional]
from	int	Fetch Contacts from the given ID, use togehter with "from"	[optional]
size	int	Fetch Contacts for the given size use together with "size"	[optional]
since	string	Fetch Contacts for the given date time (only items modified since ETag will be returned)	[optional]
favorites_only	bool	Fetch favorites Contacts only	[optional]
contact_type	string	Fetch Contacts for the given Contact Type	[optional]
search	string	Fetch Contacts for the given Search Term	[optional]
search_field	string	Fetch Contacts for the given Search Field single value: searchField={"categoryId":392} multiple values: searchField={"categoryId":[392,396]} available search options: `categoryId` - string	array `firstName` - string `middleName` - string `lastName` - string `fullName` - string `privateEmail` - string `officeEmail` - string `companyEmail` - string `isDeleted` - bool
with_custom_fields	int	Fetch Contacts for the given with Custom Field	[optional]
parent_id	int	Fetch Contacts for the given parent ID	[optional]
is_associated_with_customer	bool	show all contacts that associated with some customer	[optional]
only_inactive	bool	show all inactive contacts	[optional]
external_id	string	<PUT SOME DESCRIPTION>	[optional]

Return type

\Troi\Model\ApiContact[]

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`contactsIdDelete()`

contactsIdDelete($id): int

Delete contact

Example

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


// Configure HTTP basic authorization: basicAuth
$config = Troi\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Troi\Api\ContactsApi(
    // 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 = 1; // int | Contact ID

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

Parameters

Name	Type	Description	Notes
id	int	Contact ID

Return type

int

Authorization

basicAuth

HTTP request headers

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

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

`contactsIdGet()`

contactsIdGet($id): \Troi\Model\ApiContact

Fetch contact for the given ID

Example

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


// Configure HTTP basic authorization: basicAuth
$config = Troi\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Troi\Api\ContactsApi(
    // 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 = 1; // int | Fetch contact for the given ID

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

Parameters

Name	Type	Description	Notes
id	int	Fetch contact for the given ID

Return type

\Troi\Model\ApiContact

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`contactsIdPut()`

contactsIdPut($id, $api_contact): \Troi\Model\ApiSyncItem[]

Update contact

Example

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


// Configure HTTP basic authorization: basicAuth
$config = Troi\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Troi\Api\ContactsApi(
    // 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 = 1; // int | Contact ID
$api_contact = new \Troi\Model\ApiContact(); // \Troi\Model\ApiContact

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

Parameters

Name	Type	Description	Notes
id	int	Contact ID
api_contact	\Troi\Model\ApiContact

Return type

\Troi\Model\ApiSyncItem[]

Authorization

basicAuth

HTTP request headers

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

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

`contactsPost()`

contactsPost($contacts_post_request): \Troi\Model\ApiSyncItem[]

Save contact

Example

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


// Configure HTTP basic authorization: basicAuth
$config = Troi\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Troi\Api\ContactsApi(
    // 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
);
$contacts_post_request = new \Troi\Model\ContactsPostRequest(); // \Troi\Model\ContactsPostRequest

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

Parameters

Name	Type	Description	Notes
contacts_post_request	\Troi\Model\ContactsPostRequest

Return type

\Troi\Model\ApiSyncItem[]

Authorization

basicAuth

HTTP request headers

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ContactsApi.md

ContactsApi.md

Troi\ContactsApi

`contactsGet()`

Example

Parameters

Return type

Authorization

HTTP request headers

`contactsIdDelete()`

Example

Parameters

Return type

Authorization

HTTP request headers

`contactsIdGet()`

Example

Parameters

Return type

Authorization

HTTP request headers

`contactsIdPut()`

Example

Parameters

Return type

Authorization

HTTP request headers

`contactsPost()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

ContactsApi.md

Latest commit

History

ContactsApi.md

File metadata and controls

Troi\ContactsApi

contactsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

contactsIdDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

contactsIdGet()

Example

Parameters

Return type

Authorization

HTTP request headers

contactsIdPut()

Example

Parameters

Return type

Authorization

HTTP request headers

contactsPost()

Example

Parameters

Return type

Authorization

HTTP request headers

`contactsGet()`

`contactsIdDelete()`

`contactsIdGet()`

`contactsIdPut()`

`contactsPost()`