"ExistingCategoryMembers"

•

Environment: onsite, online

• 4 minutes to read

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

Archive of ExistingCategoryMembers - used by the web api. Lists existing CategoryMembers in table and edited or removed ones through restriction.

Supported Entities

Name	Description
"existingCategoryMember"	[existingCategoryMember]

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
removedRows	string
editedRows	string
categoryMembershipId	int	ID: ID	x
categoryId	int	Category ID: Category ID	x
weight	int	Weight: Weight	x
isDefinedByUsergroup	bool	From user group: From user group	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	string	Full name: Displays full name of user (first, middle, last - according to settings)	x
contactId	int	Company ID: Database ID of the company the user belongs to
personId	int	Contact ID: Database ID of the contact row
mrMrs	string	Mr/Ms: Displays whether the contact is addressed as Mr or Ms	x
title	string	Title: Displays whether the contact is addressed as Mr or Ms	x
associateDbId	associate	ID	x
contactName	string	Owning company: Name of the company the user belongs to	x
contactDepartment	string	Owning department: Name of the department at the company the user belongs to	x
usergroup	userGroup	Primary group: The user's primary user group	x
usergroupId	int	Group ID: The user's primary user group	x
contactFullName	string	Owner: Name and department of the company the user belongs to	x
contactCategory	listAny	Category: Category	x
role	listAny	Role : Role	x
assocName	associate	User ID : User ID	x
assocTooltip	string	Description : Description
assocType	listAny	Type: Type of user: associate, external user, system user, anonymous account	x
ejUserId	int	Service user ID: The database ID of a Service user
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
ejDisplayName	string	Nickname: User's nickname in Service	x
ejStatus	int	Service status: Status for Service user: Normal; Unavailable / holiday; Deleted; Read-only
credentialType	None	Auth. type: What type of credentials to use when this user logs in	x
credentialDisplayValue	None	Auth. value: Credential value (public, visible part) to be used when this user logs in	x
isActive	bool	Active: Is this user active, and should be able to log in?	x
isActiveText	bool	Active status: Is this user active, and should be able to log in?	x
portraitThumbnail	None	Person image: Person image
otherGroups	userGroup	Other groups: Other groups
userName	string	User name: User name	x
personEmail	string	E-mail	x
locationAddress	string	Location: Location	x
isLocation	bool	Is a location: Is a location	x

Sample

GET /api/v1/archive/ExistingCategoryMembers?$select=usergroup,personId,usergroupId
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv