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