Class NSPersonEntity
The Person Service. The service implements all services working with the Person object.
Syntax
Constructors
NSPersonEntity()
Initializes a new instance of the NSPersonEntity class.
Introduced or updated in version: 7
Declaration
NSPersonEntityMethods
GetActiveErpLinks()
Introduced or updated in version: 7.5
Declaration
Integer GetActiveErpLinks()Returns
| Type | Description |
|---|---|
| Integer | How many active ERP links are there for this person? |
Examples
NSPersonEntity thing;
Integer activeErpLinks = thing.GetActiveErpLinks();GetActiveInterests()
Introduced or updated in version: 7
Declaration
Integer GetActiveInterests()Returns
| Type | Description |
|---|---|
| Integer | The number of active interests. |
Examples
NSPersonEntity thing;
Integer activeInterests = thing.GetActiveInterests();GetAddress()
Retrieves a formatted addressRetrieves the structure holding formatted address data.
Introduced or updated in version: 7
Declaration
NSAddress GetAddress()Returns
| Type | Description |
|---|---|
Remarks
The layout of the array structure indicates the layout of the localized address.
Examples
NSPersonEntity thing;
NSAddress address = thing.GetAddress();GetAssociate()
Introduced or updated in version: 7
Declaration
NSAssociate GetAssociate()Returns
| Type | Description |
|---|---|
| NSAssociate | The associate owning this person (similar to contact.Associate). |
Remarks
Usually blank. Use the Person.Contact.Associate instead. Intended for use when individual persons are created (i.e. when Person.Contact is blank)
Examples
NSPersonEntity thing;
NSAssociate associate = thing.GetAssociate();GetBirthDate()
Introduced or updated in version: 7
Declaration
DateTime GetBirthDate()Returns
| Type | Description |
|---|---|
| DateTime | The Person birth date as Date. |
Examples
NSPersonEntity thing;
DateTime birthDate = thing.GetBirthDate();GetBlockEmarketing()
Introduced or updated in version: 7
Declaration
Bool GetBlockEmarketing()Returns
| Type | Description |
|---|---|
| Bool | Do not send E-marketing materials to this person. |
GetBounceEmails()
Introduced or updated in version: 7
Declaration
String[] GetBounceEmails()Returns
| Type | Description |
|---|---|
| String[] | Email addresses with a positive bounce counter. |
Examples
NSPersonEntity thing;
String[] bounceEmails = thing.GetBounceEmails();GetBusiness()
Introduced or updated in version: 7
Declaration
NSBusiness GetBusiness()Returns
| Type | Description |
|---|---|
| NSBusiness | Person's business. |
Remarks
Usually blank. Use Contact.NSBusiness instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank)
Examples
NSPersonEntity thing;
NSBusiness business = thing.GetBusiness();GetCategory()
Introduced or updated in version: 7
Declaration
NSCategory GetCategory()Returns
| Type | Description |
|---|---|
| NSCategory | Person's category. |
Remarks
Usually null. Refer to the Contact.NSCategory instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank)
Examples
NSPersonEntity thing;
NSCategory category = thing.GetCategory();GetChatEmails()
Introduced or updated in version: 7
Declaration
NSEntityElement[] GetChatEmails()Returns
| Type | Description |
|---|---|
| NSEntityElement[] |
Examples
NSPersonEntity thing;
NSEntityElement[] chatEmails = thing.GetChatEmails();GetConsents()
Introduced or updated in version: 8.2
Declaration
NSConsentInfo[] GetConsents()Returns
| Type | Description |
|---|---|
| NSConsentInfo[] | The person's available consent information. |
Remarks
Missing consents are not deleted. To remove a consent, mark its legalbase as 'WITHDRAWN'
Examples
NSPersonEntity thing;
NSConsentInfo[] consents = thing.GetConsents();GetContact()
Introduced or updated in version: 7
Declaration
NSContact GetContact()Returns
| Type | Description |
|---|---|
| NSContact | The contact the contact person is registered on. |
Remarks
This is required unless the 'MandatoryContactOnPerson' preference is set.
Examples
NSPersonEntity thing;
NSContact contact = thing.GetContact();GetCorrespondingAssociate()
Introduced or updated in version: 7
Declaration
NSAssociate GetCorrespondingAssociate()Returns
| Type | Description |
|---|---|
| NSAssociate | The associate corresponding to this person. Will be empty if the person is not a user (internal associate user, external user). |
Examples
NSPersonEntity thing;
NSAssociate correspondingAssociate = thing.GetCorrespondingAssociate();GetCountry()
Introduced or updated in version: 7
Declaration
NSCountry GetCountry()Returns
| Type | Description |
|---|---|
| NSCountry | The country this contact person is located in. |
Examples
NSPersonEntity thing;
NSCountry country = thing.GetCountry();GetCreatedBy()
Introduced or updated in version: 7
Declaration
NSAssociate GetCreatedBy()Returns
| Type | Description |
|---|---|
| NSAssociate | The user that created the person object. |
Examples
NSPersonEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();GetCreatedDate()
Introduced or updated in version: 7
Declaration
DateTime GetCreatedDate()Returns
| Type | Description |
|---|---|
| DateTime | Registered date. |
Examples
NSPersonEntity thing;
DateTime createdDate = thing.GetCreatedDate();GetCustomerLanguage()
Introduced or updated in version: 7
Declaration
NSCustomerLanguage GetCustomerLanguage()Returns
| Type | Description |
|---|---|
| NSCustomerLanguage |
Examples
NSPersonEntity thing;
NSCustomerLanguage customerLanguage = thing.GetCustomerLanguage();GetCustomFields()
Gets the user-defined + extra fields on an NSPersonEntity as a map.
Introduced or updated in version: 8.5R08
Declaration
Map GetCustomFields()Returns
| Type | Description |
|---|---|
| Map |
Examples
NSPersonEntity thing;
Map fields = thing.GetCustomFields();
String oldValue = fields.get("SuperOffice:1");
fields.insert("SuperOffice:1", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
printLine(fields.getKey() + ": " + fields.getVal());GetDbiAgentId()
Introduced or updated in version: 7
Declaration
Integer GetDbiAgentId()Returns
| Type | Description |
|---|---|
| Integer | Integration agent (eJournal). |
Examples
NSPersonEntity thing;
Integer dbiAgentId = thing.GetDbiAgentId();GetDbiKey()
Introduced or updated in version: 7
Declaration
String GetDbiKey()Returns
| Type | Description |
|---|---|
| String | The primary key for the integrated entry in the external data source. |
Examples
NSPersonEntity thing;
String dbiKey = thing.GetDbiKey();GetDbiLastModified()
Introduced or updated in version: 7
Declaration
DateTime GetDbiLastModified()Returns
| Type | Description |
|---|---|
| DateTime | When the entry was last modified. |
Examples
NSPersonEntity thing;
DateTime dbiLastModified = thing.GetDbiLastModified();GetDbiLastSyncronized()
Introduced or updated in version: 7
Declaration
DateTime GetDbiLastSyncronized()Returns
| Type | Description |
|---|---|
| DateTime | Last external synchronization. |
Examples
NSPersonEntity thing;
DateTime dbiLastSyncronized = thing.GetDbiLastSyncronized();GetDescription()
Introduced or updated in version: 7
Declaration
String GetDescription()Returns
| Type | Description |
|---|---|
| String | The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases. |
Examples
NSPersonEntity thing;
String description = thing.GetDescription();GetEmails()
Introduced or updated in version: 7
Declaration
NSEntityElement[] GetEmails()Returns
| Type | Description |
|---|---|
| NSEntityElement[] | A collection of the person's emails. |
Examples
NSPersonEntity thing;
NSEntityElement[] emails = thing.GetEmails();GetExtraFields()
Gets the extra fields on NSPersonEntity as a map.
Introduced or updated in version: 7
Declaration
Map GetExtraFields()Returns
| Type | Description |
|---|---|
| Map |
Examples
NSPersonEntity thing;
Map fields = thing.GetExtraFields();
String oldValue = fields.get("x_foobar");
fields.insert("x_foobar", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
printLine(fields.getKey() + ": " + fields.getVal());GetFaxes()
Returns a collection of fax numbers that belong to the contact person.
Introduced or updated in version: 7
Declaration
NSEntityElement[] GetFaxes()Returns
| Type | Description |
|---|---|
| NSEntityElement[] |
Examples
NSPersonEntity thing;
NSEntityElement[] faxes = thing.GetFaxes();GetFirstname()
Introduced or updated in version: 7
Declaration
String GetFirstname()Returns
| Type | Description |
|---|---|
| String | First name. |
Examples
NSPersonEntity thing;
String firstname = thing.GetFirstname();GetFormalName()
Gets formal name for a person, as used in labels. (Full name + person title + academic title)
Introduced or updated in version: 7
Declaration
String GetFormalName()Returns
| Type | Description |
|---|---|
| String |
Examples
NSPersonEntity thing;
String formalName = thing.GetFormalName();GetFullName()
Introduced or updated in version: 7
Declaration
String GetFullName()Returns
| Type | Description |
|---|---|
| String | The person's full name localized to the current culture/country. (internal name used in clients for employees). |
Examples
NSPersonEntity thing;
String fullName = thing.GetFullName();GetInterests()
Introduced or updated in version: 7
Declaration
NSSelectableMDOListItem[] GetInterests()Returns
| Type | Description |
|---|---|
| NSSelectableMDOListItem[] | The person's available and selected interests. |
Examples
NSPersonEntity thing;
NSSelectableMDOListItem[] interests = thing.GetInterests();GetInternetPhones()
Introduced or updated in version: 7
Declaration
NSEntityElement[] GetInternetPhones()Returns
| Type | Description |
|---|---|
| NSEntityElement[] |
Examples
NSPersonEntity thing;
NSEntityElement[] internetPhones = thing.GetInternetPhones();GetIsAssociate()
Checks if the person object is an associate. The property is read-only.
Introduced or updated in version: 7
Declaration
Bool GetIsAssociate()Returns
| Type | Description |
|---|---|
| Bool |
Examples
NSPersonEntity thing;
Bool isAssociate = thing.GetIsAssociate();GetKanafname()
Introduced or updated in version: 7
Declaration
String GetKanafname()Returns
| Type | Description |
|---|---|
| String | Kana first name, used in Japanese versions only. |
Examples
NSPersonEntity thing;
String kanafname = thing.GetKanafname();GetKanalname()
Introduced or updated in version: 7
Declaration
String GetKanalname()Returns
| Type | Description |
|---|---|
| String | Kana last name, used in Japanese versions only. |
Examples
NSPersonEntity thing;
String kanalname = thing.GetKanalname();GetLastname()
Introduced or updated in version: 7
Declaration
String GetLastname()Returns
| Type | Description |
|---|---|
| String | Last name. |
Examples
NSPersonEntity thing;
String lastname = thing.GetLastname();GetMiddleName()
Introduced or updated in version: 7
Declaration
String GetMiddleName()Returns
| Type | Description |
|---|---|
| String | Middle name or 'van' etc. |
Examples
NSPersonEntity thing;
String middleName = thing.GetMiddleName();GetMobilePhones()
Returns a collection of mobile phone numbers that belong to the contact person.
Introduced or updated in version: 7
Declaration
NSEntityElement[] GetMobilePhones()Returns
| Type | Description |
|---|---|
| NSEntityElement[] |
Examples
NSPersonEntity thing;
NSEntityElement[] mobilePhones = thing.GetMobilePhones();GetMrmrs()
Introduced or updated in version: 7
Declaration
String GetMrmrs()Returns
| Type | Description |
|---|---|
| String |
Examples
NSPersonEntity thing;
String mrmrs = thing.GetMrmrs();GetNoMailing()
Introduced or updated in version: 7
Declaration
Bool GetNoMailing()Returns
| Type | Description |
|---|---|
| Bool | Spam filter. Indicates if this person should retrieve advertising. |
Examples
NSPersonEntity thing;
Bool noMailing = thing.GetNoMailing();GetOfficePhones()
Returns a collection of office phone numbers that belong to the contact person.
Introduced or updated in version: 7
Declaration
NSEntityElement[] GetOfficePhones()Returns
| Type | Description |
|---|---|
| NSEntityElement[] |
Examples
NSPersonEntity thing;
NSEntityElement[] officePhones = thing.GetOfficePhones();GetOtherPhones()
Returns a collection of pagers that belong to the contact person.
Introduced or updated in version: 7
Declaration
NSEntityElement[] GetOtherPhones()Returns
| Type | Description |
|---|---|
| NSEntityElement[] |
Examples
NSPersonEntity thing;
NSEntityElement[] otherPhones = thing.GetOtherPhones();GetPagers()
Introduced or updated in version: 7
Declaration
NSEntityElement[] GetPagers()Returns
| Type | Description |
|---|---|
| NSEntityElement[] |
GetPersonId()
Introduced or updated in version: 7
Declaration
Integer GetPersonId()Returns
| Type | Description |
|---|---|
| Integer | Primary key. |
Examples
NSPersonEntity thing;
Integer personId = thing.GetPersonId();GetPersonNumber()
Introduced or updated in version: 7
Declaration
String GetPersonNumber()Returns
| Type | Description |
|---|---|
| String | Alphanumeric user field. |
Examples
NSPersonEntity thing;
String personNumber = thing.GetPersonNumber();GetPosition()
Introduced or updated in version: 7
Declaration
NSPosition GetPosition()Returns
| Type | Description |
|---|---|
| NSPosition | The position. This is a predefined SuperOffice value, different from Title. |
Examples
NSPersonEntity thing;
NSPosition position = thing.GetPosition();GetPost1()
Introduced or updated in version: 7
Declaration
String GetPost1()Returns
| Type | Description |
|---|---|
| String | Postal address, used in Japanese versions only. |
Examples
NSPersonEntity thing;
String post1 = thing.GetPost1();GetPost2()
Introduced or updated in version: 7
Declaration
String GetPost2()Returns
| Type | Description |
|---|---|
| String | Postal address, used in Japanese versions only. |
Examples
NSPersonEntity thing;
String post2 = thing.GetPost2();GetPost3()
Introduced or updated in version: 7
Declaration
String GetPost3()Returns
| Type | Description |
|---|---|
| String | Postal address, used in Japanese versions only. |
Examples
NSPersonEntity thing;
String post3 = thing.GetPost3();GetPrivatePhones()
Returns a collection of phone numbers that belong to the contact person.
Introduced or updated in version: 7
Declaration
NSEntityElement[] GetPrivatePhones()Returns
| Type | Description |
|---|---|
| NSEntityElement[] |
Examples
NSPersonEntity thing;
NSEntityElement[] privatePhones = thing.GetPrivatePhones();GetRetired()
Introduced or updated in version: 7
Declaration
Bool GetRetired()Returns
| Type | Description |
|---|---|
| Bool | True if the user is retired and should have no rights, not appear in lists, etc. |
Examples
NSPersonEntity thing;
Bool retired = thing.GetRetired();GetSalutation()
Introduced or updated in version: 7
Declaration
String GetSalutation()Returns
| Type | Description |
|---|---|
| String | Academic title, populated from Salutation list but can be overwritten with anything at all. |
Examples
NSPersonEntity thing;
String salutation = thing.GetSalutation();GetSentInfo()
Introduced or updated in version: 7
Declaration
Integer GetSentInfo()Returns
| Type | Description |
|---|---|
| Integer | Has information on username/password been sent (Service). |
Examples
NSPersonEntity thing;
Integer sentInfo = thing.GetSentInfo();GetShipmentTypes()
The person's available and selected shipment types.
Introduced or updated in version: 8.2
Declaration
NSSelectableMDOListItem[] GetShipmentTypes()Returns
| Type | Description |
|---|---|
| NSSelectableMDOListItem[] |
Examples
NSPersonEntity thing;
NSSelectableMDOListItem[] shipmentTypes = thing.GetShipmentTypes();GetShowContactTickets()
Introduced or updated in version: 7
Declaration
Integer GetShowContactTickets()Returns
| Type | Description |
|---|---|
| Integer | Should tickets related to the company be shown to this person. |
Examples
NSPersonEntity thing;
Integer showContactTickets = thing.GetShowContactTickets();GetSource()
Introduced or updated in version: 7.9.0
Declaration
Integer GetSource()Returns
| Type | Description |
|---|---|
| Integer | How did we get this person? For future integration needs. |
Examples
NSPersonEntity thing;
Integer source = thing.GetSource();GetSupportAssociate()
Introduced or updated in version: 7
Declaration
NSAssociate GetSupportAssociate()Returns
| Type | Description |
|---|---|
| NSAssociate |
Examples
NSPersonEntity thing;
NSAssociate supportAssociate = thing.GetSupportAssociate();GetTicketPriority()
Introduced or updated in version: 7
Declaration
NSTicketPriority GetTicketPriority()Returns
| Type | Description |
|---|---|
| NSTicketPriority |
Examples
NSPersonEntity thing;
NSTicketPriority ticketPriority = thing.GetTicketPriority();GetTitle()
Introduced or updated in version: 7
Declaration
String GetTitle()Returns
| Type | Description |
|---|---|
| String | Title. |
Examples
NSPersonEntity thing;
String title = thing.GetTitle();GetUpdatedBy()
Introduced or updated in version: 7
Declaration
NSAssociate GetUpdatedBy()Returns
| Type | Description |
|---|---|
| NSAssociate | The person that last updated the person object. |
Examples
NSPersonEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();GetUpdatedDate()
Introduced or updated in version: 7
Declaration
DateTime GetUpdatedDate()Returns
| Type | Description |
|---|---|
| DateTime | Last updated date. |
Examples
NSPersonEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();GetUrls()
Introduced or updated in version: 7
Declaration
NSEntityElement[] GetUrls()Returns
| Type | Description |
|---|---|
| NSEntityElement[] | The URLs related to this person. |
Examples
NSPersonEntity thing;
NSEntityElement[] urls = thing.GetUrls();GetUsePersonAddress()
Introduced or updated in version: 7
Declaration
Bool GetUsePersonAddress()Returns
| Type | Description |
|---|---|
| Bool | True if the person's address should be used as mailing address, instead of the contact's address. |
Examples
NSPersonEntity thing;
Bool usePersonAddress = thing.GetUsePersonAddress();GetUserDefinedFields()
Gets the user-defined fields on the NSPersonEntity as a map.
Introduced or updated in version: 7
Declaration
Map GetUserDefinedFields()Returns
| Type | Description |
|---|---|
| Map |
Examples
NSPersonEntity thing;
Map fields = thing.GetUserDefinedFields();
String oldValue = fields.get("SuperOffice:1");
fields.insert("SuperOffice:1", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
printLine(fields.getKey() + ": " + fields.getVal());GetUserInfo()
Introduced or updated in version: 7
Declaration
NSUserInfo GetUserInfo()Returns
| Type | Description |
|---|---|
| NSUserInfo | Information about the user if this person is a user. If IsAssociate (e.g. is user is true) the NSUserInfo will be provided. |
Examples
NSPersonEntity thing;
NSUserInfo userInfo = thing.GetUserInfo();SetActiveErpLinks(Integer)
Introduced or updated in version: 7.5
Declaration
Void SetActiveErpLinks(Integer activeErpLinks)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | activeErpLinks | How many active ERP links are there for this person? |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Integer activeErpLinks;
thing.SetActiveErpLinks(activeErpLinks);SetActiveInterests(Integer)
Introduced or updated in version: 7
Declaration
Void SetActiveInterests(Integer activeInterests)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | activeInterests | The number of active interests. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Integer activeInterests;
thing.SetActiveInterests(activeInterests);SetAddress(NSAddress)
Sets a formatted addressSets the structure holding formatted address data.
Introduced or updated in version: 7
Declaration
Void SetAddress(NSAddress address)Parameters
| Type | Name | Description |
|---|---|---|
| address | The layout of the array structure indicates the layout of the localized address. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSAddress address;
thing.SetAddress(address);SetAssociate(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetAssociate(NSAssociate associate)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | associate | The associate owning this person (similar to contact.Associate). |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
Usually blank. Use the Person.Contact.Associate instead. Intended for use when individual persons are created (i.e. when Person.Contact is blank)
Examples
NSPersonEntity thing;
NSAssociate associate;
thing.SetAssociate(associate);SetBirthDate(DateTime)
Introduced or updated in version: 7
Declaration
Void SetBirthDate(DateTime birthDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | birthDate | The Person birth date as Date. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
DateTime birthDate;
thing.SetBirthDate(birthDate);SetBlockEmarketing(Integer)
Introduced or updated in version: 7
Declaration
Void SetBlockEmarketing(Integer send)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | send | Do not send E-marketing materials to this person. |
Returns
| Type | Description |
|---|---|
| Void |
SetBounceEmails(String[])
Introduced or updated in version: 7
Declaration
Void SetBounceEmails(String[] bounceEmails)Parameters
| Type | Name | Description |
|---|---|---|
| String[] | bounceEmails | Email addresses with a positive bounce counter. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String[] bounceEmails;
thing.SetBounceEmails(bounceEmails);SetBusiness(NSBusiness)
Introduced or updated in version: 7
Declaration
Void SetBusiness(NSBusiness business)Parameters
| Type | Name | Description |
|---|---|---|
| NSBusiness | business | Person's business. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
Usually blank. Use Contact.NSBusiness instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank)
Examples
NSPersonEntity thing;
NSBusiness business;
thing.SetBusiness(business);SetCategory(NSCategory)
Introduced or updated in version: 7
Declaration
Void SetCategory(NSCategory category)Parameters
| Type | Name | Description |
|---|---|---|
| NSCategory | category | Person's category. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
Usually null. Refer to the Contact.NSCategory instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank)
Examples
NSPersonEntity thing;
NSCategory category;
thing.SetCategory(category);SetChatEmails(NSEntityElement[])
Introduced or updated in version: 7
Declaration
Void SetChatEmails(NSEntityElement[] chatEmails)Parameters
| Type | Name | Description |
|---|---|---|
| NSEntityElement[] | chatEmails |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSEntityElement[] chatEmails;
thing.SetChatEmails(chatEmails);SetConsents(NSConsentInfo[])
Introduced or updated in version: 8.2
Declaration
Void SetConsents(NSConsentInfo[] consents)Parameters
| Type | Name | Description |
|---|---|---|
| NSConsentInfo[] | consents | The person's available consent information. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
Missing consents are not deleted. To remove a consent, mark its legalbase as 'WITHDRAWN'
Examples
NSPersonEntity thing;
NSConsentInfo[] consents;
thing.SetConsents(consents);SetContact(NSContact)
Introduced or updated in version: 7
Declaration
Void SetContact(NSContact contact)Parameters
| Type | Name | Description |
|---|---|---|
| NSContact | contact | The contact the contact person is registered on. This is required unless the 'MandatoryContactOnPerson' preference is set. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSContact contact;
thing.SetContact(contact);SetCorrespondingAssociate(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetCorrespondingAssociate(NSAssociate correspondingAssociate)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | correspondingAssociate | The associate corresponding to this person. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
Will be empty if the person is not a user (internal associate user, external user).
Examples
NSPersonEntity thing;
NSAssociate correspondingAssociate;
thing.SetCorrespondingAssociate(correspondingAssociate);SetCountry(NSCountry)
Introduced or updated in version: 7
Declaration
Void SetCountry(NSCountry country)Parameters
| Type | Name | Description |
|---|---|---|
| NSCountry | country | The country this contact person is located in. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSCountry country;
thing.SetCountry(country);SetCreatedBy(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetCreatedBy(NSAssociate createdBy)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | createdBy | The user that created the person object. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);SetCreatedDate(DateTime)
Introduced or updated in version: 7
Declaration
Void SetCreatedDate(DateTime createdDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | createdDate | Registered date. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);SetCustomerLanguage(NSCustomerLanguage)
Introduced or updated in version: 7
Declaration
Void SetCustomerLanguage(NSCustomerLanguage customerLanguage)Parameters
| Type | Name | Description |
|---|---|---|
| NSCustomerLanguage | customerLanguage |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSCustomerLanguage customerLanguage;
thing.SetCustomerLanguage(customerLanguage);SetCustomFields(Map)
Sets the user-defined and extra fields on an NSPersonEntity with a map.
Introduced or updated in version: 8.5R08
Declaration
Void SetCustomFields(Map udefs)Parameters
| Type | Name | Description |
|---|---|---|
| Map | udefs |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Map udefs;
udefs["SuperOffice:1"] = "[I:123]";
udefs["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
udefs["custom.progid"] = "foobar";
udefs["x_foo"] = "foobar";
udefs["x_bar"] = "456"; // List item id
thing.SetCustomFields(udefs);SetDbiAgentId(Integer)
Introduced or updated in version: 7
Declaration
Void SetDbiAgentId(Integer dbiAgentId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | dbiAgentId | Integration agent (eJournal). |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Integer dbiAgentId;
thing.SetDbiAgentId(dbiAgentId);SetDbiKey(String)
Introduced or updated in version: 7
Declaration
Void SetDbiKey(String dbiKey)Parameters
| Type | Name | Description |
|---|---|---|
| String | dbiKey | The primary key for the integrated entry in the external datasource. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String dbiKey;
thing.SetDbiKey(dbiKey);SetDbiLastModified(DateTime)
Introduced or updated in version: 7
Declaration
Void SetDbiLastModified(DateTime dbiLastModified)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | dbiLastModified | When the entry was last modified. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
DateTime dbiLastModified;
thing.SetDbiLastModified(dbiLastModified);SetDbiLastSyncronized(DateTime)
Introduced or updated in version: 7
Declaration
Void SetDbiLastSyncronized(DateTime dbiLastSyncronized)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | dbiLastSyncronized | Last external synchronization. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
DateTime dbiLastSyncronized;
thing.SetDbiLastSyncronized(dbiLastSyncronized);SetDescription(String)
Introduced or updated in version: 7
Declaration
Void SetDescription(String description)Parameters
| Type | Name | Description |
|---|---|---|
| String | description | The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String description;
thing.SetDescription(description);SetEmails(NSEntityElement[])
Introduced or updated in version: 7
Declaration
Void SetEmails(NSEntityElement[] emails)Parameters
| Type | Name | Description |
|---|---|---|
| NSEntityElement[] | emails | A collection of the person's emails. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSEntityElement[] emails;
thing.SetEmails(emails);SetExtraFields(Map)
Sets the extra field values on NSPersonEntity with a map.
Introduced or updated in version: 7
Declaration
Void SetExtraFields(Map extras)Parameters
| Type | Name | Description |
|---|---|---|
| Map | extras |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Map extras;
extras["SuperOffice:1"] = "[I:123]";
extras["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
extras["custom.progid"] = "foobar";
thing.SetExtraFields(extras);SetFaxes(NSEntityElement[])
Returns a collection of fax numbers that belong to the contact person.
Introduced or updated in version: 7
Declaration
Void SetFaxes(NSEntityElement[] faxes)Parameters
| Type | Name | Description |
|---|---|---|
| NSEntityElement[] | faxes |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSEntityElement[] faxes;
thing.SetFaxes(faxes);SetFirstname(String)
Introduced or updated in version: 7
Declaration
Void SetFirstname(String firstname)Parameters
| Type | Name | Description |
|---|---|---|
| String | firstname | First name. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String firstname;
thing.SetFirstname(firstname);SetFormalName(String)
Gets formal name for a person, as used in labels. (Full name + person title + academic title)
Introduced or updated in version: 7
Declaration
Void SetFormalName(String formalName)Parameters
| Type | Name | Description |
|---|---|---|
| String | formalName |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String formalName;
thing.SetFormalName(formalName);SetFullName(String)
Introduced or updated in version: 7
Declaration
Void SetFullName(String fullName)Parameters
| Type | Name | Description |
|---|---|---|
| String | fullName | The person's full name localized to the current culture/country. (internal name used in clients for employees). |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String fullName;
thing.SetFullName(fullName);SetInterests(NSSelectableMDOListItem[])
Introduced or updated in version: 7
Declaration
Void SetInterests(NSSelectableMDOListItem[] interests)Parameters
| Type | Name | Description |
|---|---|---|
| NSSelectableMDOListItem[] | interests | The person's available and selected interests. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSSelectableMDOListItem[] interests;
thing.SetInterests(interests);SetInternetPhones(NSEntityElement[])
Introduced or updated in version: 7
Declaration
Void SetInternetPhones(NSEntityElement[] internetPhones)Parameters
| Type | Name | Description |
|---|---|---|
| NSEntityElement[] | internetPhones |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSEntityElement[] internetPhones;
thing.SetInternetPhones(internetPhones);SetIsAssociate(Bool)
Checks if the person object is an associate. The property is read-only.
Introduced or updated in version: 7
Declaration
Void SetIsAssociate(Bool isAssociate)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | isAssociate |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Bool isAssociate;
thing.SetIsAssociate(isAssociate);SetKanafname(String)
Introduced or updated in version: 7
Declaration
Void SetKanafname(String kanafname)Parameters
| Type | Name | Description |
|---|---|---|
| String | kanafname | Kana first name, used in Japanese versions only. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String kanafname;
thing.SetKanafname(kanafname);SetKanalname(String)
Introduced or updated in version: 7
Declaration
Void SetKanalname(String kanalname)Parameters
| Type | Name | Description |
|---|---|---|
| String | kanalname | Kana last name, used in Japanese versions only. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String kanalname;
thing.SetKanalname(kanalname);SetLastname(String)
Introduced or updated in version: 7
Declaration
Void SetLastname(String lastname)Parameters
| Type | Name | Description |
|---|---|---|
| String | lastname | Last name. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String lastname;
thing.SetLastname(lastname);SetMiddleName(String)
Introduced or updated in version: 7
Declaration
Void SetMiddleName(String middleName)Parameters
| Type | Name | Description |
|---|---|---|
| String | middleName | Middle name or 'van' etc. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String middleName;
thing.SetMiddleName(middleName);SetMobilePhones(NSEntityElement[])
Returns a collection of mobile phone numbers that belong to the contact person.
Introduced or updated in version: 7
Declaration
Void SetMobilePhones(NSEntityElement[] mobilePhones)Parameters
| Type | Name | Description |
|---|---|---|
| NSEntityElement[] | mobilePhones |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSEntityElement[] mobilePhones;
thing.SetMobilePhones(mobilePhones);SetMrmrs(String)
Introduced or updated in version: 7
Declaration
Void SetMrmrs(String mrmrs)Parameters
| Type | Name | Description |
|---|---|---|
| String | mrmrs |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String mrmrs;
thing.SetMrmrs(mrmrs);SetNoMailing(Bool)
Introduced or updated in version: 7
Declaration
Void SetNoMailing(Bool noMailing)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | noMailing | Spam filter. Indicates if this person should retrieve advertising. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Bool noMailing;
thing.SetNoMailing(noMailing);SetOfficePhones(NSEntityElement[])
Returns a collection of office phone numbers that belong to the contact person.
Introduced or updated in version: 7
Declaration
Void SetOfficePhones(NSEntityElement[] officePhones)Parameters
| Type | Name | Description |
|---|---|---|
| NSEntityElement[] | officePhones |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSEntityElement[] officePhones;
thing.SetOfficePhones(officePhones);SetOtherPhones(NSEntityElement[])
Returns a collection of pagers that belong to the contact person.
Introduced or updated in version: 7
Declaration
Void SetOtherPhones(NSEntityElement[] otherPhones)Parameters
| Type | Name | Description |
|---|---|---|
| NSEntityElement[] | otherPhones |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSEntityElement[] otherPhones;
thing.SetOtherPhones(otherPhones);SetPagers(NSEntityElement[])
Introduced or updated in version: 7
Declaration
Void SetPagers(NSEntityElement[] pagers)Parameters
| Type | Name | Description |
|---|---|---|
| NSEntityElement[] | pagers |
Returns
| Type | Description |
|---|---|
| Void |
SetPersonId(Integer)
Introduced or updated in version: 7
Declaration
Void SetPersonId(Integer personId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | personId | Primary key. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Integer personId;
thing.SetPersonId(personId);SetPersonNumber(String)
Introduced or updated in version: 7
Declaration
Void SetPersonNumber(String personNumber)Parameters
| Type | Name | Description |
|---|---|---|
| String | personNumber | Alphanumeric user field. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String personNumber;
thing.SetPersonNumber(personNumber);SetPosition(NSPosition)
Introduced or updated in version: 7
Declaration
Void SetPosition(NSPosition position)Parameters
| Type | Name | Description |
|---|---|---|
| NSPosition | position | The position. This is a predefined SuperOffice value, different from Title. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSPosition position;
thing.SetPosition(position);SetPost1(String)
Introduced or updated in version: 7
Declaration
Void SetPost1(String post1)Parameters
| Type | Name | Description |
|---|---|---|
| String | post1 | Postal address, used in Japanese versions only. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String post1;
thing.SetPost1(post1);SetPost2(String)
Introduced or updated in version: 7
Declaration
Void SetPost2(String post2)Parameters
| Type | Name | Description |
|---|---|---|
| String | post2 | Postal address, used in Japanese versions only |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String post2;
thing.SetPost2(post2);SetPost3(String)
Introduced or updated in version: 7
Declaration
Void SetPost3(String post3)Parameters
| Type | Name | Description |
|---|---|---|
| String | post3 | Postal address, used in Japanese versions only. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String post3;
thing.SetPost3(post3);SetPrivatePhones(NSEntityElement[])
Returns a collection of phone numbers that belong to the contact person.
Introduced or updated in version: 7
Declaration
Void SetPrivatePhones(NSEntityElement[] privatePhones)Parameters
| Type | Name | Description |
|---|---|---|
| NSEntityElement[] | privatePhones |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSEntityElement[] privatePhones;
thing.SetPrivatePhones(privatePhones);SetRetired(Bool)
Introduced or updated in version: 7
Declaration
Void SetRetired(Bool retired)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | retired | True if the user is retired and should have no rights, not appear in lists, etc. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Bool retired;
thing.SetRetired(retired);SetSalutation(String)
Introduced or updated in version: 7
Declaration
Void SetSalutation(String salutation)Parameters
| Type | Name | Description |
|---|---|---|
| String | salutation | Academic title, populated from Salutation list but can be overwritten with anything at all. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String salutation;
thing.SetSalutation(salutation);SetSentInfo(Integer)
Introduced or updated in version: 7
Declaration
Void SetSentInfo(Integer sentInfo)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | sentInfo | Has information on username/password been sent (Service). |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Integer sentInfo;
thing.SetSentInfo(sentInfo);SetShipmentTypes(NSSelectableMDOListItem[])
Introduced or updated in version: 8.2
Declaration
Void SetShipmentTypes(NSSelectableMDOListItem[] shipmentTypes)Parameters
| Type | Name | Description |
|---|---|---|
| NSSelectableMDOListItem[] | shipmentTypes | The person's available and selected shipment types. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSSelectableMDOListItem[] shipmentTypes;
thing.SetShipmentTypes(shipmentTypes);SetShowContactTickets(Integer)
Introduced or updated in version: 7
Declaration
Void SetShowContactTickets(Integer showContactTickets)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | showContactTickets | Should tickets related to the company be shown to this person. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Integer showContactTickets;
thing.SetShowContactTickets(showContactTickets);SetSource(Integer)
Introduced or updated in version: 7.9.0
Declaration
Void SetSource(Integer source)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | source | How did we get this person? |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
For future integration needs
Examples
NSPersonEntity thing;
Integer source;
thing.SetSource(source);SetSupportAssociate(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetSupportAssociate(NSAssociate supportAssociate)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | supportAssociate |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSAssociate supportAssociate;
thing.SetSupportAssociate(supportAssociate);SetTicketPriority(NSTicketPriority)
Introduced or updated in version: 7
Declaration
Void SetTicketPriority(NSTicketPriority ticketPriority)Parameters
| Type | Name | Description |
|---|---|---|
| NSTicketPriority | ticketPriority |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSTicketPriority ticketPriority;
thing.SetTicketPriority(ticketPriority);SetTitle(String)
Introduced or updated in version: 7
Declaration
Void SetTitle(String title)Parameters
| Type | Name | Description |
|---|---|---|
| String | title | Title. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
String title;
thing.SetTitle(title);SetUpdatedBy(NSAssociate)
The person that last updated the person object
Introduced or updated in version: 7
Declaration
Void SetUpdatedBy(NSAssociate updatedBy)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | updatedBy |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);SetUpdatedDate(DateTime)
Introduced or updated in version: 7
Declaration
Void SetUpdatedDate(DateTime updatedDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | updatedDate | Last updated date. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);SetUrls(NSEntityElement[])
Introduced or updated in version: 7
Declaration
Void SetUrls(NSEntityElement[] urls)Parameters
| Type | Name | Description |
|---|---|---|
| NSEntityElement[] | urls | The URLs related to this person. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSEntityElement[] urls;
thing.SetUrls(urls);SetUsePersonAddress(Bool)
Introduced or updated in version: 7
Declaration
Void SetUsePersonAddress(Bool usePersonAddress)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | usePersonAddress | True if the person's address should be used as mailing address, instead of the contact's address. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Bool usePersonAddress;
thing.SetUsePersonAddress(usePersonAddress);SetUserDefinedFields(Map)
Sets the user-defined fields on the NSPersonEntity as a map.
Introduced or updated in version: 7
Declaration
Void SetUserDefinedFields(Map udefs)Parameters
| Type | Name | Description |
|---|---|---|
| Map | udefs |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
Map udefs;
udefs["SuperOffice:1"] = "[I:123]";
udefs["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
udefs["custom.progid"] = "foobar";
thing.SetUserDefinedFields(udefs);SetUserInfo(NSUserInfo)
Introduced or updated in version: 7
Declaration
Void SetUserInfo(NSUserInfo userInfo)Parameters
| Type | Name | Description |
|---|---|---|
| NSUserInfo | userInfo | Information about the user if this person is a user. If IsAssociate (e.g. is user is true) the NSUserInfo will be provided. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSPersonEntity thing;
NSUserInfo userInfo;
thing.SetUserInfo(userInfo);