Live Chat

Ivinex API Documentation

Introduction

This article specifies the API for interfacing with Ivinex. If you have any problems or requests, please contact us for support.

Getting Started

Before you can make any API calls, you must first define what user will be used for the calls. The User must be an active user and have API permissions. API permissions for the User can be assigned through the group manager (for all users in a specific group), or the user manager (for a specific user).
Warning: Most problems you may encounter when using the API will be related to permissions. The user account that you are using for API calls is LIMITED by the PERMISSIONS granted to that user.

General Information

Default Record Fields: There are a few fields that are automatically generated for every record in Ivinex. As long as there is at least one record in a module, these fields are always available.
  • Created By: created_by (The username of the person who created the record.)
  • Created Date: created_date (The date the record was created.)
  • Modified By: modified_by (The username of the person who last modified the record.)
  • Modified Date: modified_date (The date the record was last modified.)
  • Record ID: collection_id (The ID of the record.)

API Calls

All calls use HTTPS or HTTP. The Base URL is: https://<siteID>.ivinex.com/API/ Where <siteID> is the name of your unique Ivinex site.
Note: This is the same URL that you would type in to access your Ivinex system with the "/API" appended to the end).
For the purpose of this guide, we will assume a siteID of "company" where "company" would be replaced with your unique Ivinex site. We will also be assuming a UserName of "user" and a Password of "password" where "user" and "password" would be replaced by your API enabled User. The following Calls are available:
  1. GetTabs
  2. GetFields
  3. GetRecords
  4. AddRecord
  5. UpdateRecord
  6. GetRelatedItems
  7. GetAllRelatedItems
  8. LinkRecords
For all API Calls, the following parameters are required:
  • UserName - UserName to login to Ivinex
  • Password - Password to login to Ivinex

GetTabs

URL: https://company.ivinex.com/API/GetTabs.php Extra Parameters: None Examples:
https://company.ivinex.com/API/GetTabs.php?UserName=user&Password=password
Returned: An XML string with the following format

GetFields

URL: https://company.ivinex.com/API/GetFields.php Extra Parameters:
  • TabID - ID of the Tab from which to get records (required)
  • FilterID - Id of the filter to use which will limit the fields (optional)
    If you want to use the FilterID option, please contact Ivinex for assistance.
Examples:
https://company.ivinex.com/API/GetFields.php?UserName=user&Password=password&TabID=1000
https://company.ivinex.com/API/GetFields.php?UserName=user&Password=password&TabID=1000&FilterID=46
Returned: An XML string with the following format

GetRecords

URL: https://company.ivinex.com/API/GetRecords.php Extra Parameters:
  • TabID - ID of the Tab from which to get records (required)
  • FilterID - Id of the filter to use which will limit the fields (optional)
  • Limit - Max number of records to return (optional)
  • Offset - Starting point of records to return (optional)
  • LookupText - Set to 'false' to return ID's instead of text (optional)
  • Criteria - Extra filtering Criteria (optional)
    • This is in the format of: <FieldName1>|<Operand1>|<Value1>^<FieldName2>|<Operand2>|<Value2>…
    • The “FieldName” can also be replaced with the “FieldID” if desired.
    • Possible values for Operands depend on the Field Type.
      • All Types - Equal, NotEqual, Contains, NotContains
      • Date Types - After, Before
The ^ acts as an "and", if you need an "or", create another call.
Examples:
https://company.ivinex.com/API/GetRecords.php?UserName=user&Password=password&TabID=1000&Criteria=first_name|Equal|Craig
https://company.ivinex.com/API/GetRecords.php?UserName=user&Password=password&TabID=1000&Criteria=first_name|Equal|Craig^last_name|NotEqual|Austin
Assuming the contact TabID = 1000, This will return a list of all the contacts with a first name of “Craig” and a last name that is NOT “Austin” Returned: An XML string with the following format

AddRecord

URL: https://company.ivinex.com/API/AddRecord.php Extra Parameters:
  • TabID - ID of the Tab from which to get records (required)
  • AlwaysLookupValues - (optional) Set to 1 or 0 (default 0). This is for certain field types (collection_id, select, radio, user).
    • This behaves as follows:
      • 0: If the value is an integer, the system will assume this is an ID> Otherwise the system will attempt to look up the ID based on the text passed in.
      • 1: The system will always lookup the ID based on the text passed in.
Post Parameters: A post parameter for each field that you would like to set in the record. None of the fields are required. Examples:
https://company.ivinex.com/API/AddRecord.php?UserName=user&Password=password&TabID=1000
https://company.ivinex.com/API/AddRecord.php?UserName=user&Password=password&TabID=1000&AlwaysLookupValues=1
Post String: &first_name= Craig&last_name=Austin Assuming the contact TabID = 1000, This will create a contact record with the first name of “Craig” and the last name of “Austin” Returned: An XML string with the following format

UpdateRecord

URL: https://company.ivinex.com/API/UpdateRecord.php Extra Parameters:
  • TabID - ID of the Tab from which to add a record (required)
  • RecordID - ID of the Record to Update (required)
Post Parameters: A post parameter for each field that you would like to set in the record. None of the fields are required. Examples:
https://company.ivinex.com/API/UpdateRecord.php?UserName=user&Password=password&TabID=1000&RecordID=101
Post String: &first_name= Craig&last_name=Austin Assuming the contact TabID = 1000, This will update contact record 101 setting the first name to “Craig” and the last name to “Austin” Returned: An XML string with the following format

GetRelatedItems

URL: https://company.ivinex.com/API/GetRelatedItems.php Extra Parameters:
  • TabID - ID of the Tab from which to get the linked records (required)
  • RecordID - ID of the Record from which to get the linked records (required)
  • TabID2 - ID of the Tab to filter links (optional)
Examples:
https://company.ivinex.com/API/GetRelatedItems.php?UserName=user&Password=password&TabID=1000&RecordID=23&TabID2=50
Assuming the contact TabID = 1000, and the Activity TabID = 50, this will return a list of activity records that are linked to the contact record with ID = 23
https://company.ivinex.com/API/GetRelatedItems.php?UserName=user&Password=password&TabID=1000&RecordID=23
Assuming the contact TabID = 1000 , this will return a list of all records (all other Tabs) that are linked to the contact record with ID = 23 Returned: An XML string with the following format

GetAllRelatedItems

This is similar to “GetRelatedItems”. The difference is that this will return all relationships between TabID and TabID2. URL: https://company.ivinex.com/API/GetAllRelatedItems.php Extra Parameters:
  • TabID - ID of the first Tab from which to get the linked records (required)
  • TabID2 - ID of the second Tab from which to get the linked records (optional)
Examples:
https://company.ivinex.com/API/GetRelatedItems.php?UserName=user&Password=password&TabID=1000&TabID2=50
Assuming the contact TabID = 1000, and the Activity TabID = 50, this will return a list of activity records that are linked to any contact record.
https://company.ivinex.com/API/GetRelatedItems.php?UserName=user&Password=password&TabID=1000
Assuming the contact TabID = 1000, this will return a list of activity records that are linked to any other records. Returned: An XML string with the following format

LinkRecords

URL: https://company.ivinex.com/API/LinkRecords.php Extra Parameters:
  • TabID1 - ID of Tab1 (required)
  • TabID2 - ID of Tab2 (required)
  • RecordID1 - ID of Record1 (required)
  • RecordID2 - ID of Record2 (required)
Examples:
https://company.ivinex.com/API/LinkRecords.php?UserName=user&Password=password&TabID1=1000&TabID2=1001&RecordID1=56&RecordID2=187
Returned: An XML string with the following format

API Example Files

To help you get started with Ivinex API calls, we have provided a zip file containing different examples. Click here to download    

Revisions

Revision Differences

11 July, 2014 @ 9:02Current Revision
Content
<h2>Introduction</h2> <h2>Introduction</h2>
This article specifies the API for interfacing with Ivinex. This article specifies the API for interfacing with Ivinex.
If you have any problems or requests, please <a title="Ivinex Support" href="http:// training.ivinex.com/ivinex- support/">contact us</a> for support. If you have any problems or requests, please <a title="Ivinex Support" href="http:// training.ivinex.com/ivinex- support/">contact us</a> for support.
 
<h2>Getting Started</h2> <h2>Getting Started</h2>
Before you can make any API calls, you must first define what user will be used for the calls. The User must be an active user and have API permissions. API permissions for the User can be assigned through the group manager (for all users in a specific group), or the user manager (for a specific user). Before you can make any API calls, you must first define what user will be used for the calls. The User must be an active user and have API permissions. API permissions for the User can be assigned through the group manager (for all users in a specific group), or the user manager (for a specific user).
< strong>Warning:</strong> Most problems you may encounter when using the API will be related to permissions. The user account that you are using for API calls is LIMITED by the PERMISSIONS granted to that user.
 
< strong>Warning:</strong> Most problems you may encounter when using the API will be related to permissions. The user account that you are using for API calls is LIMITED by the PERMISSIONS granted to that user.
< strong>Tutorial: </strong> <a title="User and Group Permissions" href="http:// training.ivinex.com/user- and-group-permissions/">User and Group Permissions</a>
 
< strong>Tutorial: </strong> <a title="User and Group Permissions" href="http:// training.ivinex.com/user- and-group-permissions/">User and Group Permissions</a>
<h3>General Information</h3> <h3>General Information</h3>
<strong>Default Record Fields: </strong>There are a few fields that are automatically generated for every record in Ivinex. As long as there is at least one record in a module, these fields are always available. <strong>Default Record Fields: </strong>There are a few fields that are automatically generated for every record in Ivinex. As long as there is at least one record in a module, these fields are always available.
<ul> <ul>
<li><strong>Created By:</strong> created_ by (The username of the person who created the record.)</li>  <li><strong>Created By:</strong> created_ by (The username of the person who created the record.)</li>
<li><strong>Created Date:</strong>  created_date[/ highlight] (The date the record was created.)</li>  <li><strong>Created Date:</strong>  [highlight]created_date[/ highlight] (The date the record was created.)</li>
<li><strong>Modified By:</strong> [highlight]modified_ by (The username of the person who last modified the record.)</li>  <li><strong>Modified By:</strong> modified_ by (The username of the person who last modified the record.)</li>
<li><strong>Modified Date:</strong>  modified_date[/ highlight] (The date the record was last modified.)</li>  <li><strong>Modified Date:</strong>  [highlight]modified_date[/ highlight] (The date the record was last modified.)</li>
<li><strong>Record ID:</strong> [highlight]collection_ id (The ID of the record.)</li>  <li><strong>Record ID:</strong> collection_ id (The ID of the record.)</li>
</ul> </ul>
 
<h2>API Calls</h2> <h2>API Calls</h2>
All calls use HTTPS or HTTP. All calls use HTTPS or HTTP.
The Base URL is: <strong>https: //&lt;siteID&gt; .ivinex.com/ API/</strong> The Base URL is: <strong>https: //&lt;siteID&gt; .ivinex.com/ API/</strong>
Where <strong>&lt;siteID&gt;</strong> is the name of <strong>your unique</strong> Ivinex site. Where <strong>&lt;siteID&gt;</strong> is the name of <strong>your unique</strong> Ivinex site.
< strong>Note:< /strong> This is the same URL that you would type in to access your Ivinex system with the "/API" appended to the end).
 
< strong>Note:< /strong> This is the same URL that you would type in to access your Ivinex system with the "/API" appended to the end).
For the purpose of this guide, we will assume a siteID of <strong>"company" </strong>where "company" would be replaced with <strong>your unique</strong> Ivinex site. For the purpose of this guide, we will assume a siteID of <strong>"company" </strong>where "company" would be replaced with <strong>your unique</strong> Ivinex site.
We will also be assuming a UserName of <strong>"user"</strong> and a Password of <strong>"password"</strong> where "user" and "password" would be replaced by <strong>your API enabled User</strong>. We will also be assuming a UserName of <strong>"user"</strong> and a Password of <strong>"password"</strong> where "user" and "password" would be replaced by <strong>your API enabled User</strong>.
The following Calls are available: The following Calls are available:
<ol> <ol>
<li><strong><span style="line-height: 13px;">GetTabs< /span></strong></li>  <li><strong><span style="line-height: 13px;">GetTabs< /span></strong></li>
<li><strong>GetFields< /strong></li>  <li><strong>GetFields< /strong></li>
<li><strong>GetRecords< /strong></li>  <li><strong>GetRecords< /strong></li>
<li><strong>AddRecord< /strong></li>  <li><strong>AddRecord< /strong></li>
<li><strong>UpdateRecord< /strong></li>  <li><strong>UpdateRecord< /strong></li>
<li><strong>GetRelatedItems< /strong></li>  <li><strong>GetRelatedItems< /strong></li>
<li><strong>GetAllRelatedItems< /strong></li>  <li><strong>GetAllRelatedItems< /strong></li>
<li><strong>LinkRecords< /strong></li>  <li><strong>LinkRecords< /strong></li>
</ol> </ol>
For all API Calls, the following parameters are required: For all API Calls, the following parameters are required:
<ul> <ul>
<li><span style="line-height: 13px;"><strong> UserName</strong> - UserName to login to Ivinex</span></li>  <li><span style="line-height: 13px;"><strong> UserName</strong> - UserName to login to Ivinex</span></li>
<li><strong>Password</strong> - Password to login to Ivinex</li>  <li><strong>Password</strong> - Password to login to Ivinex</li>
</ul> </ul>
 
<h3>GetTabs</h3> <h3>GetTabs</h3>
<strong>URL:< /strong> https: //company.ivinex.com/API/ GetTabs.php <strong>URL:< /strong> https: //company.ivinex.com/API/ GetTabs.php
<strong>Extra Parameters:</strong> None <strong>Extra Parameters:</strong> None
<strong>Examples:</strong> <strong>Examples:</strong>
https: //company.ivinex.com/API/ GetTabs.php?UserName=user&amp; Password=password
 
https: //company.ivinex.com/API/ GetTabs.php?UserName=user&amp; Password=password
<strong>Returned:</strong> An XML string with the following format <strong>Returned:</strong> An XML string with the following format
<pre class="lang:xhtml decode:true"> &lt;TabList&gt; [crayon-5e563657c2143685846801/]
&lt;Tab&gt;  
&lt;ID&gt;id&lt;/ID&gt;  
&lt;SingularName&gt; name&lt;/SingularName&gt;  
&lt;PluralName&gt; name2&lt;/PluralName&gt;  
&lt;/Tab&gt;  
  
&lt;/TabList&gt;</pre>  
 
<h3>GetFields</h3> <h3>GetFields</h3>
<strong>URL:< /strong> https: //company.ivinex.com/API/ GetFields.php <strong>URL:< /strong> https: //company.ivinex.com/API/ GetFields.php
<strong>Extra Parameters:</strong> <strong>Extra Parameters:</strong>
<ul> <ul>
<li><span style="line-height: 13px;"><strong> TabID</strong> - ID of the Tab from which to get records <strong>(required) </strong></span></li>  <li><span style="line-height: 13px;"><strong> TabID</strong> - ID of the Tab from which to get records <strong>(required) </strong></span></li>
<li><strong>FilterID</strong> - Id of the filter to use which will limit the fields (optional)  <li><strong>FilterID</strong> - Id of the filter to use which will limit the fields (optional)
If you want to use the FilterID option, please contact Ivinex for assistance.
</li>
 
If you want to use the FilterID option, please contact Ivinex for assistance.
</li>
</ul> </ul>
<strong>Examples:</strong> <strong>Examples:</strong>
https: //company.ivinex.com/API/ GetFields.php?UserName=user&amp; Password=password&amp; TabID=1000
 
https: //company.ivinex.com/API/ GetFields.php?UserName=user&amp; Password=password&amp; TabID=1000
https: //company.ivinex.com/API/ GetFields.php?UserName=user&amp; Password=password&amp;TabID= 1000&amp;FilterID=46
 
https: //company.ivinex.com/API/ GetFields.php?UserName=user&amp; Password=password&amp;TabID= 1000&amp;FilterID=46
<strong>Returned: </strong> An XML string with the following format <strong>Returned: </strong> An XML string with the following format
<pre class="lang:xhtml decode:true"> &lt;FieldList&gt; [crayon-5e563657c214d246205146/]
&lt;Field&gt;  
&lt;ID&gt;id&lt;/ID&gt;  
&lt;DisplayText&gt;Display Text&lt;/DisplayText&gt;  
&lt;FieldName&gt;Field Name&lt;/FieldName&gt;  
&lt;FieldType&gt;Field Type&lt;/FieldType&gt;  
&lt;/Field&gt;  
  
&lt;/FieldList&gt;</pre>  
 
