• Share
    • Twitter
    • LinkedIn
    • Facebook
    • Email
  • Feedback
  • Edit
Show / Hide Table of Contents

"personfavourites"

Some tooltip text!
• 29 minutes to read
 • 29 minutes to read

This provider name is implemented by the class SuperOffice.CRM.ArchiveLists.PersonFavouritesProvider inside NetServer's SODatabase assembly.

Supported Entities

Name Description
"person" Favourite contact

Supported Columns

Name Restriction Description OrderBy
getAllRows bool GetAll: Get all rows of archive - use with care, you may be fetching the whole database
getNoRows bool GetNone: Do not get any rows from the archive
personId int DB ID: Displays the database ID of a contact x
firstName string First name: Displays the contact's first name x
lastName string Last name: Displays the contact's last name x
middleName string Middle name: Displays the contact's middle name. x
fullName stringorPK Contact: Displays the contact to which an item is linked x
fullNameWithContact None Contact and company: The fully formatted contact name, and full company name x
contactId int Company ID: Database ID of company x
hasInfoText bool Has note: Displays an icon indicating if there is additional information available about the contact x
hasInterests bool Has interests: Displays an Icon indicating if the contact has active interests x
personHasInterests bool Has interests: Displays an Icon indicating if the contact has active interests x
mrMrs string Mr/Ms: Displays whether the contact is addressed as Mr or Ms x
position listAny Position x
personNumber string Number: Displays the contact's number x
title string Title: Displays the contact's job title x
personCountry listAny Country: Country x
personCountryId int Country ID: Country ID x
personNoMail bool No Mailings: Displays the contact's No Mailings checkbox x
rank int Rank: Displays a contact's current rank x
birthdate None Birthdate: Displays the contact's date of birth
associateType None User type: Displays an icon indicating if a contact is an associate or external contact with log-in rights and currently online. This information is updated only once while the archive is loading.
useAsMailingAddress bool Use as postal address: Use as postal address x
personSource listAny Source: Source (Contact) x
retired bool Former employee: Indicates whether the contact has retired/left the company x
birthYear int Birth year: Displays contact's birth year x
birthMonth int Birth month: Displays contact's birth month x
birthDay int Birth day: Displays contact's birth day (day of month) x
kanaFirstName string First name, kana: Contact's first name, in kana alphabet x
kanaLastName string Last name, kana: Contact's last name, in kana alphabet x
personUpdatedBy associate Updated by: The user who last updated the data x
personUpdatedByFullName associate Updated by - Full name: The user who last updated the data x
personUpdatedDate date Updated: The date/time the data was last updated in UTC. x
personRegisteredBy associate Registered by: The user who registered the data x
personRegisteredByFullName associate Registered by - Full name: The user who registered the data x
personRegisteredDate date Registered date: The date/time the data was registered in UTC. x
portraitThumbnail None Person image: Person image
personActiveErpLinks bool ERP connected: Is there an active ERP Sync? x
ticketPriority listAny Service priority: Default service priority for this contact x
supportLanguage listAny Preferred language: Preferred language used for reply templates and more x
supportAssociate associate Our service contact: Default service contact for this contact x
supportAssociateFullName associate Our service contact - Full name: Default service contact for this contact x
personAssociateId associate Our contact: Displays our contact x
personAssociateFullName associate Our contact - Full name: Displays our contact x
personCategory listAny Category x
personBusiness listAny Business x
personDeletedDate datetime Deleted date: Deleted date
hasCompany bool Has company: The contact is associated with a company x
isProjectMember bool Is project member: This person is a project member x
isStakeholder bool Is stakeholder: This person is a sale stakeholder x
updatedByWorkflow listAny Updated by flow: Updated by flow x
whenUpdatedByWorkflow datetime When updated by flow: When updated by flow x
createdByForm listAny Created by form: Created by form x
phone/formattedNumber string Phone : Displays phone number
entityIcon None Row specific icon: Row specific icon x
icon None Category: Displays the icon for an activity type x
text positiveString Favourite: Displays a descriptive text for the item x
favouritePersonAssociateId associate Associate ID: Associate ID x
favouriteAssociateId associate ID: Displays the login ID of the associate who owns the activity. x
emailAddress associate ID: Displays the login ID of the associate who owns the activity. x
personDirectPhone/formattedNumber string Direct - Phone: Displays phone number
personDirectPhone/description string Direct - Description: Phone number description x
personMobilePhone/formattedNumber string Mobile - Phone: Displays phone number
personMobilePhone/description string Mobile - Description: Phone number description x
personPrivate/formattedNumber string Private - Phone: Displays phone number
personPrivate/description string Private - Description: Phone number description x
personPager/formattedNumber string Other - Phone: Displays phone number
personPager/description string Other - Description: Phone number description x
personDirectFax/formattedNumber string Fax - Phone: Displays phone number
personDirectFax/description string Fax - Description: Phone number description x
searchPhone/formattedNumber string Phone : Displays phone number
searchPhone/description string Description: Phone number description x
personInfo/textId int Text ID x
personInfo/infoText positiveString Information: Displays the text entered in the description field x
email/emailProtocol string Protocol: E-mail protocol, such as SMTP x
email/emailAddress string E-mail x
email/emailDescription string Description x
email/emailId int ID x
email/emailLastSent datetime Last sent: The date and time an e-mail was last sent to this address x
email/emailBounceCount int Bounce count: Bounce count for this e-mail address x
email/emailLastBounce datetime Last bounce: Date and time for last bounce to this e-mail address x
email/emailHasBounced bool Has bounced: This checkbox is active if delivery to this e-mail address has failed. x
personUrl/URLAddress string URL x
personUrl/URLDescription string Description x
personAddress/addressId int Contact address - Address ID: Database ID for the address record x
personAddress/line1 string Contact address - Address 1: First line of the address x
personAddress/line2 string Contact address - Address 2: Second line of the address x
personAddress/line3 string Contact address - Address 3: Third line of the address x
personAddress/county string Contact address - County: This criterion corresponds to the County field on the Company card. It will only be visible if required by a country's address format. x
personAddress/city string Contact address - City: This criterion corresponds to the City field on the Company card. x
personAddress/zip string Contact address - Postcode: This criterion corresponds to the Zip Code field on the Company card. x
personAddress/state string Contact address - State: This criterion corresponds to the State field on the Company card. \It will only be visible if required by a country's address format. x
personAddress/wgs84latitude decimal Contact address - Latitude: Latitude x
personAddress/wgs84longitude decimal Contact address - Longitude: Longitude x
personAddress/formattedAddress None Contact address - {formattedAddress}: {formattedAddress}
personAddress/formattedMultiLineAddress None Contact address - {formattedAddress}: {formattedAddress}
restrictionAddress/addressId int Search address - Address ID: Database ID for the address record x
restrictionAddress/line1 string Search address - Address 1: First line of the address x
restrictionAddress/line2 string Search address - Address 2: Second line of the address x

Supported Columns (cont.)

Name Restriction Description OrderBy
restrictionAddress/line3 string Search address - Address 3: Third line of the address x
restrictionAddress/county string Search address - County: This criterion corresponds to the County field on the Company card. It will only be visible if required by a country's address format. x
restrictionAddress/city string Search address - City: This criterion corresponds to the City field on the Company card. x
restrictionAddress/zip string Search address - Postcode: This criterion corresponds to the Zip Code field on the Company card. x
restrictionAddress/state string Search address - State: This criterion corresponds to the State field on the Company card. \It will only be visible if required by a country's address format. x
restrictionAddress/wgs84latitude decimal Search address - Latitude: Latitude x
restrictionAddress/wgs84longitude decimal Search address - Longitude: Longitude x
restrictionAddress/formattedAddress None Search address - {formattedAddress}: {formattedAddress}
restrictionAddress/formattedMultiLineAddress None Search address - {formattedAddress}: {formattedAddress}
personInterestIds listInterest Contact interest: This criterion corresponds to a contact's interests. It is available via the Contact dialog's Interests tab.
personUdef/SuperOffice:1 string contactshorttext: tooltipshorttext x
personUdef/SuperOffice:2 string contactlongtext: tooltiplongtext x
personUdef/SuperOffice:3 int contactnumber x
personUdef/SuperOffice:4 date contactdate x
personUdef/SuperOffice:5 unlimitedDate contactunlimiteddate: tooltipunlimiteddate x
personUdef/SuperOffice:6 bool contactcheckbox x
personUdef/SuperOffice:7 listAny contactdropdownlistbox x
personUdef/SuperOffice:8 decimal contactdecimal x
personUdef/SuperOffice:9 string page1saleonly x
personUdef/SuperOffice:10 string page1marketingonly x
personUdef/SuperOffice:11 string page1adminonly x
personExtra/x_person_integer int Extra Integer: Custom person integer x
personExtra/x_person_hidden_integer int Extra hidden integer: Custom integer field that is hidden x
personExtra/x_person_float decimal Extra float: Custom float field x
personExtra/x_person_longtext string Extra Long Text: Custom long text field on person, keep HTML tags. Simple input, not text area. Default value = 'Hello there' x
personExtra/x_person_date date Extra date: Custom date field on person. Default value = 28.03.2019 x
personExtra/x_person_datetime datetime Extra DateTime: Custom person date and time field. No default x
personExtra/x_person_time None Extra time: Custom time field on person. Current time as default x
personExtra/x_person_boolean bool Extra Boolean: Custom boolean field on person. Default checked x
personExtra/x_person_timespan timeSpan Extra timespan: Custom timespan on person. Minutes only in 15 units x
personExtra/x_person_shorttext string Extra short text: Custom short text on person. With index. Do not keep HTML tags x
personExtra/x_person_shorttext_list listAny Extra short dropdown: Custom Short text dropdown field on person: black, white, transparent x
personExtra/x_person_user_relation associate Extra user relation: Custom person-user relation field x
personExtra/x_person_category_relation listAny Extra category relation: Custom person-category relation x
personExtra/x_person_priority_relation listAny Extra priority relation: Custom person-priority relation x
personExtra/x_person_request_relation stringorPK Extra request relation: Request relation on contact x
personExtra/x_person_appointment_relation stringorPK Extra appointment relation: Appointment relation on person x
personExtra/x_person_contact_relation stringorPK Extra company relation: Company relation on contact x
personExtra/y_rental/id int Rental - id: Displays the row's primary key (y_rental) x
personExtra/y_rental/x_start date Rental - Start rental x
personExtra/y_rental/x_end date Rental - End x
personExtra/y_rental/x_amount int Rental - Amount: Number to rent. Default = 1 x
personExtra/y_rental/x_contact stringorPK Rental - Renter: Company that rents equipment x
personExtra/y_rental/y_equipment/x_name string Rental - Equipment - Name: Equpment name custom field. Cannot be null., show in table x
personExtra/y_car/id int Car - id: Displays the row's primary key (y_car) x
personAssociate/firstName string First name: Displays the contact's first name x
personAssociate/lastName string Last name: Displays the contact's last name x
personAssociate/middleName string Middle Name : Displays the contact's middle name. x
personAssociate/fullName string Full name: Displays full name of user (first, middle, last - according to settings) x
personAssociate/contactId int Company ID: Database ID of the company the user belongs to
personAssociate/personId int Contact ID: Database ID of the contact row
personAssociate/mrMrs string Mr/Ms: Displays whether the contact is addressed as Mr or Ms x
personAssociate/title string Title: Displays whether the contact is addressed as Mr or Ms x
personAssociate/associateDbId associate ID x
personAssociate/contactName string Owning company: Name of the company the user belongs to x
personAssociate/contactDepartment string Owning department: Name of the department at the company the user belongs to x
personAssociate/usergroup userGroup Primary group: The user's primary user group x
personAssociate/usergroupId int Group ID: The user's primary user group x
personAssociate/contactFullName string Owner: Name and department of the company the user belongs to x
personAssociate/contactCategory listAny Category: Category x
personAssociate/role listAny Role : Role x
personAssociate/assocName associate User ID : User ID x
personAssociate/assocTooltip string Description : Description
personAssociate/assocType listAny Type: Type of user: associate, external user, system user, anonymous account x
personAssociate/ejUserId int Service user ID: The database ID of a Service user
personAssociate/simultaneousEjUser bool Simultaneous Service user: If this flag is set, then the user will only have access if the maximum number of simultaneous users is not exceeded
personAssociate/ejDisplayName string Nick name: User's nick name in Service x
personAssociate/ejStatus int Service status: Status for Service user: Normal; Unavailable / holiday; Deleted; Read-only
personAssociate/credentialType None Auth. type: What type of credentials to use when this user logs in x
personAssociate/credentialDisplayValue None Auth. value: Credential value (public, visible part) to be used when this user logs in x
personAssociate/isActive bool Active: Is this user active, and should be able to log in? x
personAssociate/isActiveText bool Active status: Is this user active, and should be able to log in? x
personAssociate/portraitThumbnail None Person image: Person image
personAssociate/otherGroups userGroup Other groups: Other groups
personAssociate/userName string User name: User name x
personAssociate/personEmail string E-mail x
personAssociate/locationAddress string Location: Location x
personAssociate/isLocation bool Is a location: Is a location x
correspondingAssociate/firstName string First name: Displays the contact's first name x
correspondingAssociate/lastName string Last name: Displays the contact's last name x
correspondingAssociate/middleName string Middle Name : Displays the contact's middle name. x
correspondingAssociate/fullName string Full name: Displays full name of user (first, middle, last - according to settings) x
correspondingAssociate/contactId int Company ID: Database ID of the company the user belongs to
correspondingAssociate/personId int Contact ID: Database ID of the contact row
correspondingAssociate/mrMrs string Mr/Ms: Displays whether the contact is addressed as Mr or Ms x
correspondingAssociate/title string Title: Displays whether the contact is addressed as Mr or Ms x
correspondingAssociate/associateDbId associate ID x
correspondingAssociate/contactName string Owning company: Name of the company the user belongs to x
correspondingAssociate/contactDepartment string Owning department: Name of the department at the company the user belongs to x
correspondingAssociate/usergroup userGroup Primary group: The user's primary user group x
correspondingAssociate/usergroupId int Group ID: The user's primary user group x
correspondingAssociate/contactFullName string Owner: Name and department of the company the user belongs to x
correspondingAssociate/contactCategory listAny Category: Category x
correspondingAssociate/role listAny Role : Role x
correspondingAssociate/assocName associate User ID : User ID x
correspondingAssociate/assocTooltip string Description : Description
correspondingAssociate/assocType listAny Type: Type of user: associate, external user, system user, anonymous account x
correspondingAssociate/ejUserId int Service user ID: The database ID of a Service user
correspondingAssociate/simultaneousEjUser bool Simultaneous Service user: If this flag is set, then the user will only have access if the maximum number of simultaneous users is not exceeded
correspondingAssociate/ejDisplayName string Nick name: User's nick name in Service x

Supported Columns (cont.)

Name Restriction Description OrderBy
correspondingAssociate/ejStatus int Service status: Status for Service user: Normal; Unavailable / holiday; Deleted; Read-only
correspondingAssociate/credentialType None Auth. type: What type of credentials to use when this user logs in x
correspondingAssociate/credentialDisplayValue None Auth. value: Credential value (public, visible part) to be used when this user logs in x
correspondingAssociate/isActive bool Active: Is this user active, and should be able to log in? x
correspondingAssociate/isActiveText bool Active status: Is this user active, and should be able to log in? x
correspondingAssociate/portraitThumbnail None Person image: Person image
correspondingAssociate/otherGroups userGroup Other groups: Other groups
correspondingAssociate/userName string User name: User name x
correspondingAssociate/personEmail string E-mail x
correspondingAssociate/locationAddress string Location: Location x
correspondingAssociate/isLocation bool Is a location: Is a location x
name stringorPK Company name x
department string Department x
nameDepartment None Company: Displays the company an activity is linked to x
associateId associate Our contact: Displays our contact x
category listAny Category x
business listAny Business x
country listAny Country: This criterion corresponds to the Country field on the Company card. x
countryId int Country ID: Country ID x
number string Number x
code string Code x
orgnr string VAT No. x
stop bool Stop x
contactNoMail bool No mailings (company x
updatedBy associate Updated by: The user who last updated the data x
updatedByFullName associate Updated by - Full name: The user who last updated the data x
updatedDate date Updated: The date/time the data was last updated in UTC. x
registeredBy associate Registered by: The user who registered the data x
registeredByFullName associate Registered by - Full name: The user who registered the data x
registeredDate date Registered date: The date/time the data was registered in UTC. x
contactSource listAny Source: Source (Company) x
contactDeleted bool Deleted: Deleted x
activeErpLinks bool ERP connected: Is there an active ERP Sync? x
deletedDate datetime Deleted date: Deleted date
mainContact None Main contact: Main contact for this company x
contactPhone/formattedNumber string Telephone - Phone: Displays phone number
contactPhone/description string Telephone - Description: Phone number description x
postAddress/addressId int Postal address - Address ID: Database ID for the address record x
postAddress/line1 string Postal address - Address 1: First line of the address x
postAddress/line2 string Postal address - Address 2: Second line of the address x
postAddress/line3 string Postal address - Address 3: Third line of the address x
postAddress/county string Postal address - County: This criterion corresponds to the County field on the Company card. It will only be visible if required by a country's address format. x
postAddress/city string Postal address - City: This criterion corresponds to the City field on the Company card. x
postAddress/zip string Postal address - Postcode: This criterion corresponds to the Zip Code field on the Company card. x
postAddress/state string Postal address - State: This criterion corresponds to the State field on the Company card. \It will only be visible if required by a country's address format. x
postAddress/wgs84latitude decimal Postal address - Latitude: Latitude x
postAddress/wgs84longitude decimal Postal address - Longitude: Longitude x
postAddress/formattedAddress None Postal address - {formattedAddress}: {formattedAddress}
postAddress/formattedMultiLineAddress None Postal address - {formattedAddress}: {formattedAddress}
streetAddress/addressId int Street address - Address ID: Database ID for the address record x
streetAddress/line1 string Street address - Address 1: First line of the address x
streetAddress/line2 string Street address - Address 2: Second line of the address x
streetAddress/line3 string Street address - Address 3: Third line of the address x
streetAddress/county string Street address - County: This criterion corresponds to the County field on the Company card. It will only be visible if required by a country's address format. x
streetAddress/city string Street address - City: This criterion corresponds to the City field on the Company card. x
streetAddress/zip string Street address - Postcode: This criterion corresponds to the Zip Code field on the Company card. x
streetAddress/state string Street address - State: This criterion corresponds to the State field on the Company card. \It will only be visible if required by a country's address format. x
streetAddress/wgs84latitude decimal Street address - Latitude: Latitude x
streetAddress/wgs84longitude decimal Street address - Longitude: Longitude x
streetAddress/formattedAddress None Street address - {formattedAddress}: {formattedAddress}
streetAddress/formattedMultiLineAddress None Street address - {formattedAddress}: {formattedAddress}
contactAssociate/firstName string First name: Displays the contact's first name x
contactAssociate/lastName string Last name: Displays the contact's last name x
contactAssociate/middleName string Middle Name : Displays the contact's middle name. x
contactAssociate/fullName string Full name: Displays full name of user (first, middle, last - according to settings) x
contactAssociate/contactId int Company ID: Database ID of the company the user belongs to
contactAssociate/personId int Contact ID: Database ID of the contact row
contactAssociate/mrMrs string Mr/Ms: Displays whether the contact is addressed as Mr or Ms x
contactAssociate/title string Title: Displays whether the contact is addressed as Mr or Ms x
contactAssociate/associateDbId associate ID x
contactAssociate/contactName string Owning company: Name of the company the user belongs to x
contactAssociate/contactDepartment string Owning department: Name of the department at the company the user belongs to x
contactAssociate/usergroup userGroup Primary group: The user's primary user group x
contactAssociate/usergroupId int Group ID: The user's primary user group x
contactAssociate/contactFullName string Owner: Name and department of the company the user belongs to x
contactAssociate/contactCategory listAny Category: Category x
contactAssociate/role listAny Role : Role x
contactAssociate/assocName associate User ID : User ID x
contactAssociate/assocTooltip string Description : Description
contactAssociate/assocType listAny Type: Type of user: associate, external user, system user, anonymous account x
contactAssociate/ejUserId int Service user ID: The database ID of a Service user
contactAssociate/simultaneousEjUser bool Simultaneous Service user: If this flag is set, then the user will only have access if the maximum number of simultaneous users is not exceeded
contactAssociate/ejDisplayName string Nick name: User's nick name in Service x
contactAssociate/ejStatus int Service status: Status for Service user: Normal; Unavailable / holiday; Deleted; Read-only
contactAssociate/credentialType None Auth. type: What type of credentials to use when this user logs in x
contactAssociate/credentialDisplayValue None Auth. value: Credential value (public, visible part) to be used when this user logs in x
contactAssociate/isActive bool Active: Is this user active, and should be able to log in? x
contactAssociate/isActiveText bool Active status: Is this user active, and should be able to log in? x
contactAssociate/portraitThumbnail None Person image: Person image
contactAssociate/otherGroups userGroup Other groups: Other groups
contactAssociate/userName string User name: User name x
contactAssociate/personEmail string E-mail x
contactAssociate/locationAddress string Location: Location x
contactAssociate/isLocation bool Is a location: Is a location x
contactInterestIds listInterest Company Interest: This criterion corresponds to the Interests tab on the Company card.
isMailingRecipient bool Is mailing recipient: isMailingRecipient x
hasStoreConsent bool Consent - Sales and service: The purpose to store data about this contact is to sell to and/or provide services to this contact. This purpose is usually used when storing contacts who are defined as potential or existing customers.
withdrawnStoreConsent bool Consent is withdrawn - Sales and service: The purpose to store data about this contact is to sell to and/or provide services to this contact. This purpose is usually used when storing contacts who are defined as potential or existing customers.
hasEmarketingConsent bool Consent - E-marketing: The purpose is to gain the explicit consent to communicate electronically (bulk e-mail) on topics related to our products and services. This might include newsletters, invitations and product-related content. The subscription system is used to refine the individual marketing choices this contact makes.
withdrawnEmarketingConsent bool Consent is withdrawn - E-marketing: The purpose is to gain the explicit consent to communicate electronically (bulk e-mail) on topics related to our products and services. This might include newsletters, invitations and product-related content. The subscription system is used to refine the individual marketing choices this contact makes.

Supported Columns (cont.)

Name Restriction Description OrderBy
subscription listAny Subscription: Subscription for marketing x
legalBaseStore listAny Legal basis - Sales and service: The purpose to store data about this contact is to sell to and/or provide services to this contact. This purpose is usually used when storing contacts who are defined as potential or existing customers. x
legalBaseEmarketing listAny Legal basis - E-marketing: The purpose is to gain the explicit consent to communicate electronically (bulk e-mail) on topics related to our products and services. This might include newsletters, invitations and product-related content. The subscription system is used to refine the individual marketing choices this contact makes. x
consentSourceStore listAny Source - Sales and service: The purpose to store data about this contact is to sell to and/or provide services to this contact. This purpose is usually used when storing contacts who are defined as potential or existing customers. x
consentSourceEmarketing listAny Source - E-marketing: The purpose is to gain the explicit consent to communicate electronically (bulk e-mail) on topics related to our products and services. This might include newsletters, invitations and product-related content. The subscription system is used to refine the individual marketing choices this contact makes. x

Sample

GET /api/v1/archive/personfavourites?$select=personExtra/x_person_shorttext_list,personAssociate/firstName,personAssociate/simultaneousEjUser,personAssociate/ejStatus,department
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

See also: IArchiveAgent.

In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top