NSPersonAgent - SuperOffice

Person data services.

Constructors

NSPersonAgent()

NSPersonAgent

Person data services.

Methods

AddBounce(String)

Adds a bounce count on the email address if it exists

Void AddBounce(String emailAddress)

Returns: CRMScript.Global.Void

AddBounceWithCount(String,Integer)

Adds a number of bounce counts on the email address if it exists

Void AddBounceWithCount(String emailAddress, Integer counts)

Returns: CRMScript.Global.Void

AddEmailAddressToPerson(Integer,String,Bool)

Sets the primary email address on person, possibly re-ranking email addresses accordingly.

Void AddEmailAddressToPerson(Integer personId, String emailAddress, Bool setAsPrimaryEmail)

Returns: CRMScript.Global.Void

ChangeCountry(NSPersonEntity,Integer)

Changes country and regenerates the default values and localized information such as phone number and address format for this entity.

NSPersonEntity ChangeCountry(NSPersonEntity personEntity, Integer toCountryId)

Returns: CRMScript.NetServer.NSPersonEntity Example:

NSPersonAgent agent;
NSPersonEntity personEntity;
Integer toCountryId;
NSPersonEntity res = agent.ChangeCountry(personEntity, toCountryId);

ChangePersonRank(Integer,Bool)

Moves one person up or down in the ranking in the Person Archive, if possible. Corresponds to the move up/move down functions in the person archive in the contact panel.

Integer ChangePersonRank(Integer personId, Bool moveUp)

Returns: CRMScript.Global.Integer

The person record that has rank = 1 is the primary contact for a company, and is the one used in situations where no person has been explicitly chosen (such as in selections).This method always affects two records.

Example:

NSPersonAgent agent;
Integer personId;
Bool moveUp;
Integer res = agent.ChangePersonRank(personId, moveUp);

CheckTemporaryKey(String)

Checks a temporary key for validity, and in case it is valid, return its domain, targetId and personId

NSTemporaryKeyInfo CheckTemporaryKey(String temporaryKey)

Returns: CRMScript.NetServer.NSTemporaryKeyInfo Example:

NSPersonAgent agent;
String temporaryKey;
NSTemporaryKeyInfo res = agent.CheckTemporaryKey(temporaryKey);

CreateDefaultByContactId(Integer)

Creates an NSPersonEntity with default values based on the contactId.

NSPersonEntity CreateDefaultByContactId(Integer contactId)

Returns: CRMScript.NetServer.NSPersonEntity

CreateDefaultConsentPerson()

Sets default values into a new NSConsentPerson.

NSConsentPerson CreateDefaultConsentPerson()

Returns: CRMScript.NetServer.NSConsentPerson - A new NSConsentPerson with default values.

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

Example:

NSPersonAgent agent;
NSConsentPerson thing = agent.CreateDefaultConsentPerson();
thing = agent.SaveConsentPerson(thing);

CreateDefaultFromCredential(Integer,String,String,String)

Creates an NSPersonEntity with default values based on the contactId and credentials.

NSPersonEntity CreateDefaultFromCredential(Integer contactId, String credentialType, String credentialValue, String credentialDisplayValue)

Returns: CRMScript.NetServer.NSPersonEntity

CreateDefaultPersonEntity()

Sets default values into a new NSPersonEntity.

NSPersonEntity CreateDefaultPersonEntity()

Returns: CRMScript.NetServer.NSPersonEntity - A new NSPersonEntity with default values.

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

Example:

NSPersonAgent agent;
NSPersonEntity thing = agent.CreateDefaultPersonEntity();
thing = agent.SavePersonEntity(thing);

CreateTemporaryKey(Integer,Integer,Integer)

Creates a temporary key in the database from the given parameters and return the key string. Used for temporary keys for accessing customer centric functionality, such as UpdateSubscriptions.

String CreateTemporaryKey(Integer domain, Integer targetId, Integer personId, DateTime expires)

Returns: CRMScript.Global.String Example:

NSPersonAgent agent;
Integer domain;
Integer targetId;
Integer personId;
DateTime expires;
String res = agent.CreateTemporaryKey(domain, targetId, personId, expires);

DeleteConsentPerson(Integer)

Deletes the NSConsentPerson

DeleteConsentPerson(Integer consentPerson)

Returns: CRMScript.Global.Void Example:

NSPersonAgent agent;
agent.DeleteConsentPerson(123);

DeleteExpired()

Trigger deletion of persons that has been (soft) deleted and have timed out the expiry period (the SoftDeleteRetention preference).

Void DeleteExpired()

Returns: CRMScript.Global.Void

DeletePersonEntity(Integer)

Deletes the NSPersonEntity

DeletePersonEntity(Integer personEntity)

Returns: CRMScript.Global.Void Example:

NSPersonAgent agent;
agent.DeletePersonEntity(123);

DeleteTemporaryKeysOfDomain(Integer,Integer)

Deletes all temporary keys for a given domain and person

Void DeleteTemporaryKeysOfDomain(Integer domain, Integer personId)

Returns: CRMScript.Global.Void

GetAddress(Integer)

Gets the person’s localized addressGets the person’s localized address.

NSLocalizedField[][] GetAddress(Integer personId)

Returns: CRMScript.NetServer.NSLocalizedField[][] - The address. Example:

NSPersonAgent agent;
Integer personId;
NSAddress res = agent.GetAddress(personId);

GetAddressByCountry(Integer,Integer)

Gets the person’s localized addressGets the person’s localized address.

NSLocalizedField[][]GetAddressByCountry(Integer personId, Integer countryId)

Returns: CRMScript.NetServer.NSLocalizedField[][] - The address. Example:

NSPersonAgent agent;
Integer personId;
Integer countryId;
NSAddress res = agent.GetAddressByCountry(personId, countryId);

GetBestSoLanguageForTemplate(Integer,Integer)

Gets the best language for this person on this template

String GetBestSoLanguageForTemplate(Integer personId, Integer templateId)

Returns: CRMScript.Global.String Example:

NSPersonAgent agent;
Integer personId;
Integer templateId;
String res = agent.GetBestSoLanguageForTemplate(personId, templateId);

GetColleagues()

Gets the persons working in the same company as the logged-on user.

NSPerson[] GetColleagues()

Returns: CRMScript.NetServer.NSPerson[] Example:

NSPersonAgent agent;
NSPerson[] res = agent.GetColleagues();

GetColleaguesByDepartment(Integer)

Gets the persons working in a specific department in the same company as the logged-on user

NSPerson[] GetColleaguesByDepartment(Integer departmentId)

Returns: CRMScript.NetServer.NSPerson[]

Departments can be retrieved with the PhoneList.DepartmentList service.

Example:

NSPersonAgent agent;
Integer departmentId;
NSPerson[] res = agent.GetColleaguesByDepartment(departmentId);

GetColleaguesBySource(Integer,Integer)

Gets the persons working in the same company as the logged-on user.

NSPerson[] GetColleaguesBySource(Integer sourceType, Integer count)

Returns: CRMScript.NetServer.NSPerson[]

The list of persons could be retrieved from the history list, the diary view list, or from all sources.

Example:

NSPersonAgent agent;
Integer sourceType;
Integer count;
NSPerson[] res = agent.GetColleaguesBySource(sourceType, count);

GetConsentInfos(Integer)

Gets all consent information for a given person. May include withdrawn consents (check)

NSConsentInfo[] GetConsentInfos(Integer personId)

Returns: CRMScript.NetServer.NSConsentInfo[] Example:

NSPersonAgent agent;
Integer personId;
NSConsentInfo[] res = agent.GetConsentInfos(personId);

GetConsentPerson(Integer)

Gets an NSConsentPerson object.

NSConsentPerson GetConsentPerson(Integer consentPersonId)

Returns: CRMScript.NetServer.NSConsentPerson Example:

NSPersonAgent agent;
NSConsentPerson thing = agent.GetConsentPerson(123);

GetMyOwner()

Gets the owner of the logged in person.

NSPerson GetMyOwner()

Returns: CRMScript.NetServer.NSPerson Example:

NSPersonAgent agent;
NSPerson res = agent.GetMyOwner();

GetMyPerson()

Gets the person info belonging to the currently logged-on user.

NSPersonEntity GetMyPerson()

Returns: CRMScript.NetServer.NSPersonEntity Example:

NSPersonAgent agent;
NSPersonEntity res = agent.GetMyPerson();

GetOwnerOnPersonId(Integer)

Gets the owner of the person by ID.

NSPerson GetOwnerOnPersonId(Integer personId)

Returns: CRMScript.NetServer.NSPerson Example:

NSPersonAgent agent;
Integer personId;
NSPerson res = agent.GetOwnerOnPersonId(personId);

GetPerson(Integer)

Gets an NSPerson object.

NSPerson GetPerson(Integer personId)

Returns: CRMScript.NetServer.NSPerson Example:

NSPersonAgent agent;
NSPerson thing = agent.GetPerson(123);

GetPersonEntity(Integer)

Gets an NSPersonEntity object.

NSPersonEntity GetPersonEntity(Integer personEntityId)

Returns: CRMScript.NetServer.NSPersonEntity Example:

NSPersonAgent agent;
NSPersonEntity thing = agent.GetPersonEntity(123);

GetPersonImage(Integer)

Returns the person image that is displayed in the CRM application.

NSImage GetPersonImage(Integer personId)

Returns: CRMScript.NetServer.NSImage Example:

NSPersonAgent agent;
Integer personId;
NSImage res = agent.GetPersonImage(personId);

GetPersonList(Integer[])

Gets an array of NSPerson objects.

NSPerson[] GetPersonList(Integer[]  personIds)

Returns: CRMScript.NetServer.NSPerson[] Example:

Integer[] ids;
NSPersonAgent agent;
agent.GetPersonList(ids);

GetPersonsFromContact(Integer)

Returns all the persons belonging to a contact.

NSPerson[] GetPersonsFromContact(Integer contactId)

Returns: CRMScript.NetServer.NSPerson[] Example:

NSPersonAgent agent;
Integer contactId;
NSPerson[] res = agent.GetPersonsFromContact(contactId);

GetPersonsFromProject(Integer)

Returns all the persons belonging to a project.

NSPerson[] GetPersonsFromProject(Integer projectId)

Returns: CRMScript.NetServer.NSPerson[] Example:

NSPersonAgent agent;
Integer projectId;
NSPerson[] res = agent.GetPersonsFromProject(projectId);

GetPersonSummary(Integer,Integer)

Gets summary of person and recent activity.

NSPersonSummary GetPersonSummary(Integer personId, Integer limit)

Returns: CRMScript.NetServer.NSPersonSummary Example:

NSPersonAgent agent;
Integer personId;
Integer limit;
NSPersonSummary res = agent.GetPersonSummary(personId, limit);

GetPhones(Integer)

Returns all phones that belong to a person, ordered by the phone type.

NSEntityElement[] GetPhones(Integer personId)

Returns: CRMScript.NetServer.NSEntityElement[] Example:

NSPersonAgent agent;
Integer personId;
NSEntityElement[] res = agent.GetPhones(personId);

GetSalesRep(String,String,String,String,String)

Returns the sales representative for an external user.

NSPersonEntity GetSalesRep(String contactName, String personFirstname, String personLastname, String emailAddress, String phoneNumber)

Returns: CRMScript.NetServer.NSPersonEntity

If this method is accessed with anonymous authentication the external user is recognized by contact and name, or by email, or phone number.If the external user is recognized as an CRM5 user (internal or external) the input fields can be left blank.

Example:

NSPersonAgent agent;
String contactName;
String personFirstname;
String personLastname;
String emailAddress;
String phoneNumber;
NSPersonEntity res = agent.GetSalesRep(contactName, personFirstname, personLastname, emailAddress, phoneNumber);

HasConsent(Integer,String)

Checks if consent has been given by a specified person, for a specific purpose. Withdraw consents return FALSE.

Bool HasConsent(Integer personId, String purpose)

Returns: CRMScript.Global.Bool Example:

NSPersonAgent agent;
Integer personId;
String purpose;
Bool res = agent.HasConsent(personId, purpose);

IsNumberValid(Integer,String)

Checks if the number is unique or required.

Bool IsNumberValid(Integer contactId, String number)

Returns: CRMScript.Global.Bool

The setting is configured from admin under system options.

Example:

NSPersonAgent agent;
Integer contactId;
String number;
Bool res = agent.IsNumberValid(contactId, number);

Merge(Integer,Integer,DateTime,Bool,Bool)

Merges two persons. The destination person will remain. You must specify the date after which activities will be moved along with the person.

Void Merge(Integer sourcePersonId, Integer destinationPersonId, DateTime moveAfterDate, Bool deleteSource, Bool replaceEmptyFieldsOnDestination)

Returns: CRMScript.Global.Void

Move(Integer,Integer,DateTime)

Moves a person to a specified contact. You must specify the date after which activities will be moved along with the person.