<h3>GetRecords</h3> <h3>GetRecords</h3>
<strong>URL:< /strong> https: //company.ivinex.com/API/ GetRecords.php <strong>URL:< /strong> https: //company.ivinex.com/API/ GetRecords.php
<strong>Extra Parameters:</strong> <strong>Extra Parameters:</strong>
<ul> <ul>
<li><strong>TabID</strong> - ID of the Tab from which to get records <strong> (required)</strong></li>  <li><strong>TabID</strong> - ID of the Tab from which to get records <strong> (required)</strong></li>
<li><strong>FilterID</strong> - Id of the filter to use which will limit the fields (optional)</li>  <li><strong>FilterID</strong> - Id of the filter to use which will limit the fields (optional)</li>
<li><strong>Limit</strong> - Max number of records to return (optional)</li>  <li><strong>Limit</strong> - Max number of records to return (optional)</li>
<li><strong>Offset</strong> - Starting point of records to return (optional)</li>  <li><strong>Offset</strong> - Starting point of records to return (optional)</li>
<li><strong>LookupText</strong> - Set to 'false' to return ID's instead of text (optional)</li>  <li><strong>LookupText</strong> - Set to 'false' to return ID's instead of text (optional)</li>
<li><strong>Criteria</strong> - Extra filtering Criteria (optional)  <li><strong>Criteria</strong> - Extra filtering Criteria (optional)
<ul> <ul>
<li>This is in the format of:  <li>This is in the format of:
<strong>&lt;FieldName1&gt; |&lt;Operand1&gt; |&lt;Value1&gt; ^&lt;FieldName2&gt; |&lt;Operand2&gt; |&lt;Value2&gt; …</strong></li>  <strong>&lt;FieldName1&gt; |&lt;Operand1&gt; |&lt;Value1&gt; ^&lt;FieldName2&gt; |&lt;Operand2&gt; |&lt;Value2&gt; …</strong><strong>
  </strong></li>
<li>The “FieldName” can also be replaced with the “FieldID” if desired.</li>  <li>The “FieldName” can also be replaced with the “FieldID” if desired.</li>
<li>Possible values for Operands depend on the Field Type.  <li>Possible values for Operands depend on the Field Type.
<ul> <ul>
<li>All Types - Equal, NotEqual, Contains, NotContains</li>  <li>All Types - Equal, NotEqual, Contains, NotContains</li>
<li>Date Types - After, Before</li>  <li>Date Types - After, Before</li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
  
The ^ acts as an "and", if you need an "or", create another call.
<strong>Examples:</strong> <strong>Examples:</strong>
https: //company.ivinex.com/API/ GetRecords.php?UserName=user&amp; Password=password&amp;TabID= 1000&amp;Criteria= first_name|Equal|Craig
 
https: //company.ivinex.com/API/ GetRecords.php?UserName=user&amp; Password=password&amp;TabID= 1000&amp;Criteria= first_name|Equal|Craig
https: //company.ivinex.com/API/ GetRecords.php?UserName=user&amp; Password=password&amp;TabID= 1000&amp;Criteria= first_name|Equal|Craig^last_ name|NotEqual|Austin
 
https: //company.ivinex.com/API/ GetRecords.php?UserName=user&amp; Password=password&amp;TabID= 1000&amp;Criteria= first_name|Equal|Craig^last_ name|NotEqual|Austin
Assuming the contact TabID = 1000, This will return a list of all the contacts with a first name of “Craig” and a last name that is NOT “Austin” Assuming the contact TabID = 1000, This will return a list of all the contacts with a first name of “Craig” and a last name that is NOT “Austin”
<strong>Returned: </strong> An XML string with the following format <strong>Returned: </strong> An XML string with the following format
<pre class="lang:xhtml decode:true"> &lt;RecordList&gt;  
&lt;SyncDate&gt;current server time&lt;/SyncDate&gt; [crayon-5e563657c2150896889692/]
&lt;Record&gt;  
&lt;collection_ id&gt;id&lt;/ collection_id&gt;  
&lt;created_by&gt;created by&lt;/created_by&gt;  
…List of all fields belonging to that record  
&lt;/Record&gt;  
  
&lt;/RecordList&gt;</pre>  
 
