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

Tags: , ,

No comments yet.

Leave a Reply

%d bloggers like this: