There is an updated table of API calls available in the Vuture Only area of the Help Desk.  Please contact your AM if you are interested in seeing it.

 

Introduction

This document lists the InterAction API calls made by Vuture to your InterAction Application Server Web Client.

We recommend a dedicated Vuture InterAction account should be created rather than using the built-in IAADMIN account.

The Vuture InterAction Account and User Password should have sufficient permissions to make all these calls including read/write access on Folders, Contacts, Activities, and Additional Fields.

 

API Calls

The InterAction Web Client API methods we call are listed below.

Those marked with * require write access, all others require read access.

Those marked with ¹ are made asynchronously through the Vx Queue, the others are made real-time

---

Folders

 

findFolders

GET: {Interaction.Url}/findFolders?accountName={AdminAccount}&userPassword={AdminPassword}&folderClass=Marketing List

 

findFoldersForContact

GET: {Interaction.Url}/findFoldersForContact?accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}

 

findMailingLists

GET: {Interaction.Url}/findMailingLists?accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}

 

addToList * ¹

POST: {Interaction.Url}/addToList

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}&folderId={TestFolderId}

 

removeFromList * ¹

POST: {Interaction.Url}/removeFromList

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}&folderId={TestFolderId}

 

---

Contacts

 

addContact *

POST: {Interaction.Url}/addContact

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&addFirmContactOnly=true&contactVisibilityInd=3&firstName={TestContactFirstName}&lastName={TestContactLastName}&companyName={TestContactCompany}&jobTitle={TestContactJobTitle}&businessElectronicAddress={TestContactEmail}&businessPhoneNumber={TestContactPhoneNumber}

 

findContacts

GET: {Interaction.Url}/findContacts?accountName={AdminAccount}&userPassword={AdminPassword}&folderId={TestFolderId}

 

addPhone * ¹

POST: {Interaction.Url}/addPhone

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}&phoneNumber={TestContactPhoneNumber}&phoneTypeId=Phone&relationshipType=Business

 

editPhone * ¹

POST: {Interaction.Url}/editPhone

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}&phoneNumber={TestContactPhoneNumber}&phoneId={TestContactPhoneId}

 

addElectronicAddress * ¹

POST: {Interaction.Url}/addElectronicAddress

DATA:  accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}&electronicAddress={TestContactEmailAddress}&electronicAddressType=Email&relationshipType=Business

 

editElectronicAddress * ¹

POST: {Interaction.Url}/addToList

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}&electronicAddressId={TestContactEmailId}&electronicAddress={TestContactEmailAddress}

 

editListingNames * ¹

POST: {Interaction.Url}/editListingNames

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}&firstName={TestContactFirstName}&lastName={TestContactLastName}

 

findApes

POST: {Interaction.Url}/findAPEs

GET: {Interaction.Url}/findContacts?accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}

 

addAddress * ¹

POST: {Interaction.Url}/addAddress

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&maxResultCount={MaxResultCount}&contactId={ContactId}&addressType=Street&relationshipType={HomeApeType}&{AddressFields}

 

editAddress * ¹

POST: {Interaction.Url}/editAddress

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&maxResultCount={MaxResultCount}&contactId={ContactId}&addressType=Street&relationshipType={HomeApeType}&{AddressFields}

 

findUsers

POST: {Interaction.Url}/findUsers

GET: {Interaction.Url}/findUsers?accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}

 

---

Activities

 

findActivityTypes

GET: {Interaction.Url}/findActivityTypes?accountName={AdminAccount}&userPassword={AdminPassword}

 

addActivity * ¹

POST: {Interaction.Url}/addActivity

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}&activityTypeId={TestActivityTypeId}&activityDate={yyyy-MM-dd HH:mm:ss}&summary={TestActivitySummary}&notes={TestActivityNotes}

 

findActivity

GET: {Interaction.Url}/findActivity?accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}

 

editActivity * ¹

POST: {Interaction.Url}/editActivity

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}&activityId={TestActivityId}&activityDate={yyyy-MM-dd HH:mm:ss}&summary={TestActivitySummary}&notes={TestActivityNotes}

 

removeActivity *

POST: {Interaction.Url}/removeActivity

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&activityId={activityId}

 

---

Additional Fields

 

addContactAdditionalField * ¹

POST: {Interaction.Url}/addContactAdditionalField

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}&definitionId={TestAdditionalFieldId}&value={TestAdditionalFieldValue}

 

findContactAdditionalFields

GET: {Interaction.Url}/findContactAdditionalFields?accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}&definitionId={TestAdditionalFieldId}

 

removeContactAdditionalField * ¹

POST: {Interaction.Url}/removeContactAdditionalField

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&contactId={TestContactId}&definitionId={TestAdditionalFieldId}&changeDate={yyyy-MM-dd HH:mm:ss}

 

findAdditionalFields

GET: {Interaction.Url}/findAdditionalFields?accountName={AdminAccount}&userPassword={AdminPassword}&additionalFieldId={TestAdditionalFieldId}

 

findAdditionalFieldDefinitions

GET: {Interaction.Url}/findAdditionalFieldEnums?accountName={AdminAccount}&userPassword={AdminPassword}&folderId={TestFolderId}&definitionId={TestAdditionalFieldId}

 

findAdditionalFieldEnums

GET: {Interaction.Url}/findAdditionalFieldEnums?accountName={AdminAccount}&userPassword={AdminPassword}&additionalFieldId={TestAdditionalFieldId}

 

---

Relationships

 

addRelationship * ¹

POST: {Interaction.Url}/addRelationship

DATA: accountName={AdminAccount}&userPassword={AdminPassword}&contactId={ContactId}&relatedContactId=ContactId}&relationshipType=knows&strengthScale=20&relationshipDescription=Registered this contact through Vx&correspondingRelationshipDescription=Was registered through Vx

 

findRelationships

GET: {Interaction.Url}/findRelationships?accountName={AdminAccount}&userPassword={AdminPassword}&basecontactId={TestContactId}

 

---

Status

 

authenticateUser *

GET:  {Interaction.Url}/authenticateUser?accountName={AdminAccount}&userPassword={AdminPassword}

 

reloadIACache

GET: {Interaction.Url}/reloadIACache?accountName={AdminAccount}&userPassword={AdminPassword}

 

getAppServerVersion

GET: {Interaction.Url}/getAppServerVersion?accountName={AdminAccount}&userPassword={AdminPassword}