NSContactAgent - SuperOffice

Contact (company) data services.

Constructors

NSContactAgent()

NSContactAgent

Initializes a new instance of the NSContactAgent class.

Methods

AddPerson(Integer,NSPersonEntity)

Adds a person to the given contact

NSPersonEntity AddPerson(Integer contactId, NSPersonEntity newPersonEntity)

Returns: CRMScript.NetServer.NSPersonEntity - Updated person object. Example:

NSContactAgent agent;
Integer contactId;
NSPersonEntity newPersonEntity;
NSPersonEntity res = agent.AddPerson(contactId, newPersonEntity);

ChangeCountry(NSContactEntity,Integer)

Changes country regenerates the default values and localized information such as phone number and address format

NSContactEntity ChangeCountry(NSContactEntity contactEntity, Integer toCountryId)

Returns: CRMScript.NetServer.NSContactEntity

Copy(Integer,String,String,Bool)

Copies a contact. Activities and related data will be ignored

Integer Copy(Integer sourceContactId, String destinationContactName, String destinationContactDepartment, Bool copyPersons)

Returns: CRMScript.Global.Integer - ID of copied contact. Example:

NSContactAgent agent;
Integer sourceContactId;
String destinationContactName;
String destinationContactDepartment;
Bool copyPersons;
Integer res = agent.Copy(sourceContactId, destinationContactName, destinationContactDepartment, copyPersons);

CreateDefaultContactEntity()

Sets default values into a new NSContactEntity.

NSContactEntity CreateDefaultContactEntity()

Returns: CRMScript.NetServer.NSContactEntity - New ContactEntity with default values.

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSContactAgent agent;
NSContactEntity thing = agent.CreateDefaultContactEntity();
thing = agent.SaveContactEntity(thing);

CreateNewEntry(NSDuplicateEntry)

Creates a new contact based on external duplicate

Integer CreateNewEntry(NSDuplicateEntry duplicate)

Returns: CRMScript.Global.Integer - The database identity of the newly created entry. Example:

NSContactAgent agent;
NSDuplicateEntry duplicate;
Integer res = agent.CreateNewEntry(duplicate);

DeleteContactEntity(Integer)

Deletes the NSContactEntity

Void DeleteContactEntity(Integer contactEntity)

Returns: CRMScript.Global.Void Example:

NSContactAgent agent;
agent.DeleteContactEntity(123);

DeleteExpired()

Triggers deletion of contacts (companies) that has been (soft) deleted and have timed out the expiry period (the SoftDeleteRetention preference).

Void DeleteExpired()

Returns: CRMScript.Global.Void

GetAddress(Integer)

Gets a contact’s localized addressGets the contact’s localized address

LocalizedField[][]GetAddress(Integer contact Id)

Returns: CRMScript.NetServer.LocalizedField[][] Example:

NSContactAgent agent;
Integer contactId;
NSAddress res = agent.GetAddress(contactId);

GetAddressByCountry(Integer,Integer)

Gets a contact’s localized addressGets the contact’s localized address

LocalizedField[][] GetAddressByCountry(Integer contactId, Integer countryId)

Returns: CRMScript.NetServer.LocalizedField[][] Example:

NSContactAgent agent;
Integer contactId;
Integer countryId;
NSAddress res = agent.GetAddressByCountry(contactId, countryId);

GetContact(Integer)

Gets an NSContact object.

NSContact GetContact(Integer contactId)

Returns: CRMScript.NetServer.NSContact Example:

NSContactAgent agent;
NSContact thing = agent.GetContact(123);

GetContactEntity(Integer)

Gets an NSContactEntity object.

NSContactEntity GetContactEntity(Integer contactEntityId)

Returns: CRMScript.NetServer.NSContactEntity Example:

NSContactAgent agent;
NSContactEntity thing = agent.GetContactEntity(123);

GetContactList(Integer[])

Gets an array of Contact objects.

NSContact[] GetContactList(Integer[] contactIds)

Returns: CRMScript.NetServer.NSContact[] - Array of NSContact. Example:

Integer[] ids;
NSContactAgent agent;
agent.GetContactList(ids);

GetContactSummary(Integer,Integer)

Gets summary of contact and its recent activity.

NSContactSummary GetContactSummary(Integer contactId, Integer limit)

Returns: CRMScript.NetServer.NSContactSummary - Summary of contact, with recent requests, sales, follow-ups, chats. Example:

NSContactAgent agent;
Integer contactId;
Integer limit;
NSContactSummary res = agent.GetContactSummary(contactId, limit);

GetContactWithPersons(Integer)

Returns the contact with all the contact persons belonging to the contact

NSContactEntity GetContactWithPersons(Integer contactId)

Returns: CRMScript.NetServer.NSContactEntity - ContactEntity with all data and persons. Example:

NSContactAgent agent;
Integer contactId;
NSContactEntity res = agent.GetContactWithPersons(contactId);

GetDuplicateRules()

Retrieves all available duplicate rules for contact

NSDuplicateRule[] GetDuplicateRules()

Returns: CRMScript.NetServer.NSDuplicateRule[] - All available duplicate rules. Example:

NSContactAgent agent;
NSDuplicateRule[] res = agent.GetDuplicateRules();

GetDuplicates(String)

Gets duplicates (exact or similar in the database) based on the name

NSDuplicateEntry[] GetDuplicates(String name)

Returns: CRMScript.NetServer.NSDuplicateEntry[] - Any records matching the specified name. Example:

NSContactAgent agent;
String name;
NSDuplicateEntry[] res = agent.GetDuplicates(name);

GetMyActiveContacts(DateTime,Integer[],Integer)

Returns the contacts where there has been activity since activityStartTime.

NSContactActivity[] GetMyActiveContacts(DateTime activityStartTime, Integer[] contactCategories, Integer actionType)

Returns: CRMScript.NetServer.NSContactActivity[] - Array of contacts where there have been activity in the period.

If activityStartTime is larger than the current date, all contacts with activity since the last log-out are returned. The result set can be filtered by category and action type.

Example:

NSContactAgent agent;
DateTime activityStartTime;
Integer[] contactCategories;
Integer actionType;
NSContactActivity[] res = agent.GetMyActiveContacts(activityStartTime, contactCategories, actionType);

GetMyBizCard()

Returns all data needed to display the logged on person’s business card (company, person, and company interest data).

NSContactEntity GetMyBizCard()

Returns: CRMScript.NetServer.NSContactEntity - The contact object with persons and interests. Example:

NSContactAgent agent;
NSContactEntity res = agent.GetMyBizCard();

GetMyContact()

Gets the contact belonging to the currently logged-on user.

NSContactEntity GetMyContact()

Returns: CRMScript.NetServer.NSContactEntity Example:

NSContactAgent agent;
NSContactEntity res = agent.GetMyContact();

GetMyContacts()

Gets the contacts where the user currently logged in is set as contact owner.

NSContact[] GetMyContacts()

Returns: CRMScript.NetServer.NSContact[] - The contact. Example:

NSContactAgent agent;
NSContact[] res = agent.GetMyContacts();

GetMyRecentContacts(Integer)

Returns a set of initial contacts.

NSContact[] GetMyRecentContacts(Integer sourceType)

Returns: CRMScript.NetServer.NSContact[] - Array of contacts.

This could be the contacts in a favorites selection, the history list, the diary, or from all sources. If retrieved from the diary it will get appointments for the current and the next day.

Example:

NSContactAgent agent;
Integer sourceType;
NSContact[] res = agent.GetMyRecentContacts(sourceType);

GetNameDepartmentDuplicates(String,String)

Gets duplicates based on the contact name and department

NSDuplicateEntry[] GetNameDepartmentDuplicates(String name, String department)

Returns: CRMScript.NetServer.NSDuplicateEntry[] - Any records matching the specified name and department. Example:

NSContactAgent agent;
String name;
String department;
NSDuplicateEntry[] res = agent.GetNameDepartmentDuplicates(name, department);

GetPersons(Integer)

Returns an array of all the contact persons for the company card.

NSPerson[] GetPersons(Integer contactId)

Returns: CRMScript.NetServer.NSPerson[] - Array of Persons. Example:

NSContactAgent agent;
Integer contactId;
NSPerson[] res = agent.GetPersons(contactId);

GetQuoteVersionAddresses(Integer)

Gets the associated billing and invoice quote version addresses.

NSAddress[] GetQuoteVersionAddresses(Integer quoteVersionId)

Returns: CRMScript.NetServer.NSAddress[] - The quote version addresses. Invoice and billing address, in that order.

These addresses might be address on the contact, or a custom address.

Example:

NSContactAgent agent;
Integer quoteVersionId;
NSAddress[] res = agent.GetQuoteVersionAddresses(quoteVersionId);

IsNumberValid(Integer,String)

Checks if the number is unique or required. The setting is configured from admin under system options.

Bool IsNumberValid(Integer contactId, String number)

Returns: CRMScript.Global.Bool

Merge(Integer,Integer,Bool,Bool)

Merges two contacts. The destination contact will remain.

Void Merge(Integer sourceContactId, Integer destinationContactId, Bool mergeIdenticalPersons, Bool replaceEmptyFieldsOnDestination)

Returns: CRMScript.Global.Void

SaveContactEntity(NSContactEntity)

Updates the existing NSContactEntity or creates a new NSContactEntity if the ID parameter is 0.

NSContactEntity SaveContactEntity(NSContactEntity contactEntityId)

Returns: CRMScript.NetServer.NSContactEntity - The new or updated NSContactEntity. Example:

NSContact  agent;
NSContactEntity thing = agent.CreateDefaultContactEntity();
thing = agent.SaveContactEntity(thing);

SaveQuoteVersionAddress(Integer,NSAddress,Integer,Integer)

Saves a custom quote version address.

NSAddress SaveQuoteVersionAddress(Integer quoteVersionId, NSAddress address, Integer addressType, Integer countryId)

Returns: CRMScript.NetServer.NSAddress - The saved addresses. Example:

NSContactAgent agent;
Integer quoteVersionId;
NSAddress address;
Integer addressType;
Integer countryId;
NSAddress res = agent.SaveQuoteVersionAddress(quoteVersionId, address, addressType, countryId);

SetDuplicateRulesStatus(NSDuplicateRule[])

Sets which duplicate rules should be active or not

Void SetDuplicateRulesStatus(NSDuplicateRule[] rules)

Returns: CRMScript.Global.Void

Undelete(Integer)

This entity supports Soft Delete. Call this method to Undelete a previously soft-deleted record

Void Undelete(Integer id)

Returns: CRMScript.Global.Void Example:

NSContactAgent agent;
Integer id;
agent.Undelete(id);

ValidateContactEntity(NSContactEntity)

Checks that entity is ready for saving, return error messages by field.

Map ValidateContactEntity(NSContactEntity contactEntity)

Returns: CRMScript.Native.Map Example:

NSContactAgent agent;
NSContactEntity contactEntity;
Map res = agent.ValidateContactEntity(contactEntity);

​Constructors

​NSContactAgent()

​Methods

​AddPerson(Integer,NSPersonEntity)

​ChangeCountry(NSContactEntity,Integer)

​Copy(Integer,String,String,Bool)

​CreateDefaultContactEntity()

​CreateNewEntry(NSDuplicateEntry)

​DeleteContactEntity(Integer)

​DeleteExpired()

​GetAddress(Integer)

​GetAddressByCountry(Integer,Integer)

​GetContact(Integer)

​GetContactEntity(Integer)

​GetContactList(Integer[])

​GetContactSummary(Integer,Integer)

​GetContactWithPersons(Integer)

​GetDuplicateRules()

​GetDuplicates(String)

​GetMyActiveContacts(DateTime,Integer[],Integer)

​GetMyBizCard()

​GetMyContact()

​GetMyContacts()

​GetMyRecentContacts(Integer)

​GetNameDepartmentDuplicates(String,String)

​GetPersons(Integer)

​GetQuoteVersionAddresses(Integer)

​IsNumberValid(Integer,String)

​Merge(Integer,Integer,Bool,Bool)

​SaveContactEntity(NSContactEntity)

​SaveQuoteVersionAddress(Integer,NSAddress,Integer,Integer)

​SetDuplicateRulesStatus(NSDuplicateRule[])

​Undelete(Integer)

​ValidateContactEntity(NSContactEntity)

Constructors

NSContactAgent()

Methods

AddPerson(Integer,NSPersonEntity)

ChangeCountry(NSContactEntity,Integer)

Copy(Integer,String,String,Bool)

CreateDefaultContactEntity()

CreateNewEntry(NSDuplicateEntry)

DeleteContactEntity(Integer)

DeleteExpired()

GetAddress(Integer)

GetAddressByCountry(Integer,Integer)

GetContact(Integer)

GetContactEntity(Integer)

GetContactList(Integer[])

GetContactSummary(Integer,Integer)

GetContactWithPersons(Integer)

GetDuplicateRules()

GetDuplicates(String)

GetMyActiveContacts(DateTime,Integer[],Integer)

GetMyBizCard()

GetMyContact()

GetMyContacts()

GetMyRecentContacts(Integer)

GetNameDepartmentDuplicates(String,String)

GetPersons(Integer)

GetQuoteVersionAddresses(Integer)

IsNumberValid(Integer,String)

Merge(Integer,Integer,Bool,Bool)

SaveContactEntity(NSContactEntity)

SaveQuoteVersionAddress(Integer,NSAddress,Integer,Integer)

SetDuplicateRulesStatus(NSDuplicateRule[])

Undelete(Integer)

ValidateContactEntity(NSContactEntity)