Void Move(Integer personId, Integer destinationContactId, DateTime moveAfterDate)

Returns: CRMScript.Global.Void

NormalizeRanks(Integer)

Normalize the ranks for all persons that belong to a contact. This means that the persons will be sorted according to their current rank values, and the ranks will be made monotonically increasing from 1.

Bool NormalizeRanks(Integer contactId)

Returns: CRMScript.Global.Bool Example:

NSPersonAgent agent;
Integer contactId;
Bool res = agent.NormalizeRanks(contactId);

RemoveConsent(Integer,String)

Turns off consent for a specified person and purpose.

Void RemoveConsent(Integer personId, String purpose)

Returns: CRMScript.Global.Void

ResolvePersonFromInfo(Integer,String,String[],String[])

Gets a person from the provided information. If the person does not exist, it will be created on demand.

NSResolvedPerson ResolvePersonFromInfo(Integer contactId, String personName, String[] phoneNumbers, String[] emails)

Returns: CRMScript.NetServer.NSResolvedPerson Example:

NSPersonAgent agent;
Integer contactId;
String personName;
String[] phoneNumbers;
String[] emails;
NSResolvedPerson res = agent.ResolvePersonFromInfo(contactId, personName, phoneNumbers, emails);

SaveConsentPerson(NSConsentPerson)

Updates the existing NSConsentPerson or creates a new NSConsentPerson if the id parameter is 0

NSConsentPerson SaveConsentPerson(NSConsentPerson consentPerson)

Returns: CRMScript.NetServer.NSConsentPerson Example:

NSPerson  agent;
NSConsentPerson thing = agent.CreateDefaultConsentPerson();
thing = agent.SaveConsentPerson(thing);

SavePersonEntity(NSPersonEntity)

Creates or updates an NSPersonEntityUpdates the existing NSPersonEntity or creates a new NSPersonEntity if the ID parameter is 0.

NSPersonEntity SavePersonEntity()

Returns: CRMScript.NetServer.NSPersonEntity Example:

NSPerson  agent;
NSPersonEntity thing = agent.CreateDefaultPersonEntity();
thing = agent.SavePersonEntity(thing);

SendConsentConfirmationEmail(Integer,String,Integer,Integer,String)

Sends a confirmation email to the provided person, email address (id), using the document template

Void SendConsentConfirmationEmail(Integer personId, String emailAddress, Integer emailTemplateId, Integer cultureLcidId, String subject)

Returns: CRMScript.Global.Void

SetConsent(Integer,String,String,String,String)

Sets a specified type of consent on the person.

Void SetConsent(Integer personId, String purpose, String source, String legalBase, String comment)

Returns: CRMScript.Global.Void

SetPersonImage(Integer)

Stores the person image that is displayed in the CRM application.

Void SetPersonImage(Integer personId, NSImage image)

Returns: CRMScript.Global.Void

SetPersonRank(Integer,Integer)

Directly sets the rank field of a person record, adjusting all other person records under the same contact as needed.

Bool SetPersonRank(Integer personId, Integer desiredRank)

Returns: CRMScript.Global.Bool

May affect multiple records, potentially all person records belonging to one contact.You must have write access for to affected records for this method to succeed.

Example:

NSPersonAgent agent;
Integer personId;
Integer desiredRank;
Bool res = agent.SetPersonRank(personId, desiredRank);

TryAddPersonsToEmailFlow(Integer,Integer[])

Attempts to add multiple persons to an email flow, returning an array of boolean values indicating success for each person.

Bool[] TryAddPersonsToEmailFlow(Integer flowId, Integer[] personIds)

Returns: CRMScript.Global.Bool[] - An array of boolean values indicating whether each person was successfully added to the email flow. Example:

NSPersonAgent agent;
Integer[] personIds;
personIds.pushBack(2);
agent.TryAddPersonsToEmailFlow(1, personIds);

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:

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

ValidatePersonEntity(NSPersonEntity)

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

Map ValidatePersonEntity(NSPersonEntity personEntity)

Returns: CRMScript.Native.Map Example:

NSPersonAgent agent;
NSPersonEntity personEntity;
Map res = agent.ValidatePersonEntity(personEntity);

​Constructors

​NSPersonAgent()

​Methods

​AddBounce(String)

​AddBounceWithCount(String,Integer)

​AddEmailAddressToPerson(Integer,String,Bool)

​ChangeCountry(NSPersonEntity,Integer)

​ChangePersonRank(Integer,Bool)

​CheckTemporaryKey(String)

​CreateDefaultByContactId(Integer)

​CreateDefaultConsentPerson()

​CreateDefaultFromCredential(Integer,String,String,String)

​CreateDefaultPersonEntity()

​CreateTemporaryKey(Integer,Integer,Integer)

​DeleteConsentPerson(Integer)

​DeleteExpired()

​DeletePersonEntity(Integer)

​DeleteTemporaryKeysOfDomain(Integer,Integer)

​GetAddress(Integer)

​GetAddressByCountry(Integer,Integer)

​GetBestSoLanguageForTemplate(Integer,Integer)

​GetColleagues()

​GetColleaguesByDepartment(Integer)

​GetColleaguesBySource(Integer,Integer)

​GetConsentInfos(Integer)

​GetConsentPerson(Integer)

​GetMyOwner()

​GetMyPerson()

​GetOwnerOnPersonId(Integer)

​GetPerson(Integer)

​GetPersonEntity(Integer)

​GetPersonImage(Integer)

​GetPersonList(Integer[])

​GetPersonsFromContact(Integer)

​GetPersonsFromProject(Integer)

​GetPersonSummary(Integer,Integer)

​GetPhones(Integer)

​GetSalesRep(String,String,String,String,String)

​HasConsent(Integer,String)

​IsNumberValid(Integer,String)

​Merge(Integer,Integer,DateTime,Bool,Bool)

​Move(Integer,Integer,DateTime)

​NormalizeRanks(Integer)

​RemoveConsent(Integer,String)

​ResolvePersonFromInfo(Integer,String,String[],String[])

​SaveConsentPerson(NSConsentPerson)

​SavePersonEntity(NSPersonEntity)

​SendConsentConfirmationEmail(Integer,String,Integer,Integer,String)

​SetConsent(Integer,String,String,String,String)

​SetPersonImage(Integer)

​SetPersonRank(Integer,Integer)

​TryAddPersonsToEmailFlow(Integer,Integer[])

​Undelete(Integer)

​ValidatePersonEntity(NSPersonEntity)

Constructors

NSPersonAgent()

Methods

AddBounce(String)

AddBounceWithCount(String,Integer)

AddEmailAddressToPerson(Integer,String,Bool)

ChangeCountry(NSPersonEntity,Integer)

ChangePersonRank(Integer,Bool)

CheckTemporaryKey(String)

CreateDefaultByContactId(Integer)

CreateDefaultConsentPerson()

CreateDefaultFromCredential(Integer,String,String,String)

CreateDefaultPersonEntity()

CreateTemporaryKey(Integer,Integer,Integer)

DeleteConsentPerson(Integer)

DeleteExpired()

DeletePersonEntity(Integer)

DeleteTemporaryKeysOfDomain(Integer,Integer)

GetAddress(Integer)

GetAddressByCountry(Integer,Integer)

GetBestSoLanguageForTemplate(Integer,Integer)

GetColleagues()

GetColleaguesByDepartment(Integer)

GetColleaguesBySource(Integer,Integer)

GetConsentInfos(Integer)

GetConsentPerson(Integer)

GetMyOwner()

GetMyPerson()

GetOwnerOnPersonId(Integer)

GetPerson(Integer)

GetPersonEntity(Integer)

GetPersonImage(Integer)

GetPersonList(Integer[])

GetPersonsFromContact(Integer)

GetPersonsFromProject(Integer)

GetPersonSummary(Integer,Integer)

GetPhones(Integer)

GetSalesRep(String,String,String,String,String)

HasConsent(Integer,String)

IsNumberValid(Integer,String)

Merge(Integer,Integer,DateTime,Bool,Bool)

Move(Integer,Integer,DateTime)

NormalizeRanks(Integer)

RemoveConsent(Integer,String)

ResolvePersonFromInfo(Integer,String,String[],String[])

SaveConsentPerson(NSConsentPerson)

SavePersonEntity(NSPersonEntity)

SendConsentConfirmationEmail(Integer,String,Integer,Integer,String)

SetConsent(Integer,String,String,String,String)

SetPersonImage(Integer)

SetPersonRank(Integer,Integer)

TryAddPersonsToEmailFlow(Integer,Integer[])

Undelete(Integer)

ValidatePersonEntity(NSPersonEntity)