<h3>AddRecord</h3> <h3>AddRecord</h3>
<strong>URL:< /strong> https: //company.ivinex.com/API/ AddRecord.php <strong>URL:< /strong> https: //company.ivinex.com/API/ AddRecord.php
<strong>Extra Parameters:</strong> <strong>Extra Parameters:</strong>
<ul> <ul>
<li><strong>TabID</strong> - ID of the Tab from which to get records <strong> (required)</strong></li>  <li><strong>TabID</strong> - ID of the Tab from which to get records <strong> (required)</strong></li>
<li><strong>AlwaysLookupValues</strong> - (optional) Set to 1 or 0 (default 0). This is for certain field types (collection_id, select, radio, user).  <li><strong>AlwaysLookupValues</strong> - (optional) Set to 1 or 0 (default 0). This is for certain field types (collection_id, select, radio, user).
<ul> <ul>
<li>This behaves as follows:  <li>This behaves as follows:
<ul> <ul>
<li><strong>0:</strong> If the value is an integer, the system will assume this is an ID&gt; Otherwise the system will attempt to look up the ID based on the text passed in.</li>  <li><strong>0:</strong> If the value is an integer, the system will assume this is an ID&gt; Otherwise the system will attempt to look up the ID based on the text passed in.</li>
<li><strong>1:</strong> The system will always lookup the ID based on the text passed in.</li>  <li><strong>1:</strong> The system will always lookup the ID based on the text passed in.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
<strong>Post Parameters:</strong> <strong>Post Parameters:</strong>
A post parameter for each field that you would like to set in the record. None of the fields are required. A post parameter for each field that you would like to set in the record. None of the fields are required.
<strong>Examples:</strong> <strong>Examples:</strong>
https: //company.ivinex.com/API/ AddRecord.php?UserName=user&amp; Password=password&amp; TabID=1000
 
https: //company.ivinex.com/API/ AddRecord.php?UserName=user&amp; Password=password&amp; TabID=1000
https: //company.ivinex.com/API/ AddRecord.php?UserName=user&amp; Password=password&amp;TabID= 1000&amp;AlwaysLookupValues=1
 
https: //company.ivinex.com/API/ AddRecord.php?UserName=user&amp; Password=password&amp;TabID= 1000&amp;AlwaysLookupValues=1
<strong>Post String:</strong> <strong>Post String:</strong>
&amp;first_name= Craig&amp;last_ name=Austin &amp;first_name= Craig&amp;last_ name=Austin
Assuming the contact TabID = 1000, This will create a contact record with the first name of “Craig” and the last name of “Austin” Assuming the contact TabID = 1000, This will create a contact record with the first name of “Craig” and the last name of “Austin”
<strong>Returned: </strong> An XML string with the following format <strong>Returned: </strong> An XML string with the following format
<pre class="lang:xhtml decode:true">&lt; AddRecordResult&gt;  
&lt;STATUS&gt;Success or Error&lt;/STATUS&gt;  
&lt;ID&gt;ID of the New Record&lt;/ID&gt; ---&gt; This will only be returned on success  [crayon-5e563657c2153205547033/]
&lt;/AddRecordResult&gt;</pre>  
 
<h3>UpdateRecord</h3> <h3>UpdateRecord</h3>
<strong>URL:< /strong> https: //company.ivinex.com/API/ UpdateRecord.php <strong>URL:< /strong> https: //company.ivinex.com/API/ UpdateRecord.php
<strong>Extra Parameters:</strong> <strong>Extra Parameters:</strong>
<ul> <ul>
<li><strong>TabID</strong> - ID of the Tab from which to add a record <strong>(required) </strong></li>  <li><strong>TabID</strong> - ID of the Tab from which to add a record <strong>(required) </strong></li>
<li><strong>RecordID</strong> - ID of the Record to Update <strong>(required) </strong></li>  <li><strong>RecordID</strong> - ID of the Record to Update <strong>(required) </strong></li>
</ul> </ul>
<strong>Post Parameters:</strong> <strong>Post Parameters:</strong>
A post parameter for each field that you would like to set in the record. None of the fields are required. A post parameter for each field that you would like to set in the record. None of the fields are required.
<strong>Examples:</strong> <strong>Examples:</strong>
https: //company.ivinex.com/API/ UpdateRecord.php?UserName= user&amp;Password= password&amp; TabID=1000&amp; RecordID=101
 
https: //company.ivinex.com/API/ UpdateRecord.php?UserName= user&amp;Password= password&amp; TabID=1000&amp; RecordID=101
<strong>Post String:</strong> <strong>Post String:</strong>
&amp;first_name= Craig&amp;last_ name=Austin &amp;first_name= Craig&amp;last_ name=Austin
Assuming the contact TabID = 1000, This will update contact record 101 setting the first name to “Craig” and the last name to “Austin” Assuming the contact TabID = 1000, This will update contact record 101 setting the first name to “Craig” and the last name to “Austin”
<strong>Returned:</strong> An XML string with the following format <strong>Returned:</strong> An XML string with the following format
<pre class="lang:xhtml decode:true"> &lt;UpdateRecordResult&gt; [crayon-5e563657c2156637529181/]
&lt;STATUS&gt;Success or Error&lt;/STATUS&gt;  
&lt;/UpdateRecordResult&gt;</pre>  
 
<h3>GetRelatedItems</h3> <h3>GetRelatedItems</h3>
<strong>URL:< /strong> https: //company.ivinex.com/API/ GetRelatedItems.php <strong>URL:< /strong> https: //company.ivinex.com/API/ GetRelatedItems.php
<strong>Extra Parameters:</strong> <strong>Extra Parameters:</strong>
<ul> <ul>
<li><strong>TabID</strong> - ID of the Tab from which to get the linked records <strong>(required) </strong></li>  <li><strong>TabID</strong> - ID of the Tab from which to get the linked records <strong>(required) </strong></li>
<li><strong>RecordID</strong> - ID of the Record from which to get the linked records <strong>(required) </strong></li>  <li><strong>RecordID</strong> - ID of the Record from which to get the linked records <strong>(required) </strong></li>
<li><strong>TabID2</strong> - ID of the Tab to filter links (optional)</li>  <li><strong>TabID2</strong> - ID of the Tab to filter links (optional)</li>
</ul> </ul>
<strong>Examples:</strong> <strong>Examples:</strong>
https: //company.ivinex.com/API/ GetRelatedItems.php?UserName= user&amp;Password= password&amp; TabID=1000&amp; RecordID=23&amp; TabID2=50
 
https: //company.ivinex.com/API/ GetRelatedItems.php?UserName= user&amp;Password= password&amp; TabID=1000&amp; RecordID=23&amp; TabID2=50
Assuming the contact TabID = 1000, and the Activity TabID = 50, this will return a list of activity records that are linked to the contact record with ID = 23 Assuming the contact TabID = 1000, and the Activity TabID = 50, this will return a list of activity records that are linked to the contact record with ID = 23
https: //company.ivinex.com/API/ GetRelatedItems.php?UserName= user&amp;Password= password&amp; TabID=1000&amp; RecordID=23
 
https: //company.ivinex.com/API/ GetRelatedItems.php?UserName= user&amp;Password= password&amp; TabID=1000&amp; RecordID=23
Assuming the contact TabID = 1000 , this will return a list of all records (all other Tabs) that are linked to the contact record with ID = 23 Assuming the contact TabID = 1000 , this will return a list of all records (all other Tabs) that are linked to the contact record with ID = 23
<strong>Returned:</strong> An XML string with the following format <strong>Returned:</strong> An XML string with the following format
<pre class="lang:xhtml decode:true"> &lt;LinkList&gt;  
&lt;SyncDate&gt;current server time&lt;/SyncDate&gt; [crayon-5e563657c2159784215569/]
&lt;Link&gt;  
&lt;TabID&gt; id&lt;/TabID&gt;  
&lt;RecordID&gt;record id&lt;/RecordID&gt;  
&lt;/Link&gt;  
…List of all Links  
&lt;/LinkList&gt;</pre>  
 
<h3>GetAllRelatedItems</h3> <h3>GetAllRelatedItems</h3>
This is similar to “GetRelatedItems”. The difference is that this will return all relationships between TabID and TabID2. This is similar to “GetRelatedItems”. The difference is that this will return all relationships between TabID and TabID2.
<strong>URL:< /strong> https: //company.ivinex.com/API/ GetAllRelatedItems.php <strong>URL:< /strong> https: //company.ivinex.com/API/ GetAllRelatedItems.php
<strong>Extra Parameters:</strong> <strong>Extra Parameters:</strong>
<ul> <ul>
<li><strong>TabID</strong> - ID of the first Tab from which to get the linked records <strong>(required) </strong></li>  <li><strong>TabID</strong> - ID of the first Tab from which to get the linked records <strong>(required) </strong></li>
<li><strong>TabID2</strong> - ID of the second Tab from which to get the linked records (optional)</li>  <li><strong>TabID2</strong> - ID of the second Tab from which to get the linked records (optional)</li>
</ul> </ul>
<strong>Examples:</strong> <strong>Examples:</strong>
https: //company.ivinex.com/API/ GetRelatedItems.php?UserName= user&amp;Password= password&amp; TabID=1000&amp; TabID2=50
 
https: //company.ivinex.com/API/ GetRelatedItems.php?UserName= user&amp;Password= password&amp; TabID=1000&amp; TabID2=50
Assuming the contact TabID = 1000, and the Activity TabID = 50, this will return a list of activity records that are linked to any contact record. Assuming the contact TabID = 1000, and the Activity TabID = 50, this will return a list of activity records that are linked to any contact record.
https: //company.ivinex.com/API/ GetRelatedItems.php?UserName= user&amp;Password= password&amp; TabID=1000
 
https: //company.ivinex.com/API/ GetRelatedItems.php?UserName= user&amp;Password= password&amp; TabID=1000
Assuming the contact TabID = 1000, this will return a list of activity records that are linked to any other records. Assuming the contact TabID = 1000, this will return a list of activity records that are linked to any other records.
<strong>Returned:</strong> An XML string with the following format <strong>Returned:</strong> An XML string with the following format
<pre class="lang:xhtml decode:true"> &lt;LinkList&gt;  
&lt;SyncDate&gt;current server time&lt;/SyncDate&gt; [crayon-5e563657c215b134981857/]
&lt;Link&gt;  
&lt;TabID&gt;ID of the Tab&lt;/TabID&gt;  
&lt;RecordID&gt;ID of the Record&lt;/RecordID&gt;  
&lt;TabID2&gt;ID of Tab2&lt;/TabID2&gt;  
&lt;RecordID2&gt;ID of the Record2&lt;/RecordID2&gt;  
&lt;/Link&gt;   
…List of all Links  
&lt;/LinkList&gt;</pre>  
 
<h3>LinkRecords</h3> <h3>LinkRecords</h3>
<strong>URL:< /strong> https: //company.ivinex.com/API/ LinkRecords.php <strong>URL:< /strong> https: //company.ivinex.com/API/ LinkRecords.php
<strong>Extra Parameters:</strong> <strong>Extra Parameters:</strong>
<ul> <ul>
<li><strong>TabID1</strong> - ID of Tab1 <strong>(required) </strong></li>  <li><strong>TabID1</strong> - ID of Tab1 <strong>(required) </strong></li>
<li><strong>TabID2</strong> - ID of Tab2 <strong>(required) </strong></li>  <li><strong>TabID2</strong> - ID of Tab2 <strong>(required) </strong></li>
<li><strong>RecordID1</strong> - ID of Record1 <strong>(required) </strong></li>  <li><strong>RecordID1</strong> - ID of Record1 <strong>(required) </strong></li>
<li><strong>RecordID2</strong> - ID of Record2 <strong>(required) </strong></li>  <li><strong>RecordID2</strong> - ID of Record2 <strong>(required) </strong></li>
</ul> </ul>
<strong>Examples:</strong> <strong>Examples:</strong>
https: //company.ivinex.com/API/ LinkRecords.php?UserName= user&amp;Password= password&amp; TabID1=1000&amp; TabID2=1001&amp; RecordID1=56&amp; RecordID2=187
 
https: //company.ivinex.com/API/ LinkRecords.php?UserName= user&amp;Password= password&amp; TabID1=1000&amp; TabID2=1001&amp; RecordID1=56&amp; RecordID2=187
<strong>Returned:</strong> An XML string with the following format <strong>Returned:</strong> An XML string with the following format
<pre class="lang:xhtml decode:true"> &lt;LinkRecordsResult&gt; [crayon-5e563657c215e364029274/]
&lt;STATUS&gt;Success or Error&lt;/STATUS&gt;  
&lt;/LinkRecordsResult&gt;</pre>  
 
<h2>API Example Files</h2> <h2>API Example Files</h2>
To help you get started with Ivinex API calls, we have provided a zip file containing different examples. To help you get started with Ivinex API calls, we have provided a zip file containing different examples.
Click here to download Click here to download
&nbsp; &nbsp;
&nbsp; &nbsp;

Note: Spaces may be added to comparison text to allow better line wrapping.

Tags: , ,

No comments yet.

Leave a Reply

%d bloggers like this: