Namespace CRMScript.NetServer

Classes

NSAccessGatewayInfo

Access gateway related data and operations. Carrier object for AccessGatewayInfo.

NSActivityFilter

Activity list filter information. Carrier object for ActivityFilter.

NSActivityInformationListItem

Carrier object for ActivityInformationListItem.

NSActivitySummary

Activity information summary - number of free and busy activities. Carrier object for ActivitySummary.

NSActivitySummaryItem

Summary details about appointments and documents.

NSAIAgent

AI services, such as Translation, Statistics, Sentiment analysis, backed by calls to Public Cloud providers.

NSAppointmentAgent

Collection of all services that works with Appointment data.

NSAppointmentEntity

Appointments appear in the diary, and have links to a Contact/Person and possibly a Project or Sale. They have start and end time+date.

NSApproveRejectResponse

Contains a PluginResponse and an appointment ID if the operation created one.

NSArchiveColumnData

Data carrier class for an item (cell) in an archive. Contains properties and members for three distinct values: The (visible) display value; the tooltip hint, and the link hint.

Information about the definition and properties of an archive display column. It is used by the archive MDO providers to construct column lists for the configuration dialogs, and by the archive control to know what type (and other properties) each column has. The class is serializable and used on both the application and web server sides.

NSArchiveConfiguration

Used to store and fetch the configuration of an archive. The configuration consists of entities and columns; entities correspond to archive provider entities and the checkboxes you see in the bottom of standard archives. Column configuration includes both what columns should be visible, what order they are in (left to right), and whether the archive rows should be sorted by one or more columns.

Desired columns can be set through the selectable MDO list called archiveColumns:<perovider name>, and entities can be set through the selectable MDO list archiveEntities:<provider name>. You can also use the SetChosenEntities and SetChosenColumns method of this service. The selectable MDO list implementation is suitable for data binding using mdo list controls.

NSArchiveListItem

NSArchiveListResult

Header/Detail variant of archive result, with a Row Count plus the actual rows. Future extensions may include other header data on the same level as the RowCount.

NSArchiveOrderByInfo

Carries information about an ordering criterion for an archive.

NSArchiveRestrictionGroup

Carrier for restriction group. Contains all the search restrictions for the group - that is, ArchiveRestrictionInfo - objects, including info such as rank and name.

NSArchiveRestrictionInfo

Carries information about a restriction on the query of an archive provider.

NSArea

Carrier object for Area.

NSAssociate

Carrier object for Associate.

NSAssociateAgent

Associate utilities, notes, not user administration.

NSAttachmentEntity

NSBatchAgent

Start, stop and monitor predefined batch tasks.

NSBatchTaskInfo

Contains information about one batch task.

NSBLOBAgent

Collection of all services that work with binary objects (BLOBS). For example, images and documents.

NSBlobEntity

Carrier object for BlobEntity.

NSBusiness

Carrier object for Business.

NSCarrier

NSCategorizationModelDetails

Details about a categorization model in HugoAI. Carrier object for CategorizationModelDetails

NSCategorizationStatusResponse

Carrier to describe the current categorization training status for a tenant in HugoA. Carrier object for CategorizationStatusResponse.

NSCategory

Carrier object for Category.

NSCategoryGuess

Currently not used!

NSChangedData

Generic carrier, used in return values to indicate what data NetServer has changed 'behind the scenes' so clients can know what to update.

NSChangedDataItem

Table name/record ID pair used to refer to records.

NSChatAgent

Chat functions. Manage chat channels, sessions, and messages.

NSChatBotSettings

Chat topic bot settings. Trigger script ids to run on bot events. Carrier object for ChatBotSettings.

NSChatMessage

A message in a chat session. Carrier object for ChatMessage.

NSChatOpeningHours

Chat topic opening hour. Carrier object for ChatOpeningHours.

NSChatPresence

Represents presence information for a chat user, bundled with some other useful information. Carrier object for ChatPresence.

NSChatSession

Use the ChatSessionEntity on the Chat agent instead. Chat sessions belong to a chat topic, and contain messages to/from users. Carrier object for ChatSession.

NSChatSessionEntity

Chat sessions belong to a chat topic, and contain messages to/from users. Carrier object for ChatSessionEntity.

NSChatSummaryItem

Chat session summary: id, title, created date. Carrier object for ChatSummaryItem.

NSChatTopicAgent

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

NSChatTopicEntity

Chat topics define who is assigned, when the channel is open for business, and look of the chat widget. Carrier object for ChatTopicEntity.

NSChatWidgetSettings

Defines the look of the chat widget. Carrier object for ChatWidgetSettings.

NSCheckLicenseStatusResult

Result of NSCheckLicenseStatus.

NSCheckoutInfo

Information about the checked-out state of one document, describing whether it is checked out, and to whom.

NSCommandInfo

An instance of this class describes a custom command, declared and implemented by a document plugin.

NSCompetitor

Carrier object for Competitor.

NSConfigurationAgent

User interface configuration* XML and other elements such as inter-client URLs.

NSConsentInfo

Consent information for a give person. Consents are for a particular Purpose, and may be withdrawn (see LegalBase).

NSConsentPerson

Carrier object for ConsentPerson.

NSConsentPurpose

Carrier object for ConsentPurpose.

NSConsentSource

Carrier object for ConsentSource.

NSContact

Carrier object for Contact.n

NSContactActivity

Carrier object for ContactActivity.

NSContactAgent

Contact (company) data services.

NSContactEntity

The Contact Service. Implements all services working with the Contact object.

NSContactPersonId

NSContactRelationEntity

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

NSContactSummary

Summary of contact with recent activities, chats, and requests included.

NSCountry

Carrier object for Country.

NSCredential

Credentials supported for authentication

NSCredentialsGroup

When the CredentialType's control is of type link, the user is selected from a source like active directory. This will then be the organisational unit (e.g. user security group) in active directory. Only one group is listed if the system does not support groups.

NSCredentialsGroupUsers

The users within a user group.

NSCredentialType

Description of credential type

NSCredentialUser

Information about a users credentials in a foreign system that can be bound to a SuperOffice user (associate)

NSCredited

Carrier object for Credited.

NSCriteriaInformation

Carrier for criteria information. It contains all the search criteria - that is, ArchiveRestrictionInfo - objects, including a column specification. In addition, it contains the same criteria expressed as an archive, with an array of ArchiveColumnInfo specifications and a set of ArchiveRow rows. The rows of the archive form a subset of the restriction array.

NSCsFeatureToggle

Carrier object for CsFeatureToggle.

NSCsSessionKey

Carrier object for CsSessionKey.

NSCurrency

Carrier object for Currency.

NSCurrencyEntity

Carrier object for CurrencyEntity.

NSCustomerCenterConfig

Contains configuration when displaying the Customer Center. Carrier object for CustomerCenterConfig.

NSCustomerLanguage

Customer languages that customer center supports. Carrier object for CustomerLanguage.

NSCustomerServiceAgent

Agent used for Customer Service methods.

NSCustomerServiceStartup

Contains various data needed by Service for startup.

Do not use this API, as it is for internal use and might change without notice.

NSDash

Carrier object for NSDash.

NSDashAgent

Carrier object for managing various dashboard operations.

NSDashCollection

Carrier object for NSDashCollection.

NSDashTheme

Represents a dashboard theme configuration.

NSDashTile

Represents a tile in a dashboard configuration.

NSDashTileDefinition

Defines a dashboard tile with various settings.

NSDashTileHtml

Represents an HTML tile within a dashboard with language and HTML content settings.

NSDataRight

Carrier object for DataRight.

NSDataRights

Carrier object for DataRights.

NSDayInformationListItem

Summary information about the activities and holidays for one day.

NSDeliveryTerm

The built-in delivery terms list. Used by the SuperOffice Quote Connector in quote versions.

NSDeliveryType

The built-in delivery types list. Used by the SuperOffice Quote Connector in quote versions.

NSDepartment

Also known as User Group.

NSDiagnosticsAgent

Diagnostics, usage data collection, caches, and flushing

NSDiaryViewEntity

The DiaryView Service. The service implements all services working with the DiaryView object.

NSDocument

Carrier object for Document.

NSDocumentAgent

Collection of all services that work with Document data. This is services for the document information, not the physical document themselves. These are handled by the BLOB service methods.

NSDocumentEntity

NSDocumentPreview

Document data intended for preview purposes. Carrier object for DocumentPreview.

NSDocumentTemplate

The template a document is based on is stored in the SO arc\template folder on the server. This will return the name as displayed in the GUI, and not the physical document name, of the template the document object is based on.

NSDocumentTemplateEntity

NSDSAParameters

NSDuplicateEntry

Carrier object for DuplicateEntry.

NSDuplicateRule

Carrier object for DuplicateRule.

NSEMailConnectionInfo

All information needed to connect to a mail server.

NSEntityElement

Generic carrier object for entity elements such as Phone, EntityElement, Url. These elements do not have id and rank. These values are changed on each save, and should not be depended on. When used in a list or array the rank is the ascending list order. Carrier object for EntityElement.

NSEntityName

Carrier object for EntityName.

NSEventData

Data related to event handlers.

NSExportArchiveResult

NSExtAppEntity

Contains information on an external application.

NSExtendedLicenseInfo

NSExtendedModuleLicense

NSFavourite

Favourite carrier.

NSFavouriteAgent

Agent used for retrieving and setting favorites.

NSFieldInfoAttachment

Attachment custom database field.

NSFieldInfoBase

Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.

NSFieldInfoBool

Boolean custom database field. Typically rendered as a checkbox.

NSFieldInfoDate

Date custom database field. Time component is ignored.

NSFieldInfoDateTime

Date + time custom database field.

NSFieldInfoDecimal

Decimal (double precision) custom database field.

NSFieldInfoDynamicLink

Dynamic Link custom database field.

NSFieldInfoInt

Integer custom database field.

NSFieldInfoListText

NSFieldInfoLongText

Long Text custom database field.

NSFieldInfoMdoList

MDO List custom database field.

NSFieldInfoRelation

Relation to other table database field.

NSFieldInfoShortText

Short text string custom database field.

NSFieldInfoTime

Time custom database field. Date value is ignored.

NSFieldInfoTimeSpan

Timespan custom database field. Number of minutes, represented as days/hours/minutes.

NSFieldMetadata

Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.

NSFieldProperty

NSFieldRight

NSFindAgent

Find functions.

NSFindResults

Result carrier for the Find operation. It contains a set of column specifications, and a set of row, where each row contains the columns. The row set is the result of carrying out some search operation.

NSForeignAppEntity

Carrier object for ForeignAppEntity.n

NSForeignDevice

Saves a foreign device belonging to the ForeignDevice and application name specified.

NSForeignKey

Carrier object for ForeignKey.

NSForeignSystemAgent

Collection of all services that works with Foreign key data (Key/Value pairs)

NSFormEntity

Definition and configuration of a Form.

NSFormSubmissionEntity

Content of a Form submission.

NSFreeText

Used to manage freetext search.

NSFreeTextAgent

This agent can be used to manage the free text system.

NSGrantedModuleLicense

NSHeadingEntity

The heading entity contains generic list item information.

NSHierarchyEntity

NSHistory

The usage history of the currently logged in user is represented as History objects.

NSHistoryRequest

Specification for a request for history information, by ID. It is possible to ask for rights for a new record (insert), but then you need to supply the parent ID for entities that have parents (projectmember, selectionmember, person).

NSImage

NSImportAgent

This agent can be used to import data into the system.

NSImportColumnInfo

Column info for import lines.

NSImportErpData

Used to import data into the system. Representing one entity that will be imported.

NSImportLine

Used to import data into the system. Representing one entity that will be imported.

NSIncomingMessage

Details about a message to be sent.

NSKbCategory

NSLanguageInfo

NSLegalBase

Carrier object for LegalBase.

NSLicenseAgent

License query, download, activation.

NSLicenseInfo

Represents all licenses for this owner at this site.

NSLicenseOwner

Carrier object for LicenseOwner.

NSLicenseResult

Carrier object for LicenseResult.

NSLink

Links two entities (contacts/projects/sales/URLs) together.

NSListAgent

Collection of all services that work with Lists. These are typical lists of data shown in dropdown-list, checkbox lists, etc.

NSListEntity

The list entity contains information about a specific list.

NSListItem

NSListItemEntity

The list item entity contains generic list item information.

NSLocalizedField

Carrier object for LocalizedField.

NSLocalizedText

NSMailbox

Carrier containing information about a Service mailbox.

NSMailboxEntity

NSMailMergeSettings

Settings specifying what selection to perform the mailmerge on, what merge document to use etc.

NSMailMergeTask

Properties describing a task to create on recipients of a mail merge.

NSMarketingAgent

Agent used for Marketing functions, such as Forms.

NSMDOAgent

MDO Lists, reading, searching, and item lookup.

NSMDOListItem

Carrier object for MDOListItem.

NSMessageDeliveryStatus

Describes the message status.

NSMessagingAgent

SMS and other external messaging systems.

NSModuleLicense

Represents a single module license info.

NSModuleLicenseLink

Carrier object for ModuleLicenseLink.

NSMrMrs

NSMultiAlarmData

Carrier object for MultiAlarmData.

NSNavigatorAgent

Navigator stuff.

NSNavigatorCompany

Carrier object for NavigatorCompany.

NSNumberAllocationAgent

This agent can be used to manage number allocation.

NSOutgoingMessage

Details about a message to be sent.

NSParticipantInfo

Represents an appointment participant.

NSParticipantSyncData

Carrier object for ParticipantSyncData.

NSPaymentTerm

The built-in payment terms list. Used by the SuperOffice Quote Connector to categorize quote versions.

NSPaymentType

The built-in payment types list. Used by the SuperOffice Quote Connector in quote versions.

NSPerson

Carrier object for Person.

NSPersonAgent

Person data services.

NSPersonEntity

The Person Service. The service implements all services working with the Person object.

NSPersonSummary

Summary of person, with recent activities, chats, and requests included.

NSPhoneListAgent

Collection of all services for searching for person or contact (company) phone numbers.

NSPhoneListItem

NSPhoneListPreferences

Search preferences for a phone list search.

NSPluginResponse

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled Place Order button.

NSPluginUrlResponse

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled “Place Order” button. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

NSPocketAgent

Agent with Pocket specific functionality.

NSPocketDeviceInfo

Describes a device running Pocket CRM.

NSPocketNotificationMessage

Describes behavior and content for a push notification message.

NSPocketStartupData

The Pocket Service. The service implements pocket specific stuff, like consolidated post-login stuff.

NSPosition

Carrier object for Position.

NSPreference

One preference item, which contains a specification (section/key), the raw string value, and the level at which this value was found.

NSPreferenceAgent

Preferences, user interface tab configuration.

NSPreferenceDescription

Preference description, drives the Preference GUI. Maintenance client - controls all preferences in SuperOffice.

NSPreferenceDescriptionLine

Preference description line, contains information about a single item in a preference description list.

NSPreferenceSpec

Preference specification, consisting of the section name and key name.

NSPreviewDash

Represents a preview of a dashboard.

NSPreviewDashTile

Represents a tile within a preview dashboard.

NSPreviewMailing

NSPreviewMailingHeader

NSPreviews

This service provides Previews. It is based on 'Preview hints', strings that may either be a Preview text (if provided by someone else), or a set of key/value pairs or other specifications.

NSPreviewsAgent

Gets preview strings from a hint.

NSPriceList

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

NSPriority

Carrier object for Priority

NSProduct

Information about a Product from the ERP system. This may be fetched from SuperOffice Product table through the SO Connector.

NSProductCategory

The built-in product category list. Used by the SuperOffice Quote Connector to categorize products.

NSProductExtraDataField

A way to show some simple extra data on a product, typically to hep the user to identify the correct product. Basically a bucket of additional info that the ERP system would like to store and show in the user interface. Information placed here is shown in the GUI if the provide-extra-data capability is true.

NSProductFamily

The built-in product family list. Used by the SuperOffice Quote Connector to categorize products.

NSProductType

The built-in product type list. Used by the SuperOffice Quote Connector to categorize products.

NSProject

Carrier object for Project.

NSProjectAgent

Collection of all services that work with Project data.

NSProjectEntity

The Project Service. The service implements all services working with the Project object.

NSProjectEvent

A project that is also an event. Used by Audience.

NSProjectEventEntity

The ProjectEvent Service. The service implements all services working with the ProjectEvent object

NSProjectMember

A person can be a member of multiple projects, with a different comment and member type in each project.

NSProjectStatus

Carrier object for ProjectStatus.

NSProjectType

Carrier object for ProjectType.

NSProjectTypeEntity

Carrier object for ProjectTypeEntity.

NSProjectTypeStatusLink

NSProvidedCredential

NSProviderInfo

Information about a provider plugin.

NSQuickReply

NSQuote

Quote carrier with the active quote version and favorite alternative.

NSQuoteAgent

Services for the Quote Management feature, part of the Sale module.

NSQuoteAlternative

Information about a connection to the ERP system.

NSQuoteAlternativeRecalculated

The QuoteAlternativeRecalculated is returned after a call to RecalculateQuoteAlternative. It contains flags indicating changes to quote alternative and quote lines.

NSQuoteConnection

Information about a connection to the ERP system.

NSQuoteContext

The context a quote is created in.

NSQuoteEntity

Quote methods.

NSQuoteLine

Information about a connection to the ERP system.

NSQuoteLineConfiguration

Contains information about which configuration fields that is visible in the GUI. Read only and mandatory fields are also specified.

NSQuoteListItem

One line in a list.

NSQuotePublishDocuments

Prepare the documents required to publish a quote - Email, main document as pdf, quoted products as pdf, attachments.

NSQuoteVersion

Information about a version of the.

NSQuoteVersionAttachment

Attachment documents for a given version of a Quote.

NSQuoteVersionButtonState

Information about possible button actions for the quote version dialog.

NSQuoteVersionStatusInformation

Information about possible button actions for the quote version dialog.

NSQuoteVersionValidated

The QuoteVersionValidated is returned after a call to ValidateQuoteAlternative. It contains flags indicating changes to quote, quoteversion/quotealternative and quotelines.

NSQuoteVersionWorkflowState

Information about possible button actions for the quote version dialog.

NSRating

Sale Stage with probability percent.

NSReason

Reason for a lost sale.

NSReasonSold

Reason for a successfully sold sale.

NSReasonStalled

NSRecipientStatistics

Carrier object for RecipientStatistics.

NSRecurrenceDate

NSRecurrenceDayPattern

NSRecurrenceInfo

NSRecurrenceMonthPattern

NSRecurrenceWeekPattern

NSRecurrenceYearPattern

NSRedLetterDetails

Red-letter day text details, all the texts related to the given day.

NSRedLetterInformationListItem

Detailed information on red-letter days, including both holidays and other days with their individual texts.

NSRedLetterSummary

Summary of red-letter day information - holiday in own country, and in other countries known to the system.

NSRefCountEntity

A refcount entity for a number allocation.

NSRelationAgent

Contact/Person relations.

NSRelationDefinitionEntity

A relation definition entity with source and destination tables.

NSRelationToOwner

NSReplicationAgent

Replication/Travel administration.

NSReplyTemplate

NSReportAgent

Run reports, set favorites, labels.

NSReportEntity

NSReportLabelLayoutEntity

NSResolvedPerson

The Person Service. The service implements all services working with the Person object.

NSResolvedUser

The User Service. The service implements all services working with the User object.

NSResourceAgent

String resource substitution management.

NSResourceEntity

The resource entity contains resource information.

NSResourceOverride

The resource entity contains resource information.

NSReturnInfo

Return value object for Document Plugin API calls.

NSRole

Users role for role-based security.

NSRoleEntity

NSSaintAgent

Administration and maintenance of SAINT counters and statuses.

NSSaintConfiguration

Definition of the three periods for status monitors and some other settings per saint entity.

NSSale

NSSaleAgent

Sale data services.

NSSaleEntity

The Sale Entity contains the sale amount, currency, and sale members. Sales are linked to contacts, persons, and/or projects.

NSSalesActivity

NSSaleStageEntity

This entity represents a sale stage with a default percentage rating.

NSSaleStakeholder

NSSaleSummary

NSSaleSummaryItem

Sale Summary item.

NSSaleType

NSSaleTypeEntity

NSSaleTypeStageLink

NSSatellite

NSSelectableMDOListItem

NSSelectionAgent

Selections, entities, members and tasks

NSSelectionAgent agent;
agent.callMethod(arg1, arg2);

NSSelectionCategory

NSSelectionEntity

NSSelectionForFind

NSSelectionMemberEditValues

Carrier object for SelectionMemberEditValues.

NSSentiment

NSSentryAgent

Data and function right queries.

NSServiceAuth

Properties for service authentication.

NSShipmentMessageBlockEntity

NSShipmentMessageEntity

NSSignedPublicKey

Represents all licenses for this owner at this site.

NSSmsConfig

SMS settings for Customer Service SMS providers.

NSSmtpTestResult

Carrier containing information about the result of a SMTP test.

NSSoPrincipalCarrier

NSSoSystemInfoCarrier

NSSource

Source of a sale.

NSStatisticsDataSet

NSStatisticsDataValue

Contains a single data value in a data set, used by CS for Status Screen reports.

NSStatusMonitor

Definition of all properties for a status monitor.

NSStatusMonitorPeriods

Obsolete, use SaintConfiguration carrier and methods instead. Was:Definition of the three periods for status monitors.

NSStream

NSSuggestedAppointment

NSSuggestedAppointmentEntity

NSSuggestedDocumentEntity

NSSystemEventEntity

Entity for system events.

NSTableRight

NSTabOrder

NSTag

NSTask

Type of an appointment.

NSTaskListItem

NSTemplateInfo

Information about a document template, i.e., a document that generally contains unresolved merge tags and that is used as the source for creating new documents.

NSTemplateVariablesParameters

Parameters specifying source and properties for template variable substitution.

NSTemporaryKeyInfo

The fields returned when checking a temporary key.

NSTicket

NSTicketAgent

Agent used for Ticket functions.

NSTicketCategory

NSTicketCategoryEntity

Describes the meta data for a ticket category, and provides special operations on it.

NSTicketEntity

Represents a service ticket.

NSTicketInfo

A small carrier that contains information about a ticket.

NSTicketMessage

The TicketMessage carrier is used for representing a service ticket message.

NSTicketMessageEntity

The ticket messages are e-mails, SMS or other messages attached to a ticket (aka request).

NSTicketMessageHeader

Contains information about a header connected to a ticket message.

NSTicketPriority

NSTicketPriorityEntity

Entity for a ticket priority. This entity describes the meta data for a ticket priority, and provides special operations on it.

NSTicketStatusEntity

Entity for a ticket status. This entity describes the meta data for a ticket status, and provides special operations on it.

NSTicketSummaryItem

The ticket summary with heading, created date.

NSTimeZoneAgent

TimeZone maintenance.

NSTimeZoneData

Information about a TimeZone.

NSTimeZoneRule

Information about a rule for a TimeZone.

NSTokenManagementInfo

NSTooltipsAgent

Tooltip system, hint to text transformation.

NSTypicalSearch

NSTypicalSearches

NSUntrustedCredentials

Credentials for external authentication.

NSUser

SuperOffice User, with login credentials and an associated person.

NSUserAgent

User administration.

NSUserDefinedFieldInfo

Can be used to mirror the layout of the user-defined fields in the user interface.

NSUserDefinedFieldInfoAgent

Returns information about user-defined fields, like field type, field size, field label text, default value. Does not return the actual values in the user-defined fields. The values are returned on the entity objects.