Interface IListAgent

Interface for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[Agent("List Agent", "Interface for the List Agent. Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.")]
public interface IListAgent : IAgent
Examples
using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   using (ListAgent agent = new ListAgent())
   {
      // call methods on agent here...
   }
}

Methods

AddFromListDefinitionAsync(int, ListItemEntity, CancellationToken)

Save a new list item for the specified list defintion

Declaration
Task<ListItemEntity> AddFromListDefinitionAsync(int udListDefinitionId, ListItemEntity item, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The name of the list definition, indicating which list to save the item to.
ListItemEntity item

The item to save
CancellationToken cancellationToken
Returns
Type Description
Task<ListItemEntity>

The saved list item

AddFromListNameAsync(string, ListItemEntity, CancellationToken)

Save a new list item for the specified list defintion

Declaration
Task<ListItemEntity> AddFromListNameAsync(string udListDefinitionName, ListItemEntity item, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string udListDefinitionName

The name of the list definition, indicating which list to save the item to.
ListItemEntity item

The item to save
CancellationToken cancellationToken
Returns
Type Description
Task<ListItemEntity>

The saved list item

AddHierarchyToPathAsync(Domain, string, string, CancellationToken)

Add a hierarchy item to a path

Declaration
Task<HierarchyEntity> AddHierarchyToPathAsync(Domain domain, string path, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Domain domain

Type of items to get
string path

Hierarchy path to parent item
string name

Name of node to add
CancellationToken cancellationToken
Returns
Type Description
Task<HierarchyEntity>

The hierarchy node added to the path

ChangeCurrencyAsync(double, string, string, CancellationToken)

Recalculates the amount to the new currency.

Declaration
Task<double> ChangeCurrencyAsync(double amount, string fromCurrency, string toCurrency, CancellationToken cancellationToken = default)
Parameters
Type Name Description
double amount

The amount in the old currency
string fromCurrency

The old currency name
string toCurrency

The new currency name
CancellationToken cancellationToken
Returns
Type Description
Task<double>

Amount in new currency

CreateDefaultAmountClassEntityAsync(CancellationToken)

Loading default values into a new AmountClassEntity.

Declaration
Task<AmountClassEntity> CreateDefaultAmountClassEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<AmountClassEntity>

New AmountClassEntity with default values

CreateDefaultCategoryEntityAsync(CancellationToken)

Loading default values into a new CategoryEntity.

Declaration
Task<CategoryEntity> CreateDefaultCategoryEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<CategoryEntity>

New CategoryEntity with default values

CreateDefaultCountryAsync(CancellationToken)

Gets a new country

Declaration
Task<Country> CreateDefaultCountryAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Country>

A new country with default values

CreateDefaultCurrencyEntityAsync(CancellationToken)

Loading default values into a new CurrencyEntity.

Declaration
Task<CurrencyEntity> CreateDefaultCurrencyEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<CurrencyEntity>

New CurrencyEntity with default values

CreateDefaultDocumentTemplateEntityAsync(CancellationToken)

Loading default values into a new DocumentTemplateEntity.

Declaration
Task<DocumentTemplateEntity> CreateDefaultDocumentTemplateEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<DocumentTemplateEntity>

New DocumentTemplateEntity with default values

CreateDefaultDocumentTemplateLanguageAsync(int, string, CancellationToken)

Create a new document template language based on an existing template

Declaration
Task CreateDefaultDocumentTemplateLanguageAsync(int documentTemplateId, string languageCode, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateId

The id of the document template
string languageCode

The language code ('en-US, 'nb-NO', etc)
CancellationToken cancellationToken
Returns
Type Description
Task

Returns nothing - throws on error

CreateDefaultExtAppEntityAsync(CancellationToken)

Loading default values into a new ExtAppEntity.

Declaration
Task<ExtAppEntity> CreateDefaultExtAppEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ExtAppEntity>

New ExtAppEntity with default values

CreateDefaultHeadingEntityAsync(CancellationToken)

Loading default values into a new HeadingEntity.

Declaration
Task<HeadingEntity> CreateDefaultHeadingEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<HeadingEntity>

New HeadingEntity with default values

CreateDefaultHeadingFromListDefinitionAsync(int, CancellationToken)

Get a heading for the specified list defintion

Declaration
Task<HeadingEntity> CreateDefaultHeadingFromListDefinitionAsync(int udListDefinitionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list definition, indicating which list to get the item from
CancellationToken cancellationToken
Returns
Type Description
Task<HeadingEntity>

The loaded heading

CreateDefaultHierarchyEntityAsync(CancellationToken)

Loading default values into a new HierarchyEntity.

Declaration
Task<HierarchyEntity> CreateDefaultHierarchyEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<HierarchyEntity>

New HierarchyEntity with default values

CreateDefaultListEntityAsync(CancellationToken)

Loading default values into a new ListEntity.

Declaration
Task<ListEntity> CreateDefaultListEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ListEntity>

New ListEntity with default values

CreateDefaultListItemEntityAsync(CancellationToken)

Loading default values into a new ListItemEntity.

Declaration
Task<ListItemEntity> CreateDefaultListItemEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ListItemEntity>

New ListItemEntity with default values

CreateDefaultProjectTypeEntityAsync(CancellationToken)

Loading default values into a new ProjectTypeEntity.

Declaration
Task<ProjectTypeEntity> CreateDefaultProjectTypeEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ProjectTypeEntity>

New ProjectTypeEntity with default values

CreateDefaultRelationDefinitionEntityAsync(CancellationToken)

Loading default values into a new RelationDefinitionEntity.

Declaration
Task<RelationDefinitionEntity> CreateDefaultRelationDefinitionEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<RelationDefinitionEntity>

New RelationDefinitionEntity with default values

CreateDefaultResourceEntityAsync(CancellationToken)

Loading default values into a new ResourceEntity.

Declaration
Task<ResourceEntity> CreateDefaultResourceEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ResourceEntity>

New ResourceEntity with default values

CreateDefaultSaleStageEntityAsync(CancellationToken)

Loading default values into a new SaleStageEntity.

Declaration
Task<SaleStageEntity> CreateDefaultSaleStageEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<SaleStageEntity>

New SaleStageEntity with default values

CreateDefaultSaleTypeEntityAsync(CancellationToken)

Loading default values into a new SaleTypeEntity.

Declaration
Task<SaleTypeEntity> CreateDefaultSaleTypeEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<SaleTypeEntity>

New SaleTypeEntity with default values

CreateDefaultTaskMenuAsync(CancellationToken)

Loading default values into a new TaskMenu.

Declaration
Task<TaskMenu> CreateDefaultTaskMenuAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<TaskMenu>

New TaskMenu with default values

CreateDefaultTicketCategoryEntityAsync(CancellationToken)

Loading default values into a new TicketCategoryEntity.

Declaration
Task<TicketCategoryEntity> CreateDefaultTicketCategoryEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<TicketCategoryEntity>

New TicketCategoryEntity with default values

CreateDefaultTicketPriorityEntityAsync(CancellationToken)

Loading default values into a new TicketPriorityEntity.

Declaration
Task<TicketPriorityEntity> CreateDefaultTicketPriorityEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<TicketPriorityEntity>

New TicketPriorityEntity with default values

CreateDefaultTicketRelationDefinitionEntityAsync(CancellationToken)

Loading default values into a new TicketRelationDefinitionEntity.

Declaration
Task<TicketRelationDefinitionEntity> CreateDefaultTicketRelationDefinitionEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<TicketRelationDefinitionEntity>

New TicketRelationDefinitionEntity with default values

CreateDefaultTicketStatusEntityAsync(CancellationToken)

Loading default values into a new TicketStatusEntity.

Declaration
Task<TicketStatusEntity> CreateDefaultTicketStatusEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<TicketStatusEntity>

New TicketStatusEntity with default values

CreateDefaultTicketTypeEntityAsync(CancellationToken)

Loading default values into a new TicketTypeEntity.

Declaration
Task<TicketTypeEntity> CreateDefaultTicketTypeEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<TicketTypeEntity>

New TicketTypeEntity with default values

CreateDefaultWebPanelEntityAsync(CancellationToken)

Loading default values into a new WebPanelEntity.

Declaration
Task<WebPanelEntity> CreateDefaultWebPanelEntityAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<WebPanelEntity>

New WebPanelEntity with default values

DeleteAllFromListDefinitionAsync(int, CancellationToken)

Marks all items in the list deleted

Declaration
Task DeleteAllFromListDefinitionAsync(int udListDefinitionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list definition, indicating which list to delete the items from. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteAllFromListNameAsync(string, CancellationToken)

Marks all items in the list deleted

Declaration
Task DeleteAllFromListNameAsync(string udListDefinitionName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string udListDefinitionName

The name of the list definition, indicating which list to delete the items from.
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteAllHeadingsFromListDefinitionAsync(int, CancellationToken)

Delete all headings for list resolved by the provided id.

Declaration
Task DeleteAllHeadingsFromListDefinitionAsync(int id, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int id

The id of the list to look up.
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteAllHeadingsFromNameAsync(string, CancellationToken)

Delete all headings for list resolved by the provided name.

Declaration
Task DeleteAllHeadingsFromNameAsync(string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name

The name of the list to look up.
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteAppTaskMenusAsync(CancellationToken)

Permanentely delete all task menus owned by your app; works in Online only, for registered Apps that send a valid ApplicationToken; otherwise nothing happens

Declaration
Task DeleteAppTaskMenusAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteAppWebPanelsAsync(CancellationToken)

Permanentely delete all web panels owned by your app; works in Online only, for registered Apps that send a valid ApplicationToken; otherwise nothing happens

Declaration
Task DeleteAppWebPanelsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteDocumentTemplateLanguageAsync(int, string, CancellationToken)

Deletes language variant of the document template

Declaration
Task DeleteDocumentTemplateLanguageAsync(int documentTemplateId, string languageCode, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateId

The id of the document template
string languageCode

The language code ('en-US, 'nb-NO', etc)
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteFromListDefinitionAsync(int, int, CancellationToken)

Delete a list item from the specified list defintion

Declaration
Task DeleteFromListDefinitionAsync(int id, int udListDefinitionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int id

The identity of the list item to delete
int udListDefinitionId

The id of the list definition, indicating which list to delete the items from. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteFromListNameAsync(int, string, CancellationToken)

Delete a list item from the specified list defintion

Declaration
Task DeleteFromListNameAsync(int id, string udListDefinitionName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int id

The identity of the list item to delete
string udListDefinitionName

The name of the list definition, indicating which list to delete the items from.
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteHierarchyEntityAsync(int, CancellationToken)

Deletes the HierarchyEntity

Declaration
Task DeleteHierarchyEntityAsync(int hierarchyEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int hierarchyEntityId

The identity of the HierarchyEntity
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteHierarchyFromPathAsync(Domain, string, CancellationToken)

Remove a hierarchy item and its children from a path

Declaration
Task DeleteHierarchyFromPathAsync(Domain domain, string path, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Domain domain

Type of items to get
string path

Hierarchy path to item to delete
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteListEntityAsync(int, CancellationToken)

Deletes the ListEntity

Declaration
Task DeleteListEntityAsync(int listEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int listEntityId

The identity of the ListEntity
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteListEntityByNameAsync(string, CancellationToken)

Delete a ListEntity resolved by the provided name.

Declaration
Task DeleteListEntityByNameAsync(string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name

The name of the list to delete.
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteProjectStatusAsync(int, CancellationToken)

Deletes a project status

Declaration
Task DeleteProjectStatusAsync(int projectStatusId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int projectStatusId

The project status id to delete
CancellationToken cancellationToken
Returns
Type Description
Task

No return

DeleteResourceEntityAsync(int, CancellationToken)

Deletes the ResourceEntity

Declaration
Task DeleteResourceEntityAsync(int resourceEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int resourceEntityId

The identity of the ResourceEntity
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteTaskMenuAsync(int, CancellationToken)

Deletes the TaskMenu

Declaration
Task DeleteTaskMenuAsync(int taskMenuId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int taskMenuId

The identity of the TaskMenu
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteTicketCategoryEntityAsync(int, CancellationToken)

Deletes the TicketCategoryEntity

Declaration
Task DeleteTicketCategoryEntityAsync(int ticketCategoryEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketCategoryEntityId

The identity of the TicketCategoryEntity
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteTicketPriorityEntityAsync(int, CancellationToken)

Deletes the TicketPriorityEntity

Declaration
Task DeleteTicketPriorityEntityAsync(int ticketPriorityEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketPriorityEntityId

The identity of the TicketPriorityEntity
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteTicketRelationDefinitionEntityAsync(int, CancellationToken)

Deletes the TicketRelationDefinitionEntity

Declaration
Task DeleteTicketRelationDefinitionEntityAsync(int ticketRelationDefinitionEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketRelationDefinitionEntityId

The identity of the TicketRelationDefinitionEntity
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteTicketStatusEntityAsync(int, CancellationToken)

Deletes the TicketStatusEntity

Declaration
Task DeleteTicketStatusEntityAsync(int ticketStatusEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketStatusEntityId

The identity of the TicketStatusEntity
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteTicketTypeEntityAsync(int, CancellationToken)

Deletes the TicketTypeEntity

Declaration
Task DeleteTicketTypeEntityAsync(int ticketTypeEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketTypeEntityId

The identity of the TicketTypeEntity
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

DeleteWebPanelAsync(int, CancellationToken)

Hard-delete (real, permanent DELETE in the database) the given web panel. Use with care!

Declaration
Task DeleteWebPanelAsync(int id, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int id

Database id of web panel to delete
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

GenerateNavigationUrlAsync(Navigation, string, CancellationToken)

This methods generates the navigation URL to be used to navigate to the panel

Declaration
Task<string> GenerateNavigationUrlAsync(Navigation visibleIn, string windowName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Navigation visibleIn

The visble in/navigation to generate for
string windowName

The name of the web panel window
CancellationToken cancellationToken
Returns
Type Description
Task<string>

The navigation url

GetAllAutomatedCategoryUpdatesAsync(CancellationToken)

Save the automated category update settings

Declaration
Task<AutomatedCategoryUpdate[]> GetAllAutomatedCategoryUpdatesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<AutomatedCategoryUpdate[]>

Returns all settings

GetAllConsentSourceAsync(CancellationToken)

Gets an array of all ConsentSource objects

Declaration
Task<ConsentSource[]> GetAllConsentSourceAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ConsentSource[]>

Array of all ConsentSource objects

GetAllCountriesAsync(bool, CancellationToken)

Returns all available countries a contact or person could belong to.

Declaration
Task<Country[]> GetAllCountriesAsync(bool includeDeleted, CancellationToken cancellationToken = default)
Parameters
Type Name Description
bool includeDeleted

Include deleted items in result?
CancellationToken cancellationToken
Returns
Type Description
Task<Country[]>

An array of all available countries

GetAllCurrenciesAsync(bool, CancellationToken)

Returns all currencies

Declaration
Task<CurrencyEntity[]> GetAllCurrenciesAsync(bool includeDeleted, CancellationToken cancellationToken = default)
Parameters
Type Name Description
bool includeDeleted

Include deleted items in result?
CancellationToken cancellationToken
Returns
Type Description
Task<CurrencyEntity[]>

Array of currencies

GetAllDocumentTemplatesAsync(bool, CancellationToken)

Returns all templates

Declaration
Task<DocumentTemplateEntity[]> GetAllDocumentTemplatesAsync(bool includeDeleted, CancellationToken cancellationToken = default)
Parameters
Type Name Description
bool includeDeleted

Include deleted items in result?
CancellationToken cancellationToken
Returns
Type Description
Task<DocumentTemplateEntity[]>

Array of all template items

GetAllDomainsAsync(CancellationToken)

Get list of all domains

Declaration
Task<Domain[]> GetAllDomainsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Domain[]>

Domain types (scripts, extra tables, etc)

GetAllFromListDefinitionAsync(int, bool, CancellationToken)

Get all list items for the specified list defintion

Declaration
Task<ListItemEntity[]> GetAllFromListDefinitionAsync(int udListDefinitionId, bool includeDeleted, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list definition, indicating which list to get the item from. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
bool includeDeleted

Include deleted items in result?
CancellationToken cancellationToken
Returns
Type Description
Task<ListItemEntity[]>

The list items

GetAllFromListNameAsync(string, bool, CancellationToken)

Get all list items for the specified list defintion

Declaration
Task<ListItemEntity[]> GetAllFromListNameAsync(string udListDefinitionName, bool includeDeleted, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string udListDefinitionName

The name of the list definition, indicating which list to get the item from.
bool includeDeleted

Include deleted items in result?
CancellationToken cancellationToken
Returns
Type Description
Task<ListItemEntity[]>

The list items

GetAllInDomainAsync(Domain, bool, CancellationToken)

Get all items in a domain

Declaration
Task<HierarchyEntity[]> GetAllInDomainAsync(Domain domain, bool children, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Domain domain

Type of items to get (scripts, extra tables, etc)
bool children

Include sub-items?
CancellationToken cancellationToken
Returns
Type Description
Task<HierarchyEntity[]>

All items and child items within a domain

GetAllLegalBaseAsync(CancellationToken)

Gets an array of all LegalBase objects

Declaration
Task<LegalBase[]> GetAllLegalBaseAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<LegalBase[]>

Array of all LegalBase objects

GetAllReasonSoldAsync(CancellationToken)

Gets an array of all ReasonSold objects

Declaration
Task<ReasonSold[]> GetAllReasonSoldAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ReasonSold[]>

Array of all ReasonSold objects

GetAllReasonStalledAsync(CancellationToken)

Gets an array of all ReasonStalled objects

Declaration
Task<ReasonStalled[]> GetAllReasonStalledAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ReasonStalled[]>

Array of all ReasonStalled objects

GetAllSaleStagesAsync(bool, CancellationToken)

Returns all ratings

Declaration
Task<SaleStageEntity[]> GetAllSaleStagesAsync(bool includeDeleted, CancellationToken cancellationToken = default)
Parameters
Type Name Description
bool includeDeleted

Include deleted items in result?
CancellationToken cancellationToken
Returns
Type Description
Task<SaleStageEntity[]>

Array of sale stage ratings

GetAllSaleTypeAsync(CancellationToken)

Returns all sale types as simple list items

Declaration
Task<SaleType[]> GetAllSaleTypeAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<SaleType[]>

Array of simple sale type list items

GetAllSaleTypeEntitiesAsync(bool, CancellationToken)

Returns all sale types as entities with stakeholders, guide and quote properties

Declaration
Task<SaleTypeEntity[]> GetAllSaleTypeEntitiesAsync(bool includeDeleted, CancellationToken cancellationToken = default)
Parameters
Type Name Description
bool includeDeleted

Include deleted items in result?
CancellationToken cancellationToken
Returns
Type Description
Task<SaleTypeEntity[]>

Array of sale type entities with stakeholders, guide and quote properties

GetAllSelectionCategoryAsync(CancellationToken)

Gets an array of all SelectionCategory objects

Declaration
Task<SelectionCategory[]> GetAllSelectionCategoryAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<SelectionCategory[]>

Array of all SelectionCategory objects

GetAllTasksAsync(bool, CancellationToken)

Returns all appointment tasks

Declaration
Task<TaskListItem[]> GetAllTasksAsync(bool includeDeleted, CancellationToken cancellationToken = default)
Parameters
Type Name Description
bool includeDeleted

Include deleted items in result?
CancellationToken cancellationToken
Returns
Type Description
Task<TaskListItem[]>

An array of all available tasks

GetAllTicketPrioritiesAsync(bool, CancellationToken)

Returns all available ticket priorities.

Declaration
Task<TicketPriorityEntity[]> GetAllTicketPrioritiesAsync(bool includeDeleted, CancellationToken cancellationToken = default)
Parameters
Type Name Description
bool includeDeleted

Include deleted items in result?
CancellationToken cancellationToken
Returns
Type Description
Task<TicketPriorityEntity[]>

An array of all available ticket priorities

GetAmountClassEntityAsync(int, CancellationToken)

Gets a AmountClassEntity object.

Declaration
Task<AmountClassEntity> GetAmountClassEntityAsync(int amountClassEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int amountClassEntityId

The identifier of the AmountClassEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<AmountClassEntity>

A single AmountClassEntity

GetAppTaskMenusAsync(CancellationToken)

Get all task menus owned by your app; works in Online only, for registered Apps that send a valid ApplicationToken

Declaration
Task<TaskMenu[]> GetAppTaskMenusAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<TaskMenu[]>

List of all task menus owned by the current App

GetAppWebPanelsAsync(CancellationToken)

Get all web panels owned by your app; works in Online only, for registered Apps that send a valid ApplicationToken

Declaration
Task<WebPanelEntity[]> GetAppWebPanelsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<WebPanelEntity[]>

List of all web panels owned by the current App

GetBaseCurrencyAsync(CancellationToken)

Get the base currency, used for calculating exchange rates

Declaration
Task<CurrencyEntity> GetBaseCurrencyAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<CurrencyEntity>

The base currency that other currencies are expressed in terms of

GetBusinessAsync(int, CancellationToken)

Gets a Business object.

Declaration
Task<Business> GetBusinessAsync(int businessId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int businessId

The identifier of the Business object
CancellationToken cancellationToken
Returns
Type Description
Task<Business>

A single Business

GetBusinessListAsync(int[], CancellationToken)

Gets an array of Business objects.

Declaration
Task<Business[]> GetBusinessListAsync(int[] businessIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] businessIds

The identifiers of the Business object
CancellationToken cancellationToken
Returns
Type Description
Task<Business[]>

Array of Business

GetBusinessesAsync(CancellationToken)

Returns all available businesses that a contact could have.

Declaration
Task<Business[]> GetBusinessesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Business[]>

An array of all available businesses

GetCategoriesAsync(CancellationToken)

Returns all categories a contact could belong to

Declaration
Task<Category[]> GetCategoriesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Category[]>

An array of all available categories

GetCategoryAsync(int, CancellationToken)

Gets a Category object.

Declaration
Task<Category> GetCategoryAsync(int categoryId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int categoryId

The identifier of the Category object
CancellationToken cancellationToken
Returns
Type Description
Task<Category>

A single Category

GetCategoryEntityAsync(int, CancellationToken)

Gets a CategoryEntity object.

Declaration
Task<CategoryEntity> GetCategoryEntityAsync(int categoryEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int categoryEntityId

The identifier of the CategoryEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<CategoryEntity>

A single CategoryEntity

GetCategoryListAsync(int[], CancellationToken)

Gets an array of Category objects.

Declaration
Task<Category[]> GetCategoryListAsync(int[] categoryIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] categoryIds

The identifiers of the Category object
CancellationToken cancellationToken
Returns
Type Description
Task<Category[]>

Array of Category

GetCompetitorAsync(int, CancellationToken)

Gets a Competitor object.

Declaration
Task<Competitor> GetCompetitorAsync(int competitorId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int competitorId

The identifier of the Competitor object
CancellationToken cancellationToken
Returns
Type Description
Task<Competitor>

A single Competitor

GetCompetitorListAsync(int[], CancellationToken)

Gets an array of Competitor objects.

Declaration
Task<Competitor[]> GetCompetitorListAsync(int[] competitorIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] competitorIds

The identifiers of the Competitor object
CancellationToken cancellationToken
Returns
Type Description
Task<Competitor[]>

Array of Competitor

GetCompetitorsAsync(CancellationToken)

Returns all competitors

Declaration
Task<Competitor[]> GetCompetitorsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Competitor[]>

GetConsentPurposeAsync(int, CancellationToken)

Gets a ConsentPurpose object.

Declaration
Task<ConsentPurpose> GetConsentPurposeAsync(int consentPurposeId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int consentPurposeId

The identifier of the ConsentPurpose object
CancellationToken cancellationToken
Returns
Type Description
Task<ConsentPurpose>

A single ConsentPurpose

GetConsentPurposeListAsync(int[], CancellationToken)

Gets an array of ConsentPurpose objects.

Declaration
Task<ConsentPurpose[]> GetConsentPurposeListAsync(int[] consentPurposeIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] consentPurposeIds

The identifiers of the ConsentPurpose object
CancellationToken cancellationToken
Returns
Type Description
Task<ConsentPurpose[]>

Array of ConsentPurpose

GetConsentPurposesAsync(CancellationToken)

Returns all defined purposes.

Declaration
Task<ConsentPurpose[]> GetConsentPurposesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ConsentPurpose[]>

An array of all defined purposes

GetConsentSourceAsync(int, CancellationToken)

Gets a ConsentSource object.

Declaration
Task<ConsentSource> GetConsentSourceAsync(int consentSourceId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int consentSourceId

The identifier of the ConsentSource object
CancellationToken cancellationToken
Returns
Type Description
Task<ConsentSource>

A single ConsentSource

GetConsentSourceListAsync(int[], CancellationToken)

Gets an array of ConsentSource objects.

Declaration
Task<ConsentSource[]> GetConsentSourceListAsync(int[] consentSourceIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] consentSourceIds

The identifiers of the ConsentSource object
CancellationToken cancellationToken
Returns
Type Description
Task<ConsentSource[]>

Array of ConsentSource

GetConsentSourcesAsync(CancellationToken)

Returns all defined Sources.

Declaration
Task<ConsentSource[]> GetConsentSourcesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ConsentSource[]>

An array of all defined Sources

GetCountriesAsync(CancellationToken)

Returns all available countries a contact or person could belong to.

Declaration
Task<Country[]> GetCountriesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Country[]>

An array of all available countries

GetCountryAsync(int, CancellationToken)

Gets a Country object.

Declaration
Task<Country> GetCountryAsync(int countryId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int countryId

The identifier of the Country object
CancellationToken cancellationToken
Returns
Type Description
Task<Country>

A single Country

GetCountryListAsync(int[], CancellationToken)

Gets an array of Country objects.

Declaration
Task<Country[]> GetCountryListAsync(int[] countryIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] countryIds

The identifiers of the Country object
CancellationToken cancellationToken
Returns
Type Description
Task<Country[]>

Array of Country

GetCreditedAsync(int, CancellationToken)

Gets a Credited object.

Declaration
Task<Credited> GetCreditedAsync(int creditedId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int creditedId

The identifier of the Credited object
CancellationToken cancellationToken
Returns
Type Description
Task<Credited>

A single Credited

GetCreditedListAsync(int[], CancellationToken)

Gets an array of Credited objects.

Declaration
Task<Credited[]> GetCreditedListAsync(int[] creditedIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] creditedIds

The identifiers of the Credited object
CancellationToken cancellationToken
Returns
Type Description
Task<Credited[]>

Array of Credited

GetCreditedsAsync(CancellationToken)

Returns all credited

Declaration
Task<Credited[]> GetCreditedsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Credited[]>

GetCurrenciesAsync(CancellationToken)

Returns all currencies

Declaration
Task<Currency[]> GetCurrenciesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Currency[]>

Array of currencies

GetCurrencyAsync(int, CancellationToken)

Gets a Currency object.

Declaration
Task<Currency> GetCurrencyAsync(int currencyId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int currencyId

The identifier of the Currency object
CancellationToken cancellationToken
Returns
Type Description
Task<Currency>

A single Currency

GetCurrencyEntityAsync(int, CancellationToken)

Gets a CurrencyEntity object.

Declaration
Task<CurrencyEntity> GetCurrencyEntityAsync(int currencyEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int currencyEntityId

The identifier of the CurrencyEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<CurrencyEntity>

A single CurrencyEntity

GetCurrencyListAsync(int[], CancellationToken)

Gets an array of Currency objects.

Declaration
Task<Currency[]> GetCurrencyListAsync(int[] currencyIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] currencyIds

The identifiers of the Currency object
CancellationToken cancellationToken
Returns
Type Description
Task<Currency[]>

Array of Currency

GetCustomerLanguageAsync(int, CancellationToken)

Gets a CustomerLanguage object.

Declaration
Task<CustomerLanguage> GetCustomerLanguageAsync(int customerLanguageId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int customerLanguageId

The identifier of the CustomerLanguage object
CancellationToken cancellationToken
Returns
Type Description
Task<CustomerLanguage>

A single CustomerLanguage

GetCustomerLanguageListAsync(int[], CancellationToken)

Gets an array of CustomerLanguage objects.

Declaration
Task<CustomerLanguage[]> GetCustomerLanguageListAsync(int[] customerLanguageIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] customerLanguageIds

The identifiers of the CustomerLanguage object
CancellationToken cancellationToken
Returns
Type Description
Task<CustomerLanguage[]>

Array of CustomerLanguage

GetCustomerLanguagesAsync(CancellationToken)

Interface for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration
Task<CustomerLanguage[]> GetCustomerLanguagesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<CustomerLanguage[]>

GetDeliveryTermAsync(int, CancellationToken)

Gets a DeliveryTerm object.

Declaration
Task<DeliveryTerm> GetDeliveryTermAsync(int deliveryTermId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int deliveryTermId

The identifier of the DeliveryTerm object
CancellationToken cancellationToken
Returns
Type Description
Task<DeliveryTerm>

A single DeliveryTerm

GetDeliveryTermsAsync(CancellationToken)

Returns all DeliveryTerms in SuperOffice db.

Declaration
Task<DeliveryTerm[]> GetDeliveryTermsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<DeliveryTerm[]>

An array of all available DeliveryTerms

GetDeliveryTypeAsync(int, CancellationToken)

Gets a DeliveryType object.

Declaration
Task<DeliveryType> GetDeliveryTypeAsync(int deliveryTypeId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int deliveryTypeId

The identifier of the DeliveryType object
CancellationToken cancellationToken
Returns
Type Description
Task<DeliveryType>

A single DeliveryType

GetDeliveryTypesAsync(CancellationToken)

Returns all DeliveryTypes in SuperOffice db.

Declaration
Task<DeliveryType[]> GetDeliveryTypesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<DeliveryType[]>

An array of all available DeliveryType

GetDepartmentAsync(int, CancellationToken)

Gets a Department object.

Declaration
Task<Department> GetDepartmentAsync(int departmentId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int departmentId

The identifier of the Department object
CancellationToken cancellationToken
Returns
Type Description
Task<Department>

A single Department

GetDepartmentListAsync(int[], CancellationToken)

Gets an array of Department objects.

Declaration
Task<Department[]> GetDepartmentListAsync(int[] departmentIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] departmentIds

The identifiers of the Department object
CancellationToken cancellationToken
Returns
Type Description
Task<Department[]>

Array of Department

GetDepartmentsAsync(CancellationToken)

Getting all departments/user groups for the internal phone list with the user's colleagues.

Declaration
Task<Department[]> GetDepartmentsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Department[]>

Returns all departments.

GetDocumentTemplateAsync(int, CancellationToken)

Gets a DocumentTemplate object.

Declaration
Task<DocumentTemplate> GetDocumentTemplateAsync(int documentTemplateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateId

The identifier of the DocumentTemplate object
CancellationToken cancellationToken
Returns
Type Description
Task<DocumentTemplate>

A single DocumentTemplate

GetDocumentTemplateEntityAsync(int, CancellationToken)

Gets a DocumentTemplateEntity object.

Declaration
Task<DocumentTemplateEntity> GetDocumentTemplateEntityAsync(int documentTemplateEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateEntityId

The identifier of the DocumentTemplateEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<DocumentTemplateEntity>

A single DocumentTemplateEntity

GetDocumentTemplateExtensionAsync(int, CancellationToken)

Get the file extension for the document template

Declaration
Task<string> GetDocumentTemplateExtensionAsync(int documentTemplateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateId

The primary key of the document template
CancellationToken cancellationToken
Returns
Type Description
Task<string>

File name extension including '.': '.doc' or '.xlsx'

GetDocumentTemplateLanguagesAsync(int, CancellationToken)

Get the supported language variations for a document template

Declaration
Task<string[]> GetDocumentTemplateLanguagesAsync(int documentTemplateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateId

The id of the document template
CancellationToken cancellationToken
Returns
Type Description
Task<string[]>

Returns the list of languages as ISO cultures (en-US, no, sv, etc)

GetDocumentTemplateListAsync(int[], CancellationToken)

Gets an array of DocumentTemplate objects.

Declaration
Task<DocumentTemplate[]> GetDocumentTemplateListAsync(int[] documentTemplateIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] documentTemplateIds

The identifiers of the DocumentTemplate object
CancellationToken cancellationToken
Returns
Type Description
Task<DocumentTemplate[]>

Array of DocumentTemplate

GetDocumentTemplatePropertiesAsync(int, string[], CancellationToken)

Get document template properties

Declaration
Task<StringDictionary> GetDocumentTemplatePropertiesAsync(int documentTemplateId, string[] requestedProperties, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateId

The primary key id of the document template
string[] requestedProperties

An array of properties to get the values for
CancellationToken cancellationToken
Returns
Type Description
Task<StringDictionary>

Dictionary of key=value pairs of requested properties

GetDocumentTemplateStreamFromIdAsync(int, string, CancellationToken)

Retrieve a stream to a document template based on its id

Declaration
Task<Stream> GetDocumentTemplateStreamFromIdAsync(int documentTemplateId, string languageCode, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateId

Id of template to retrieve
string languageCode

Language variation of template to use. (ISO code: "en-US" or "nb-NO" etc). Used to select a template of the appropriate language. Can be overridden in SO ARC by user preference "PreferDocLang".
CancellationToken cancellationToken
Returns
Type Description
Task<Stream>

Open stream to the template content

GetDocumentTemplateTaskAsync(int, CancellationToken)

Returns a Document Template list item as a TaskListItem. The appointment's task is a Document template item when the appointment is a document.

Declaration
Task<SoTask> GetDocumentTemplateTaskAsync(int documentTemplateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateId

Id of the document template, i.e. the Appointment.TaskIdx
CancellationToken cancellationToken
Returns
Type Description
Task<SoTask>

Document Template item as TaskListItem.

GetDocumentTemplateUrlAsync(int, bool, string, CancellationToken)

Get a url to the document template

Declaration
Task<string> GetDocumentTemplateUrlAsync(int documentTemplateId, bool writableUrl, string languageCode, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateId

The id of the template
bool writableUrl

Get a writeable url to the document template?
string languageCode

The language code ('en-US', 'nb-NO', etc). Use empty string if not supported or used.
CancellationToken cancellationToken
Returns
Type Description
Task<string>

The URL to the document template

GetDocumentTemplateUsedInProjectStageAsync(int, CancellationToken)

Get a String array of names in project guide that this template is used in

Declaration
Task<string[]> GetDocumentTemplateUsedInProjectStageAsync(int documentTemplateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateId

The id of the template
CancellationToken cancellationToken
Returns
Type Description
Task<string[]>

The name of the projectguides that use this template

GetDocumentTemplateUsedInSalesStageAsync(int, CancellationToken)

Get a String array of names in sales guide that this template is used in

Declaration
Task<string[]> GetDocumentTemplateUsedInSalesStageAsync(int documentTemplateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateId

The id of the template
CancellationToken cancellationToken
Returns
Type Description
Task<string[]>

The name of the salesguides that use this template

GetDocumentTemplatesAsync(CancellationToken)

Returns all available document templates

Declaration
Task<DocumentTemplate[]> GetDocumentTemplatesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<DocumentTemplate[]>

Array of DocumentTemplates

GetDocumentTemplatesTasksAsync(CancellationToken)

The appointment's task is a Document template item when the appointment is a document.

Declaration
Task<SoTask[]> GetDocumentTemplatesTasksAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<SoTask[]>

Document Template list as a array of Tasks

GetDocumentTypesForPluginAsync(int, CancellationToken)

Get a list of document types supported by a given document plugin. Use the document template type when creating a new template.

Declaration
Task<IntStringDictionary> GetDocumentTypesForPluginAsync(int pluginId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int pluginId

Numeric document plugin id, corresponding to the doctmpl.AutoeventId, doctmpl.LoadTemplateFromPlugin.
CancellationToken cancellationToken
Returns
Type Description
Task<IntStringDictionary>

Dictionary mapping document type id=name

GetEmarketingStrictModeAsync(CancellationToken)

Get the value of the Emarketing strict mode setting

Declaration
Task<bool> GetEmarketingStrictModeAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<bool>

Returns true if Emarkerint strict mode is set, false otherwise

GetExtAppEntityAsync(int, CancellationToken)

Gets a ExtAppEntity object.

Declaration
Task<ExtAppEntity> GetExtAppEntityAsync(int extAppEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int extAppEntityId

The identifier of the ExtAppEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<ExtAppEntity>

A single ExtAppEntity

GetFromListDefinitionAsync(int, int, CancellationToken)

Get a list item for the specified list defintion

Declaration
Task<ListItemEntity> GetFromListDefinitionAsync(int id, int udListDefinitionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int id

The identity of the list item to load
int udListDefinitionId

The id of the list definition, indicating which list to get the item from. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
CancellationToken cancellationToken
Returns
Type Description
Task<ListItemEntity>

The loaded list item

GetFromListNameAsync(int, string, CancellationToken)

Get a list item for the specified list defintion

Declaration
Task<ListItemEntity> GetFromListNameAsync(int id, string udListDefinitionName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int id

The identity of the list item to load
string udListDefinitionName

The name of the list definition, indicating which list to get the item from.
CancellationToken cancellationToken
Returns
Type Description
Task<ListItemEntity>

The loaded list item

GetHeadingEntityAsync(int, CancellationToken)

Gets a HeadingEntity object.

Declaration
Task<HeadingEntity> GetHeadingEntityAsync(int headingEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int headingEntityId

The identifier of the HeadingEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<HeadingEntity>

A single HeadingEntity

GetHeadingsAsync(int, int, bool, CancellationToken)

Gets a selectable MDO list of the headings for this list item

Declaration
Task<SelectableMDOListItem[]> GetHeadingsAsync(int udListDefinitionId, int listItemId, bool showDeleted, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
int listItemId

The id of the list item
bool showDeleted

Set to true if you want deleted headings
CancellationToken cancellationToken
Returns
Type Description
Task<SelectableMDOListItem[]>

Array of headings

GetHeadingsForListItemFromListNameAsync(string, int, bool, CancellationToken)

Gets a selectable MDO list of the headings for this list item

Declaration
Task<SelectableMDOListItem[]> GetHeadingsForListItemFromListNameAsync(string udListDefinitionName, int listItemId, bool showDeleted, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string udListDefinitionName

The name of the list definition, indicating which list to delete the items from.
int listItemId

The id of the list item
bool showDeleted

Set to true if you want deleted headings
CancellationToken cancellationToken
Returns
Type Description
Task<SelectableMDOListItem[]>

Array of headings

GetHeadingsFromListDefinitionAsync(int, CancellationToken)

Gets headings for list resolved by the provided id.

Declaration
Task<HeadingEntity[]> GetHeadingsFromListDefinitionAsync(int id, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int id

The id of the list to look up.
CancellationToken cancellationToken
Returns
Type Description
Task<HeadingEntity[]>

List of headings

GetHeadingsFromNameAsync(string, CancellationToken)

Gets headings for list resolved by the provided name.

Declaration
Task<HeadingEntity[]> GetHeadingsFromNameAsync(string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name

The name of the list to look up.
CancellationToken cancellationToken
Returns
Type Description
Task<HeadingEntity[]>

List of headings

GetHierarchyEntityAsync(int, CancellationToken)

Gets a HierarchyEntity object.

Declaration
Task<HierarchyEntity> GetHierarchyEntityAsync(int hierarchyEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int hierarchyEntityId

The identifier of the HierarchyEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<HierarchyEntity>

A single HierarchyEntity

GetHierarchyFromPathAsync(Domain, string, bool, CancellationToken)

Get a hierarchy item from a path

Declaration
Task<HierarchyEntity> GetHierarchyFromPathAsync(Domain domain, string path, bool children, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Domain domain

Type of items to get
string path

Hierarchy path to item
bool children

Include sub-items?
CancellationToken cancellationToken
Returns
Type Description
Task<HierarchyEntity>

The hierarchy node at the path

GetInstalledLanguagesAsync(CancellationToken)

Returns the list of all languages installed in this database.

Declaration
Task<LanguageInfo[]> GetInstalledLanguagesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<LanguageInfo[]>

Array of installed languages

GetLanguageInfoAsync(int, CancellationToken)

Gets a LanguageInfo object.

Declaration
Task<LanguageInfo> GetLanguageInfoAsync(int languageInfoId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int languageInfoId

The identifier of the LanguageInfo object
CancellationToken cancellationToken
Returns
Type Description
Task<LanguageInfo>

A single LanguageInfo

GetLanguageInfoListAsync(int[], CancellationToken)

Gets an array of LanguageInfo objects.

Declaration
Task<LanguageInfo[]> GetLanguageInfoListAsync(int[] languageInfoIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] languageInfoIds

The identifiers of the LanguageInfo object
CancellationToken cancellationToken
Returns
Type Description
Task<LanguageInfo[]>

Array of LanguageInfo

GetLegalBaseAsync(int, CancellationToken)

Gets a LegalBase object.

Declaration
Task<LegalBase> GetLegalBaseAsync(int legalBaseId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int legalBaseId

The identifier of the LegalBase object
CancellationToken cancellationToken
Returns
Type Description
Task<LegalBase>

A single LegalBase

GetLegalBaseListAsync(int[], CancellationToken)

Gets an array of LegalBase objects.

Declaration
Task<LegalBase[]> GetLegalBaseListAsync(int[] legalBaseIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] legalBaseIds

The identifiers of the LegalBase object
CancellationToken cancellationToken
Returns
Type Description
Task<LegalBase[]>

Array of LegalBase

GetLegalBasesAsync(CancellationToken)

Returns all defined bases.

Declaration
Task<LegalBase[]> GetLegalBasesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<LegalBase[]>

An array of all defined bases

GetLinkAsync(int, CancellationToken)

Gets a Link object.

Declaration
Task<Link> GetLinkAsync(int linkId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int linkId

The identifier of the Link object
CancellationToken cancellationToken
Returns
Type Description
Task<Link>

A single Link

GetLinkListAsync(int[], CancellationToken)

Gets an array of Link objects.

Declaration
Task<Link[]> GetLinkListAsync(int[] linkIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] linkIds

The identifiers of the Link object
CancellationToken cancellationToken
Returns
Type Description
Task<Link[]>

Array of Link

GetListDefinitionsAsync(bool, CancellationToken)

Get a list of the lists - built-in and user-defined.

Declaration
Task<ListEntity[]> GetListDefinitionsAsync(bool includeDeleted, CancellationToken cancellationToken = default)
Parameters
Type Name Description
bool includeDeleted

Include deleted items in result?
CancellationToken cancellationToken
Returns
Type Description
Task<ListEntity[]>

The list definitions

GetListEntityAsync(int, CancellationToken)

Gets a ListEntity object.

Declaration
Task<ListEntity> GetListEntityAsync(int listEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int listEntityId

The identifier of the ListEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<ListEntity>

A single ListEntity

GetListEntityByNameAsync(string, CancellationToken)

Gets a ListEntity resolved by the provided name.

Declaration
Task<ListEntity> GetListEntityByNameAsync(string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name

The name of the list to look up.
CancellationToken cancellationToken
Returns
Type Description
Task<ListEntity>

A ListEntity or null.

GetListItemsForHeadingAsync(int, int, CancellationToken)

List of list items that is selected if under this heading

Declaration
Task<SelectableMDOListItem[]> GetListItemsForHeadingAsync(int udListDefinitionId, int headingId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
int headingId

The id of the heading
CancellationToken cancellationToken
Returns
Type Description
Task<SelectableMDOListItem[]>

Array of selectable list items

GetListItemsForHeadingFromListNameAsync(string, int, CancellationToken)

List of list items that is selected if under this heading

Declaration
Task<SelectableMDOListItem[]> GetListItemsForHeadingFromListNameAsync(string udListDefinitionName, int headingId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string udListDefinitionName

The name of the list definition.
int headingId

The id of the heading
CancellationToken cancellationToken
Returns
Type Description
Task<SelectableMDOListItem[]>

Array of selectable list items

GetListItemsForUserGroupAsync(int, int, CancellationToken)

List of list items that is visible in the usergroup

Declaration
Task<SelectableMDOListItem[]> GetListItemsForUserGroupAsync(int udListDefinitionId, int groupId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
int groupId

The id of the usergroup
CancellationToken cancellationToken
Returns
Type Description
Task<SelectableMDOListItem[]>

Array of selectable list items

GetListItemsForUserGroupFromListNameAsync(string, int, CancellationToken)

List of list items that is visible in the usergroup

Declaration
Task<SelectableMDOListItem[]> GetListItemsForUserGroupFromListNameAsync(string udListDefinitionName, int groupId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string udListDefinitionName

The name of the list definition.
int groupId

The id of the usergroup
CancellationToken cancellationToken
Returns
Type Description
Task<SelectableMDOListItem[]>

Array of selectable list items

GetLocalizedTextAsync(int, CancellationToken)

Gets a LocalizedText object.

Declaration
Task<LocalizedText> GetLocalizedTextAsync(int localizedTextId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int localizedTextId

The identifier of the LocalizedText object
CancellationToken cancellationToken
Returns
Type Description
Task<LocalizedText>

A single LocalizedText

GetLocalizedTextByTypeAsync(LocalizedTextType, int, int, CancellationToken)

Returns a localized text based on the resource id for the selected language.

Declaration
Task<LocalizedText> GetLocalizedTextByTypeAsync(LocalizedTextType textType, int resourceId, int languageId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
LocalizedTextType textType

Type of the localized text
int resourceId

The resource id. This id has different meaning based on the LocalizedTextType.
int languageId

The LCID number of the language.
CancellationToken cancellationToken
Returns
Type Description
Task<LocalizedText>

A LocalizedText carrier.

GetLocalizedTextListAsync(int[], CancellationToken)

Gets an array of LocalizedText objects.

Declaration
Task<LocalizedText[]> GetLocalizedTextListAsync(int[] localizedTextIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] localizedTextIds

The identifiers of the LocalizedText object
CancellationToken cancellationToken
Returns
Type Description
Task<LocalizedText[]>

Array of LocalizedText

GetLocalizedTextsAsync(CancellationToken)

Gets all localized texts in the CRM database.

Declaration
Task<LocalizedText[]> GetLocalizedTextsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<LocalizedText[]>

Array of LocalizedText objects

GetLocalizedTextsByLanguageIdAsync(int, CancellationToken)

Gets all localized text belonging to a specific language.

Declaration
Task<LocalizedText[]> GetLocalizedTextsByLanguageIdAsync(int languageId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int languageId

The LCID number of the language.
CancellationToken cancellationToken
Returns
Type Description
Task<LocalizedText[]>

Array of LocalizedText objects

GetLocalizedTextsByTypeAsync(LocalizedTextType[], CancellationToken)

Gets localized text by their type

Declaration
Task<LocalizedText[]> GetLocalizedTextsByTypeAsync(LocalizedTextType[] textTypes, CancellationToken cancellationToken = default)
Parameters
Type Name Description
LocalizedTextType[] textTypes

Array of LocalizedTextTypes. If null all texts are returned.
CancellationToken cancellationToken
Returns
Type Description
Task<LocalizedText[]>

Array of LocalizedText objects

GetMrMrsAsync(int, CancellationToken)

Gets a MrMrs object.

Declaration
Task<MrMrs> GetMrMrsAsync(int mrMrsId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int mrMrsId

The identifier of the MrMrs object
CancellationToken cancellationToken
Returns
Type Description
Task<MrMrs>

A single MrMrs

GetMrMrsListAsync(int[], CancellationToken)

Gets an array of MrMrs objects.

Declaration
Task<MrMrs[]> GetMrMrsListAsync(int[] mrMrsIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] mrMrsIds

The identifiers of the MrMrs object
CancellationToken cancellationToken
Returns
Type Description
Task<MrMrs[]>

Array of MrMrs

GetMrMrsesAsync(CancellationToken)

Returns all Items from the MrMrs table sorted by their value.

Declaration
Task<MrMrs[]> GetMrMrsesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<MrMrs[]>

All items from the MrMrs table sorted by their value

GetNeedCategoryUpdateForPersonAsync(int, int, int, int, CancellationToken)

Before saving a person with changed leadstatus, call this to see if we should ask for a userconfirmation to automatically update category on contact or person

Declaration
Task<AutomatedCategoryUpdate> GetNeedCategoryUpdateForPersonAsync(int leadStatus, int personId, int contactId, int categoryId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int leadStatus

The new leadstatus that might trigger the category update
int personId

The person id that might trigger the category update
int contactId

The contact id that might get the resulting update
int categoryId

The person id that might get the resulting update
CancellationToken cancellationToken
Returns
Type Description
Task<AutomatedCategoryUpdate>

Returns the info on the trigger that will update with userconfirmation. Returns void if no update or no need for confirmation

GetNeedCategoryUpdateForSaleAsync(SaleStatus, int, int, int, CancellationToken)

Before saving a sale, call this to see if the current changes on the sale should result in a userconfirmation dialog asking to automatically update category on contact or person

Declaration
Task<AutomatedCategoryUpdate> GetNeedCategoryUpdateForSaleAsync(SaleStatus saleStatus, int saleId, int contactId, int personId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SaleStatus saleStatus

The new salestatus that might trigger the category update
int saleId

The sale id that might trigger the category update
int contactId

The contact id that might get the resulting update
int personId

The person id that might get the resulting update
CancellationToken cancellationToken
Returns
Type Description
Task<AutomatedCategoryUpdate>

Returns the info on the trigger that will update with userconfirmation. Returns void if no update or no need for confirmation

GetOurCurrencyAsync(CancellationToken)

Gets the Our currency object if currency is enabled

Declaration
Task<Currency> GetOurCurrencyAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Currency>

Our currency

GetOwnerCompanysCurrencyAsync(CancellationToken)

Get the currency of the user's owner company

Declaration
Task<Currency> GetOwnerCompanysCurrencyAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Currency>

Currency of the user's owner company

GetPaymentTermAsync(int, CancellationToken)

Gets a PaymentTerm object.

Declaration
Task<PaymentTerm> GetPaymentTermAsync(int paymentTermId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int paymentTermId

The identifier of the PaymentTerm object
CancellationToken cancellationToken
Returns
Type Description
Task<PaymentTerm>

A single PaymentTerm

GetPaymentTermsAsync(CancellationToken)

Returns all PaymentTerms in SuperOffice db.

Declaration
Task<PaymentTerm[]> GetPaymentTermsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<PaymentTerm[]>

An array of all available PaymentTerms

GetPaymentTypeAsync(int, CancellationToken)

Gets a PaymentType object.

Declaration
Task<PaymentType> GetPaymentTypeAsync(int paymentTypeId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int paymentTypeId

The identifier of the PaymentType object
CancellationToken cancellationToken
Returns
Type Description
Task<PaymentType>

A single PaymentType

GetPaymentTypesAsync(CancellationToken)

Returns all PaymentTypes in SuperOffice db.

Declaration
Task<PaymentType[]> GetPaymentTypesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<PaymentType[]>

An array of all available PaymentTypes

GetPluginCapabilitiesAsync(int, CancellationToken)

Get a list of plugin-dependent capabilities for a given document archive plugin.<br/>A standard set of properties is defined in SuperOffice.CRM.Documents.Constants.Capabilities.

Declaration
Task<StringDictionary> GetPluginCapabilitiesAsync(int pluginId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int pluginId

Numeric document plugin id, corresponding to the document.archiveProvider id or doctmpl.AutoeventId.
CancellationToken cancellationToken
Returns
Type Description
Task<StringDictionary>

Dictionary mapping capability names=values

GetPluginListAsync(CancellationToken)

Get a list of installed document plugins

Declaration
Task<StringDictionary> GetPluginListAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<StringDictionary>

Dictionary mapping plugin id=plugin name

GetPositionAsync(int, CancellationToken)

Gets a Position object.

Declaration
Task<Position> GetPositionAsync(int positionId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int positionId

The identifier of the Position object
CancellationToken cancellationToken
Returns
Type Description
Task<Position>

A single Position

GetPositionListAsync(int[], CancellationToken)

Gets an array of Position objects.

Declaration
Task<Position[]> GetPositionListAsync(int[] positionIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] positionIds

The identifiers of the Position object
CancellationToken cancellationToken
Returns
Type Description
Task<Position[]>

Array of Position

GetPositionsAsync(CancellationToken)

Returns all the positions a person could have.

Declaration
Task<Position[]> GetPositionsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Position[]>

An array of all available positions

GetPrioritiesAsync(CancellationToken)

Returns all priorities an appointment could have.

Declaration
Task<Priority[]> GetPrioritiesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Priority[]>

An array of all available priorities

GetPriorityAsync(int, CancellationToken)

Gets a Priority object.

Declaration
Task<Priority> GetPriorityAsync(int priorityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int priorityId

The identifier of the Priority object
CancellationToken cancellationToken
Returns
Type Description
Task<Priority>

A single Priority

GetPriorityListAsync(int[], CancellationToken)

Gets an array of Priority objects.

Declaration
Task<Priority[]> GetPriorityListAsync(int[] priorityIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] priorityIds

The identifiers of the Priority object
CancellationToken cancellationToken
Returns
Type Description
Task<Priority[]>

Array of Priority

GetProductCategoriesAsync(CancellationToken)

Returns all ProductCategories in SuperOffice list.

Declaration
Task<ProductCategory[]> GetProductCategoriesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ProductCategory[]>

An array of all available ProductCategory

GetProductCategoryAsync(int, CancellationToken)

Gets a ProductCategory object.

Declaration
Task<ProductCategory> GetProductCategoryAsync(int productCategoryId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int productCategoryId

The identifier of the ProductCategory object
CancellationToken cancellationToken
Returns
Type Description
Task<ProductCategory>

A single ProductCategory

GetProductFamiliesAsync(CancellationToken)

Returns all ProductFamily in SuperOffice list.

Declaration
Task<ProductFamily[]> GetProductFamiliesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ProductFamily[]>

An array of all available ProductFamilies

GetProductFamilyAsync(int, CancellationToken)

Gets a ProductFamily object.

Declaration
Task<ProductFamily> GetProductFamilyAsync(int productFamilyId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int productFamilyId

The identifier of the ProductFamily object
CancellationToken cancellationToken
Returns
Type Description
Task<ProductFamily>

A single ProductFamily

GetProductTypeAsync(int, CancellationToken)

Gets a ProductType object.

Declaration
Task<ProductType> GetProductTypeAsync(int productTypeId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int productTypeId

The identifier of the ProductType object
CancellationToken cancellationToken
Returns
Type Description
Task<ProductType>

A single ProductType

GetProductTypesAsync(CancellationToken)

Returns all ProductTypes in SuperOffice list.

Declaration
Task<ProductType[]> GetProductTypesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ProductType[]>

An array of all available ProductTypes

GetProjectStatusAsync(int, CancellationToken)

Gets a ProjectStatus object.

Declaration
Task<ProjectStatus> GetProjectStatusAsync(int projectStatusId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int projectStatusId

The identifier of the ProjectStatus object
CancellationToken cancellationToken
Returns
Type Description
Task<ProjectStatus>

A single ProjectStatus

GetProjectStatusListAsync(int[], CancellationToken)

Gets an array of ProjectStatus objects.

Declaration
Task<ProjectStatus[]> GetProjectStatusListAsync(int[] projectStatusIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] projectStatusIds

The identifiers of the ProjectStatus object
CancellationToken cancellationToken
Returns
Type Description
Task<ProjectStatus[]>

Array of ProjectStatus

GetProjectStatusesAsync(CancellationToken)

Gets all items from the Project Status (ProjStatus) table.

Declaration
Task<ProjectStatus[]> GetProjectStatusesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ProjectStatus[]>

List of all Project statuses.

GetProjectTypeAsync(int, CancellationToken)

Gets a ProjectType object.

Declaration
Task<ProjectType> GetProjectTypeAsync(int projectTypeId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int projectTypeId

The identifier of the ProjectType object
CancellationToken cancellationToken
Returns
Type Description
Task<ProjectType>

A single ProjectType

GetProjectTypeEntityAsync(int, CancellationToken)

Gets a ProjectTypeEntity object.

Declaration
Task<ProjectTypeEntity> GetProjectTypeEntityAsync(int projectTypeEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int projectTypeEntityId

The identifier of the ProjectTypeEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<ProjectTypeEntity>

A single ProjectTypeEntity

GetProjectTypeListAsync(int[], CancellationToken)

Gets an array of ProjectType objects.

Declaration
Task<ProjectType[]> GetProjectTypeListAsync(int[] projectTypeIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] projectTypeIds

The identifiers of the ProjectType object
CancellationToken cancellationToken
Returns
Type Description
Task<ProjectType[]>

Array of ProjectType

GetProjectTypesAsync(CancellationToken)

Gets all items from the Project Type (ProjType) table.

Declaration
Task<ProjectType[]> GetProjectTypesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ProjectType[]>

List of all project types.

GetQuickRepliesAsync(CancellationToken)

Method to return all quick replies for a given associate

Declaration
Task<QuickReply[]> GetQuickRepliesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<QuickReply[]>

Array of quick replies

GetQuoteApproveReasonAsync(int, CancellationToken)

Gets a QuoteApproveReason object.

Declaration
Task<QuoteApproveReason> GetQuoteApproveReasonAsync(int quoteApproveReasonId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int quoteApproveReasonId

The identifier of the QuoteApproveReason object
CancellationToken cancellationToken
Returns
Type Description
Task<QuoteApproveReason>

A single QuoteApproveReason

GetQuoteApproveReasonListAsync(int[], CancellationToken)

Gets an array of QuoteApproveReason objects.

Declaration
Task<QuoteApproveReason[]> GetQuoteApproveReasonListAsync(int[] quoteApproveReasonIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] quoteApproveReasonIds

The identifiers of the QuoteApproveReason object
CancellationToken cancellationToken
Returns
Type Description
Task<QuoteApproveReason[]>

Array of QuoteApproveReason

GetQuoteApproveReasonsAsync(CancellationToken)

Returns all available QuoteApproveReasons.

Declaration
Task<QuoteApproveReason[]> GetQuoteApproveReasonsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<QuoteApproveReason[]>

An array of all non-deleted QuoteApproveReason

GetQuoteDenyReasonAsync(int, CancellationToken)

Gets a QuoteDenyReason object.

Declaration
Task<QuoteDenyReason> GetQuoteDenyReasonAsync(int quoteDenyReasonId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int quoteDenyReasonId

The identifier of the QuoteDenyReason object
CancellationToken cancellationToken
Returns
Type Description
Task<QuoteDenyReason>

A single QuoteDenyReason

GetQuoteDenyReasonListAsync(int[], CancellationToken)

Gets an array of QuoteDenyReason objects.

Declaration
Task<QuoteDenyReason[]> GetQuoteDenyReasonListAsync(int[] quoteDenyReasonIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] quoteDenyReasonIds

The identifiers of the QuoteDenyReason object
CancellationToken cancellationToken
Returns
Type Description
Task<QuoteDenyReason[]>

Array of QuoteDenyReason

GetQuoteDenyReasonsAsync(CancellationToken)

Returns all available QuoteDenyReasons.

Declaration
Task<QuoteDenyReason[]> GetQuoteDenyReasonsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<QuoteDenyReason[]>

An array of all non-deleted QuoteDenyReason

GetRatingAsync(int, CancellationToken)

Gets a Rating object.

Declaration
Task<Rating> GetRatingAsync(int ratingId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ratingId

The identifier of the Rating object
CancellationToken cancellationToken
Returns
Type Description
Task<Rating>

A single Rating

GetRatingListAsync(int[], CancellationToken)

Gets an array of Rating objects.

Declaration
Task<Rating[]> GetRatingListAsync(int[] ratingIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] ratingIds

The identifiers of the Rating object
CancellationToken cancellationToken
Returns
Type Description
Task<Rating[]>

Array of Rating

GetRatingsAsync(CancellationToken)

Returns all ratings

Declaration
Task<Rating[]> GetRatingsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Rating[]>

Array of ratings

GetReasonAsync(int, CancellationToken)

Gets a Reason object.

Declaration
Task<Reason> GetReasonAsync(int reasonId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int reasonId

The identifier of the Reason object
CancellationToken cancellationToken
Returns
Type Description
Task<Reason>

A single Reason

GetReasonListAsync(int[], CancellationToken)

Gets an array of Reason objects.

Declaration
Task<Reason[]> GetReasonListAsync(int[] reasonIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] reasonIds

The identifiers of the Reason object
CancellationToken cancellationToken
Returns
Type Description
Task<Reason[]>

Array of Reason

GetReasonSoldAsync(int, CancellationToken)

Gets a ReasonSold object.

Declaration
Task<ReasonSold> GetReasonSoldAsync(int reasonSoldId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int reasonSoldId

The identifier of the ReasonSold object
CancellationToken cancellationToken
Returns
Type Description
Task<ReasonSold>

A single ReasonSold

GetReasonSoldListAsync(int[], CancellationToken)

Gets an array of ReasonSold objects.

Declaration
Task<ReasonSold[]> GetReasonSoldListAsync(int[] reasonSoldIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] reasonSoldIds

The identifiers of the ReasonSold object
CancellationToken cancellationToken
Returns
Type Description
Task<ReasonSold[]>

Array of ReasonSold

GetReasonStalledAsync(int, CancellationToken)

Gets a ReasonStalled object.

Declaration
Task<ReasonStalled> GetReasonStalledAsync(int reasonStalledId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int reasonStalledId

The identifier of the ReasonStalled object
CancellationToken cancellationToken
Returns
Type Description
Task<ReasonStalled>

A single ReasonStalled

GetReasonStalledListAsync(int[], CancellationToken)

Gets an array of ReasonStalled objects.

Declaration
Task<ReasonStalled[]> GetReasonStalledListAsync(int[] reasonStalledIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] reasonStalledIds

The identifiers of the ReasonStalled object
CancellationToken cancellationToken
Returns
Type Description
Task<ReasonStalled[]>

Array of ReasonStalled

GetReasonsAsync(CancellationToken)

Returns all reasons

Declaration
Task<Reason[]> GetReasonsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Reason[]>

Array of reasons

GetRelationDefinitionEntityAsync(int, CancellationToken)

Gets a RelationDefinitionEntity object.

Declaration
Task<RelationDefinitionEntity> GetRelationDefinitionEntityAsync(int relationDefinitionEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int relationDefinitionEntityId

The identifier of the RelationDefinitionEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<RelationDefinitionEntity>

A single RelationDefinitionEntity

GetResourceEntityAsync(int, CancellationToken)

Gets a ResourceEntity object.

Declaration
Task<ResourceEntity> GetResourceEntityAsync(int resourceEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int resourceEntityId

The identifier of the ResourceEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<ResourceEntity>

A single ResourceEntity

GetSaleStageEntityAsync(int, CancellationToken)

Gets a SaleStageEntity object.

Declaration
Task<SaleStageEntity> GetSaleStageEntityAsync(int saleStageEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int saleStageEntityId

The identifier of the SaleStageEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<SaleStageEntity>

A single SaleStageEntity

GetSaleTypeAsync(int, CancellationToken)

Gets a SaleType object.

Declaration
Task<SaleType> GetSaleTypeAsync(int saleTypeId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int saleTypeId

The identifier of the SaleType object
CancellationToken cancellationToken
Returns
Type Description
Task<SaleType>

A single SaleType

GetSaleTypeEntityAsync(int, CancellationToken)

Gets a SaleTypeEntity object.

Declaration
Task<SaleTypeEntity> GetSaleTypeEntityAsync(int saleTypeEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int saleTypeEntityId

The identifier of the SaleTypeEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<SaleTypeEntity>

A single SaleTypeEntity

GetSaleTypeListAsync(int[], CancellationToken)

Gets an array of SaleType objects.

Declaration
Task<SaleType[]> GetSaleTypeListAsync(int[] saleTypeIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] saleTypeIds

The identifiers of the SaleType object
CancellationToken cancellationToken
Returns
Type Description
Task<SaleType[]>

Array of SaleType

GetSelectionCategoryAsync(int, CancellationToken)

Gets a SelectionCategory object.

Declaration
Task<SelectionCategory> GetSelectionCategoryAsync(int selectionCategoryId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int selectionCategoryId

The identifier of the SelectionCategory object
CancellationToken cancellationToken
Returns
Type Description
Task<SelectionCategory>

A single SelectionCategory

GetSelectionCategoryListAsync(int[], CancellationToken)

Gets an array of SelectionCategory objects.

Declaration
Task<SelectionCategory[]> GetSelectionCategoryListAsync(int[] selectionCategoryIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] selectionCategoryIds

The identifiers of the SelectionCategory object
CancellationToken cancellationToken
Returns
Type Description
Task<SelectionCategory[]>

Array of SelectionCategory

GetSoTaskAsync(int, CancellationToken)

Gets a SoTask object.

Declaration
Task<SoTask> GetSoTaskAsync(int soTaskId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int soTaskId

The identifier of the SoTask object
CancellationToken cancellationToken
Returns
Type Description
Task<SoTask>

A single SoTask

GetSourceAsync(int, CancellationToken)

Gets a Source object.

Declaration
Task<Source> GetSourceAsync(int sourceId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int sourceId

The identifier of the Source object
CancellationToken cancellationToken
Returns
Type Description
Task<Source>

A single Source

GetSourceListAsync(int[], CancellationToken)

Gets an array of Source objects.

Declaration
Task<Source[]> GetSourceListAsync(int[] sourceIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] sourceIds

The identifiers of the Source object
CancellationToken cancellationToken
Returns
Type Description
Task<Source[]>

Array of Source

GetSourcesAsync(CancellationToken)

Returns all sources

Declaration
Task<Source[]> GetSourcesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Source[]>

Array of sources

GetTaskListAsync(int[], CancellationToken)

Gets an array of SoTask objects.

Declaration
Task<SoTask[]> GetTaskListAsync(int[] soTaskIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] soTaskIds

The identifiers of the SoTask object
CancellationToken cancellationToken
Returns
Type Description
Task<SoTask[]>

Array of SoTask

GetTaskMenuAsync(int, CancellationToken)

Gets a TaskMenu object.

Declaration
Task<TaskMenu> GetTaskMenuAsync(int taskMenuId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int taskMenuId

The identifier of the TaskMenu object
CancellationToken cancellationToken
Returns
Type Description
Task<TaskMenu>

A single TaskMenu

GetTaskMenuByProgIdAsync(string, CancellationToken)

Get a task menu using the ProgId key that was specified when it was created

Declaration
Task<TaskMenu> GetTaskMenuByProgIdAsync(string progId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string progId

String key that can be used to uniquely retrieve the taskmenu, set in the TaskMenu when saving
CancellationToken cancellationToken
Returns
Type Description
Task<TaskMenu>

The task menu

GetTasksAsync(CancellationToken)

Returns all appointment tasks

Declaration
Task<SoTask[]> GetTasksAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<SoTask[]>

An array of all available tasks

GetTicketCategoriesAsync(CancellationToken)

Interface for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration
Task<TicketCategoryEntity[]> GetTicketCategoriesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<TicketCategoryEntity[]>

GetTicketCategoriesForUserGroupsAsync(int[], CancellationToken)

Ticket categories for user groups

Declaration
Task<MDOListItem[]> GetTicketCategoriesForUserGroupsAsync(int[] userGroupIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] userGroupIds

The ids of the user groups we want tickets categories from
CancellationToken cancellationToken
Returns
Type Description
Task<MDOListItem[]>

GetTicketCategoryAsync(int, CancellationToken)

Gets a TicketCategory object.

Declaration
Task<TicketCategory> GetTicketCategoryAsync(int ticketCategoryId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketCategoryId

The identifier of the TicketCategory object
CancellationToken cancellationToken
Returns
Type Description
Task<TicketCategory>

A single TicketCategory

GetTicketCategoryEntityAsync(int, CancellationToken)

Gets a TicketCategoryEntity object.

Declaration
Task<TicketCategoryEntity> GetTicketCategoryEntityAsync(int ticketCategoryEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketCategoryEntityId

The identifier of the TicketCategoryEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<TicketCategoryEntity>

A single TicketCategoryEntity

GetTicketCategoryListAsync(int[], CancellationToken)

Gets an array of TicketCategoryEntity objects.

Declaration
Task<TicketCategoryEntity[]> GetTicketCategoryListAsync(int[] ticketCategoryEntityIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] ticketCategoryEntityIds

The identifiers of the TicketCategoryEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<TicketCategoryEntity[]>

Array of TicketCategoryEntity

GetTicketPrioritiesAsync(CancellationToken)

Interface for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration
Task<TicketPriority[]> GetTicketPrioritiesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<TicketPriority[]>

GetTicketPriorityAsync(int, CancellationToken)

Gets a TicketPriority object.

Declaration
Task<TicketPriority> GetTicketPriorityAsync(int ticketPriorityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketPriorityId

The identifier of the TicketPriority object
CancellationToken cancellationToken
Returns
Type Description
Task<TicketPriority>

A single TicketPriority

GetTicketPriorityEntityAsync(int, CancellationToken)

Gets a TicketPriorityEntity object.

Declaration
Task<TicketPriorityEntity> GetTicketPriorityEntityAsync(int ticketPriorityEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketPriorityEntityId

The identifier of the TicketPriorityEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<TicketPriorityEntity>

A single TicketPriorityEntity

GetTicketPriorityListAsync(int[], CancellationToken)

Gets an array of TicketPriority objects.

Declaration
Task<TicketPriority[]> GetTicketPriorityListAsync(int[] ticketPriorityIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] ticketPriorityIds

The identifiers of the TicketPriority object
CancellationToken cancellationToken
Returns
Type Description
Task<TicketPriority[]>

Array of TicketPriority

GetTicketRelationDefinitionEntityAsync(int, CancellationToken)

Gets a TicketRelationDefinitionEntity object.

Declaration
Task<TicketRelationDefinitionEntity> GetTicketRelationDefinitionEntityAsync(int ticketRelationDefinitionEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketRelationDefinitionEntityId

The identifier of the TicketRelationDefinitionEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<TicketRelationDefinitionEntity>

A single TicketRelationDefinitionEntity

GetTicketStatusEntityAsync(int, CancellationToken)

Gets a TicketStatusEntity object.

Declaration
Task<TicketStatusEntity> GetTicketStatusEntityAsync(int ticketStatusEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketStatusEntityId

The identifier of the TicketStatusEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<TicketStatusEntity>

A single TicketStatusEntity

GetTicketStatusListAsync(int[], CancellationToken)

Gets an array of TicketStatusEntity objects.

Declaration
Task<TicketStatusEntity[]> GetTicketStatusListAsync(int[] ticketStatusEntityIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] ticketStatusEntityIds

The identifiers of the TicketStatusEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<TicketStatusEntity[]>

Array of TicketStatusEntity

GetTicketStatusesAsync(CancellationToken)

Interface for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration
Task<TicketStatusEntity[]> GetTicketStatusesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<TicketStatusEntity[]>

GetTicketTypeEntityAsync(int, CancellationToken)

Gets a TicketTypeEntity object.

Declaration
Task<TicketTypeEntity> GetTicketTypeEntityAsync(int ticketTypeEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketTypeEntityId

The identifier of the TicketTypeEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<TicketTypeEntity>

A single TicketTypeEntity

GetTicketTypeListAsync(int[], CancellationToken)

Gets an array of TicketTypeEntity objects.

Declaration
Task<TicketTypeEntity[]> GetTicketTypeListAsync(int[] ticketTypeEntityIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int[] ticketTypeEntityIds

The identifiers of the TicketTypeEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<TicketTypeEntity[]>

Array of TicketTypeEntity

GetTicketTypesAsync(CancellationToken)

Get all TicketTypes

Declaration
Task<TicketTypeEntity[]> GetTicketTypesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<TicketTypeEntity[]>

GetVisibleForUserGroupsAsync(int, int, CancellationToken)

List of User groups that this list item is visible for

Declaration
Task<SelectableMDOListItem[]> GetVisibleForUserGroupsAsync(int udListDefinitionId, int listItemId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
int listItemId

The id of the list item
CancellationToken cancellationToken
Returns
Type Description
Task<SelectableMDOListItem[]>

Array of selectable user groups

GetVisibleForUserGroupsFromListNameAsync(string, int, CancellationToken)

List of User groups that this list item is visible for

Declaration
Task<SelectableMDOListItem[]> GetVisibleForUserGroupsFromListNameAsync(string udListDefinitionName, int listItemId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string udListDefinitionName

The name of the list definition.
int listItemId

The id of the list item
CancellationToken cancellationToken
Returns
Type Description
Task<SelectableMDOListItem[]>

Array of selectable user groups

GetWebPanelByProgIdAsync(string, CancellationToken)

Get a web panel using the ProgId key that was specified when it was created

Declaration
Task<WebPanelEntity> GetWebPanelByProgIdAsync(string progId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string progId

String key that can be used to uniquely retrieve the panel, set in the WebPanelEntity when saving
CancellationToken cancellationToken
Returns
Type Description
Task<WebPanelEntity>

The Web panel information

GetWebPanelEntityAsync(int, CancellationToken)

Gets a WebPanelEntity object.

Declaration
Task<WebPanelEntity> GetWebPanelEntityAsync(int webPanelEntityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int webPanelEntityId

The identifier of the WebPanelEntity object
CancellationToken cancellationToken
Returns
Type Description
Task<WebPanelEntity>

A single WebPanelEntity

GetWebPanelListAsync(CancellationToken)

Return a list of all web panels.

Declaration
Task<WebPanelEntity[]> GetWebPanelListAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<WebPanelEntity[]>

List of all web panels

GlobalChangeTicketStatusAsync(int, int, CancellationToken)

This method will change all references from one ticket status to another. Typically used in conjuction with delete

Declaration
Task GlobalChangeTicketStatusAsync(int fromTicketStatusId, int toTicketStatusId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int fromTicketStatusId

The id of the ticket status to change from
int toTicketStatusId

The id of the ticket status to change to
CancellationToken cancellationToken
Returns
Type Description
Task

Does not return anything

GlobalChangeTicketTypeAsync(int, int, CancellationToken)

Change all references from one ticket type to another. Typically used in conjuction with ticket type delete

Declaration
Task GlobalChangeTicketTypeAsync(int fromTicketTypeId, int toTicketTypeId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int fromTicketTypeId

The id of the ticket type to change from
int toTicketTypeId

The id of the ticket type to change to
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

MoveAllTicketsAsync(int, int, CancellationToken)

Move all tickets from one ticket category to another

Declaration
Task MoveAllTicketsAsync(int fromTicketCategoryId, int toTicketCategoryId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int fromTicketCategoryId

The id of the category we want to move tickets from
int toTicketCategoryId

The id of the category we want to move the tickets to
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

MoveListItemAsync(int, int, int, CancellationToken)

Move a list item up or down in the list based on rank

Declaration
Task MoveListItemAsync(int udListDefinitionId, int listItemId, int direction, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

Id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
int listItemId

Id of the list item
int direction

-1 moves the item up one position, 1 moves the item down one position
CancellationToken cancellationToken
Returns
Type Description
Task

PerformNeededCategoryUpdateAsync(int, int, int, AutomatedCategoryUpdate, CancellationToken)

Does the actual update of the category. Ask the user first, if user confirmed yes, do automatically update category, this call will do that actual update

Declaration
Task PerformNeededCategoryUpdateAsync(int personId, int contactId, int categoryId, AutomatedCategoryUpdate setting, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int personId

The person id that will get the resulting update
int contactId

The contact id that will get the resulting update
int categoryId

The category id person and contact will be updated to
AutomatedCategoryUpdate setting

The setting that triggered the update
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

RebuildFullnamesAsync(CancellationToken)

Update the fullname field of all categories. Use this e.g. when changing parentId or renaming a category with children.

Declaration
Task RebuildFullnamesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

SaveAllAutomatedCategoryUpdatesAsync(AutomatedCategoryUpdate[], CancellationToken)

Save the automated category update settings

Declaration
Task<AutomatedCategoryUpdate[]> SaveAllAutomatedCategoryUpdatesAsync(AutomatedCategoryUpdate[] settings, CancellationToken cancellationToken = default)
Parameters
Type Name Description
AutomatedCategoryUpdate[] settings

All settings for autoupdate category
CancellationToken cancellationToken
Returns
Type Description
Task<AutomatedCategoryUpdate[]>

Returns the saved settings

SaveAllFromListDefinitionAsync(int, ListItemEntity[], CancellationToken)

Save all list items for the specified list defintion

Declaration
Task<ListItemEntity[]> SaveAllFromListDefinitionAsync(int udListDefinitionId, ListItemEntity[] items, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list definition, indicating which list to save the items to. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
ListItemEntity[] items

The list items
CancellationToken cancellationToken
Returns
Type Description
Task<ListItemEntity[]>

The list items

SaveAllFromListNameAsync(string, ListItemEntity[], CancellationToken)

Save all list items for the specified list defintion

Declaration
Task<ListItemEntity[]> SaveAllFromListNameAsync(string udListDefinitionName, ListItemEntity[] items, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string udListDefinitionName

The name of the list definition, indicating which list to save the items to.
ListItemEntity[] items

The list items
CancellationToken cancellationToken
Returns
Type Description
Task<ListItemEntity[]>

The list items

SaveAmountClassEntityAsync(AmountClassEntity, CancellationToken)

Updates the existing AmountClassEntity or creates a new AmountClassEntity if the id parameter is 0.

Declaration
Task<AmountClassEntity> SaveAmountClassEntityAsync(AmountClassEntity amountClassEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
AmountClassEntity amountClassEntity

The AmountClassEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<AmountClassEntity>

New or updated AmountClassEntity

SaveCategoryEntityAsync(CategoryEntity, CancellationToken)

Updates the existing CategoryEntity or creates a new CategoryEntity if the id parameter is 0.

Declaration
Task<CategoryEntity> SaveCategoryEntityAsync(CategoryEntity categoryEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CategoryEntity categoryEntity

The CategoryEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<CategoryEntity>

New or updated CategoryEntity

SaveConsentPurposeAsync(ConsentPurpose, CancellationToken)

Save a ConsentPurpose object

Declaration
Task<ConsentPurpose> SaveConsentPurposeAsync(ConsentPurpose consentPurpose, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ConsentPurpose consentPurpose

The ConsentPurpose object to save
CancellationToken cancellationToken
Returns
Type Description
Task<ConsentPurpose>

The saved ConsentPurpose object, updated with the ConsentPurposeId if it is a new database entry

SaveConsentSourceAsync(ConsentSource, CancellationToken)

Interface for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration
Task<ConsentSource> SaveConsentSourceAsync(ConsentSource consentSource, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ConsentSource consentSource
CancellationToken cancellationToken
Returns
Type Description
Task<ConsentSource>

SaveCountryAsync(Country, CancellationToken)

Saves a country

Declaration
Task<Country> SaveCountryAsync(Country country, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Country country

The country to save
CancellationToken cancellationToken
Returns
Type Description
Task<Country>

The country that is saved

SaveCurrencyEntityAsync(CurrencyEntity, CancellationToken)

Updates the existing CurrencyEntity or creates a new CurrencyEntity if the id parameter is 0.

Declaration
Task<CurrencyEntity> SaveCurrencyEntityAsync(CurrencyEntity currencyEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CurrencyEntity currencyEntity

The CurrencyEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<CurrencyEntity>

New or updated CurrencyEntity

SaveDocumentTemplateEntityAsync(DocumentTemplateEntity, CancellationToken)

Updates the existing DocumentTemplateEntity or creates a new DocumentTemplateEntity if the id parameter is 0.

Declaration
Task<DocumentTemplateEntity> SaveDocumentTemplateEntityAsync(DocumentTemplateEntity documentTemplateEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DocumentTemplateEntity documentTemplateEntity

The DocumentTemplateEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<DocumentTemplateEntity>

New or updated DocumentTemplateEntity

SaveDocumentTemplateStreamAsync(int, Stream, string, int, CancellationToken)

Writes content in stream to document template file

Declaration
Task<TemplateInfo> SaveDocumentTemplateStreamAsync(int documentTemplateId, Stream content, string languageCode, int pluginId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentTemplateId

Identifier for document template
Stream content

Stream containing content to be saved to document template file
string languageCode

Language variation of template to update. (ISO code: "en-US" or "nb-NO" etc). Used to select a template of the appropriate language. Can be overridden in SO ARC by user preference "PreferDocLang".
int pluginId

Plugin to use for storing document content. 0 = SOARC. Use -1 to use the plugin specified in the template.
CancellationToken cancellationToken
Returns
Type Description
Task<TemplateInfo>

Template info

SaveExtAppEntityAsync(ExtAppEntity, CancellationToken)

Updates the existing ExtAppEntity or creates a new ExtAppEntity if the id parameter is 0.

Declaration
Task<ExtAppEntity> SaveExtAppEntityAsync(ExtAppEntity extAppEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ExtAppEntity extAppEntity

The ExtAppEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<ExtAppEntity>

New or updated ExtAppEntity

SaveFromListDefinitionAsync(int, int, ListItemEntity, CancellationToken)

Save a list item for the specified list defintion

Declaration
Task<ListItemEntity> SaveFromListDefinitionAsync(int id, int udListDefinitionId, ListItemEntity item, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int id

The identity of the list item to load
int udListDefinitionId

The id of the list definition, indicating which list to save the item to. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
ListItemEntity item

The item to save
CancellationToken cancellationToken
Returns
Type Description
Task<ListItemEntity>

The saved list item

SaveFromListNameAsync(int, string, ListItemEntity, CancellationToken)

Save a list item for the specified list defintion

Declaration
Task<ListItemEntity> SaveFromListNameAsync(int id, string udListDefinitionName, ListItemEntity item, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int id

The identity of the list item to load
string udListDefinitionName

The name of the list definition, indicating which list to save the item to.
ListItemEntity item

The item to save
CancellationToken cancellationToken
Returns
Type Description
Task<ListItemEntity>

The saved list item

SaveHeadingEntityAsync(HeadingEntity, CancellationToken)

Updates the existing HeadingEntity or creates a new HeadingEntity if the id parameter is 0.

Declaration
Task<HeadingEntity> SaveHeadingEntityAsync(HeadingEntity headingEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
HeadingEntity headingEntity

The HeadingEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<HeadingEntity>

New or updated HeadingEntity

SaveHeadingFromListDefinitionAsync(int, HeadingEntity, CancellationToken)

Save new heading for list resolved by the provided id.

Declaration
Task<HeadingEntity> SaveHeadingFromListDefinitionAsync(int id, HeadingEntity entity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int id

The id of the list to look up.
HeadingEntity entity

The new heading to save
CancellationToken cancellationToken
Returns
Type Description
Task<HeadingEntity>

The saved entity.

SaveHeadingFromNameAsync(string, HeadingEntity, CancellationToken)

Save new heading for list resolved by the provided name.

Declaration
Task<HeadingEntity> SaveHeadingFromNameAsync(string name, HeadingEntity entity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name

The name of the list to look up.
HeadingEntity entity

The new heading to save
CancellationToken cancellationToken
Returns
Type Description
Task<HeadingEntity>

The saved entity.

SaveHeadingsForListItemFromListDefinitionAsync(int, int, SelectableMDOListItem[], CancellationToken)

Saves the active headings for the list item.

Declaration
Task<SelectableMDOListItem[]> SaveHeadingsForListItemFromListDefinitionAsync(int udListDefinitionId, int listItemId, SelectableMDOListItem[] headings, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list definition, indicating which list to delete the items from. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
int listItemId

The identity of the list item to delete
SelectableMDOListItem[] headings

The headings to save.
CancellationToken cancellationToken
Returns
Type Description
Task<SelectableMDOListItem[]>

Array of headings

SaveHeadingsForListItemFromListNameAsync(string, int, SelectableMDOListItem[], CancellationToken)

Saves the headings for the list item.

Declaration
Task<SelectableMDOListItem[]> SaveHeadingsForListItemFromListNameAsync(string udListDefinitionName, int listItemId, SelectableMDOListItem[] headings, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string udListDefinitionName

The name of the list definition, indicating which list to update.
int listItemId

The identity of the list item
SelectableMDOListItem[] headings

The headings to save.
CancellationToken cancellationToken
Returns
Type Description
Task<SelectableMDOListItem[]>

Array of selectable headings

SaveHeadingsFromListDefinitionAsync(int, HeadingEntity[], CancellationToken)

Save headings for list resolved by the provided id.

Declaration
Task<HeadingEntity[]> SaveHeadingsFromListDefinitionAsync(int id, HeadingEntity[] entities, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int id

The id of the list to look up.
HeadingEntity[] entities

The headings to save
CancellationToken cancellationToken
Returns
Type Description
Task<HeadingEntity[]>

List of headings

SaveHeadingsFromNameAsync(string, HeadingEntity[], CancellationToken)

Save headings for list resolved by the provided name.

Declaration
Task<HeadingEntity[]> SaveHeadingsFromNameAsync(string name, HeadingEntity[] entities, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name

The name of the list to look up.
HeadingEntity[] entities

The headings to save
CancellationToken cancellationToken
Returns
Type Description
Task<HeadingEntity[]>

List of headings

SaveHierarchyEntityAsync(HierarchyEntity, CancellationToken)

Updates the existing HierarchyEntity or creates a new HierarchyEntity if the id parameter is 0.

Declaration
Task<HierarchyEntity> SaveHierarchyEntityAsync(HierarchyEntity hierarchyEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
HierarchyEntity hierarchyEntity

The HierarchyEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<HierarchyEntity>

New or updated HierarchyEntity

SaveLegalBaseAsync(LegalBase, CancellationToken)

Interface for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration
Task<LegalBase> SaveLegalBaseAsync(LegalBase legalBase, CancellationToken cancellationToken = default)
Parameters
Type Name Description
LegalBase legalBase
CancellationToken cancellationToken
Returns
Type Description
Task<LegalBase>

SaveListEntityAsync(ListEntity, CancellationToken)

Updates the existing ListEntity or creates a new ListEntity if the id parameter is 0.

Declaration
Task<ListEntity> SaveListEntityAsync(ListEntity listEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListEntity listEntity

The ListEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<ListEntity>

New or updated ListEntity

SaveListEntityByNameAsync(string, ListEntity, CancellationToken)

Save a ListEntity resolved by the provided name.

Declaration
Task<ListEntity> SaveListEntityByNameAsync(string name, ListEntity listEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name

The name of the list to save.
ListEntity listEntity

The ListEntity to save.
CancellationToken cancellationToken
Returns
Type Description
Task<ListEntity>

A ListEntity or null.

SaveListItemEntityAsync(ListItemEntity, CancellationToken)

Save the ListItemEntity.

Declaration
Task<ListItemEntity> SaveListItemEntityAsync(ListItemEntity listItemEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListItemEntity listItemEntity

The ListItemEntity to save.
CancellationToken cancellationToken
Returns
Type Description
Task<ListItemEntity>

The saved ListItemEntity.

SaveProjectTypeEntityAsync(ProjectTypeEntity, CancellationToken)

Updates the existing ProjectTypeEntity or creates a new ProjectTypeEntity if the id parameter is 0.

Declaration
Task<ProjectTypeEntity> SaveProjectTypeEntityAsync(ProjectTypeEntity projectTypeEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ProjectTypeEntity projectTypeEntity

The ProjectTypeEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<ProjectTypeEntity>

New or updated ProjectTypeEntity

SaveQuickRepliesAsync(QuickReply[], CancellationToken)

Method to save all quick replies for a given associate

Declaration
Task SaveQuickRepliesAsync(QuickReply[] quickReplies, CancellationToken cancellationToken = default)
Parameters
Type Name Description
QuickReply[] quickReplies

Array of quick replies
CancellationToken cancellationToken
Returns
Type Description
Task

SaveRelationDefinitionEntityAsync(RelationDefinitionEntity, CancellationToken)

Updates the existing RelationDefinitionEntity or creates a new RelationDefinitionEntity if the id parameter is 0.

Declaration
Task<RelationDefinitionEntity> SaveRelationDefinitionEntityAsync(RelationDefinitionEntity relationDefinitionEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
RelationDefinitionEntity relationDefinitionEntity

The RelationDefinitionEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<RelationDefinitionEntity>

New or updated RelationDefinitionEntity

SaveResourceEntityAsync(ResourceEntity, CancellationToken)

Updates the existing ResourceEntity or creates a new ResourceEntity if the id parameter is 0.

Declaration
Task<ResourceEntity> SaveResourceEntityAsync(ResourceEntity resourceEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ResourceEntity resourceEntity

The ResourceEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<ResourceEntity>

New or updated ResourceEntity

SaveSaleStageEntityAsync(SaleStageEntity, CancellationToken)

Updates the existing SaleStageEntity or creates a new SaleStageEntity if the id parameter is 0.

Declaration
Task<SaleStageEntity> SaveSaleStageEntityAsync(SaleStageEntity saleStageEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SaleStageEntity saleStageEntity

The SaleStageEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<SaleStageEntity>

New or updated SaleStageEntity

SaveSaleTypeEntityAsync(SaleTypeEntity, CancellationToken)

Updates the existing SaleTypeEntity or creates a new SaleTypeEntity if the id parameter is 0.

Declaration
Task<SaleTypeEntity> SaveSaleTypeEntityAsync(SaleTypeEntity saleTypeEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SaleTypeEntity saleTypeEntity

The SaleTypeEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<SaleTypeEntity>

New or updated SaleTypeEntity

SaveTaskMenuAsync(TaskMenu, CancellationToken)

Updates the existing TaskMenu or creates a new TaskMenu if the id parameter is 0.

Declaration
Task<TaskMenu> SaveTaskMenuAsync(TaskMenu taskMenu, CancellationToken cancellationToken = default)
Parameters
Type Name Description
TaskMenu taskMenu

The TaskMenu that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<TaskMenu>

New or updated TaskMenu

SaveTicketCategoryEntityAsync(TicketCategoryEntity, CancellationToken)

Updates the existing TicketCategoryEntity or creates a new TicketCategoryEntity if the id parameter is 0.

Declaration
Task<TicketCategoryEntity> SaveTicketCategoryEntityAsync(TicketCategoryEntity ticketCategoryEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
TicketCategoryEntity ticketCategoryEntity

The TicketCategoryEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<TicketCategoryEntity>

New or updated TicketCategoryEntity

SaveTicketPriorityEntityAsync(TicketPriorityEntity, CancellationToken)

Updates the existing TicketPriorityEntity or creates a new TicketPriorityEntity if the id parameter is 0.

Declaration
Task<TicketPriorityEntity> SaveTicketPriorityEntityAsync(TicketPriorityEntity ticketPriorityEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
TicketPriorityEntity ticketPriorityEntity

The TicketPriorityEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<TicketPriorityEntity>

New or updated TicketPriorityEntity

SaveTicketRelationDefinitionEntityAsync(TicketRelationDefinitionEntity, CancellationToken)

Updates the existing TicketRelationDefinitionEntity or creates a new TicketRelationDefinitionEntity if the id parameter is 0.

Declaration
Task<TicketRelationDefinitionEntity> SaveTicketRelationDefinitionEntityAsync(TicketRelationDefinitionEntity ticketRelationDefinitionEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
TicketRelationDefinitionEntity ticketRelationDefinitionEntity

The TicketRelationDefinitionEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<TicketRelationDefinitionEntity>

New or updated TicketRelationDefinitionEntity

SaveTicketStatusEntityAsync(TicketStatusEntity, CancellationToken)

Updates the existing TicketStatusEntity or creates a new TicketStatusEntity if the id parameter is 0.

Declaration
Task<TicketStatusEntity> SaveTicketStatusEntityAsync(TicketStatusEntity ticketStatusEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
TicketStatusEntity ticketStatusEntity

The TicketStatusEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<TicketStatusEntity>

New or updated TicketStatusEntity

SaveTicketTypeEntityAsync(TicketTypeEntity, CancellationToken)

Updates the existing TicketTypeEntity or creates a new TicketTypeEntity if the id parameter is 0.

Declaration
Task<TicketTypeEntity> SaveTicketTypeEntityAsync(TicketTypeEntity ticketTypeEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
TicketTypeEntity ticketTypeEntity

The TicketTypeEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<TicketTypeEntity>

New or updated TicketTypeEntity

SaveWebPanelEntityAsync(WebPanelEntity, CancellationToken)

Updates the existing WebPanelEntity or creates a new WebPanelEntity if the id parameter is 0.

Declaration
Task<WebPanelEntity> SaveWebPanelEntityAsync(WebPanelEntity webPanelEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
WebPanelEntity webPanelEntity

The WebPanelEntity that is saved
CancellationToken cancellationToken
Returns
Type Description
Task<WebPanelEntity>

New or updated WebPanelEntity

SetDocumentPluginForAllDocumentTemplatesAsync(int, CancellationToken)

Sets the document-plugin to be used for all templates of type 'document'.

Declaration
Task SetDocumentPluginForAllDocumentTemplatesAsync(int documentPluginId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentPluginId

The numerical ID of the document-plugin to use.
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

SetDocumentTemplateFromDocumentTemplateAsync(int, DocumentTemplateEntity, CancellationToken)

Create a new document template based on another template

Declaration
Task<DocumentTemplateEntity> SetDocumentTemplateFromDocumentTemplateAsync(int sourceDocumentTemplateId, DocumentTemplateEntity documentTemplateEntity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int sourceDocumentTemplateId

The document template to copy contents from.
DocumentTemplateEntity documentTemplateEntity

The new document template entity
CancellationToken cancellationToken
Returns
Type Description
Task<DocumentTemplateEntity>

The new document template entity

SetDocumentTemplateStreamAsync(DocumentTemplateEntity, Stream, string, int, CancellationToken)

Store a document template from its stream. Since there is a potential for a name conflict (the file name stored by the document entity earlier may prove to be invalid), the (possibly amended) document entity is returned. The client should not assume that any earlier, cached entity information is valid.

Declaration
Task<DocumentTemplateEntity> SetDocumentTemplateStreamAsync(DocumentTemplateEntity documentTemplateEntity, Stream stream, string languageCode, int pluginId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DocumentTemplateEntity documentTemplateEntity

The document entity object that the binary data (document) should be stored to. Its file name may be amended by this call, see the return value
Stream stream

The document as a stream.
string languageCode

The language code ('en-US', 'nb-NO', etc). Use empty string if not supported or used.
int pluginId

The plugin id to store the template with. 0 for SOArc
CancellationToken cancellationToken
Returns
Type Description
Task<DocumentTemplateEntity>

Since there is a potential for a name conflict (the file name stored by the document entity earlier may prove to be invalid), the (possibly amended) document entity is returned. The client should not assume that any earlier, cached entity information is valid.

SetEmarketingStrictModeAsync(bool, CancellationToken)

Turn on the Emarketing strict mode, which will enable full GDPR rules concerning Emarketing consents and subscriptions

Declaration
Task SetEmarketingStrictModeAsync(bool enable, CancellationToken cancellationToken = default)
Parameters
Type Name Description
bool enable

Set to true to enable strict mode
CancellationToken cancellationToken
Returns
Type Description
Task

A void return

SetHeadingsForListItemAsync(int, int, int[], bool, CancellationToken)

Set headings which this list item should be listed under

Declaration
Task SetHeadingsForListItemAsync(int udListDefinitionId, int listItemId, int[] headingIds, bool enable, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
int listItemId

The id of the list item
int[] headingIds

The ids of the headings to set for this list item
bool enable

Set to true to enable, false to disable
CancellationToken cancellationToken
Returns
Type Description
Task

SetListItemsForHeadingAsync(int, int, int[], bool, CancellationToken)

Update listItems that will be visible for this usergroup

Declaration
Task SetListItemsForHeadingAsync(int udListDefinitionId, int headingId, int[] listItemIds, bool enable, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
int headingId

The id of the heading
int[] listItemIds

The ids of the list items.
bool enable

True to enable, false to disable
CancellationToken cancellationToken
Returns
Type Description
Task

SetListItemsForHeadingFromListNameAsync(string, int, int[], bool, CancellationToken)

Update listItems under this heading

Declaration
Task SetListItemsForHeadingFromListNameAsync(string udListDefinitionName, int headingId, int[] listItemIds, bool enable, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string udListDefinitionName

The name of the list definition.
int headingId

The id of the heading
int[] listItemIds

The ids of the list items.
bool enable

True to enable, false to disable
CancellationToken cancellationToken
Returns
Type Description
Task

SetListItemsForUserGroupAsync(int, int, int[], bool, CancellationToken)

Update listItems that will be visible for this usergroup

Declaration
Task SetListItemsForUserGroupAsync(int udListDefinitionId, int usergroupId, int[] listItemIds, bool enable, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
int usergroupId

The id of the userGroup
int[] listItemIds

The id of the list items.
bool enable

True to enable, false to disable
CancellationToken cancellationToken
Returns
Type Description
Task

SetListItemsForUserGroupFromListNameAsync(string, int, int[], bool, CancellationToken)

Update listItems that will be visible for this usergroup

Declaration
Task SetListItemsForUserGroupFromListNameAsync(string udListDefinitionName, int usergroupId, int[] listItemsID, bool enable, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string udListDefinitionName

The name of the list definition.
int usergroupId

The id of the userGroup
int[] listItemsID

The id of the list items.
bool enable

True to enable, false to disable
CancellationToken cancellationToken
Returns
Type Description
Task

SetRankOnHeadingsAsync(int, int[], CancellationToken)

Set rank order on headings

Declaration
Task SetRankOnHeadingsAsync(int udListDefinitionId, int[] headingIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
int[] headingIds

The ids of the headings in the order you want
CancellationToken cancellationToken
Returns
Type Description
Task

SetRankOnProjectActivityAsync(int, int[], CancellationToken)

Set rank order on project activity

Declaration
Task SetRankOnProjectActivityAsync(int projectTypeStatusLinkId, int[] itemsIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int projectTypeStatusLinkId

The id of the list
int[] itemsIds

The ids of the items in the order you want
CancellationToken cancellationToken
Returns
Type Description
Task

SetRankOnProjectDocumentAsync(int, int[], CancellationToken)

Set rank order on project document

Declaration
Task SetRankOnProjectDocumentAsync(int projectTypeStatusLinkId, int[] itemsIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int projectTypeStatusLinkId

The id of the list
int[] itemsIds

The ids of the items in the order you want
CancellationToken cancellationToken
Returns
Type Description
Task

SetRankOnSaleActivityAsync(int, int[], CancellationToken)

Set rank order on sale activity

Declaration
Task SetRankOnSaleActivityAsync(int saleTypeStageLinkId, int[] itemsIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int saleTypeStageLinkId

The id of the list
int[] itemsIds

The ids of the items in the order you want
CancellationToken cancellationToken
Returns
Type Description
Task

SetRankOnSaleDocumentAsync(int, int[], CancellationToken)

Set rank order on project document

Declaration
Task SetRankOnSaleDocumentAsync(int saleTypeStageLinkId, int[] itemsIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int saleTypeStageLinkId

The id of the list
int[] itemsIds

The ids of the items in the order you want
CancellationToken cancellationToken
Returns
Type Description
Task

SetTicketCategoriesForUserGroupAsync(int, int[], CancellationToken)

Set ticket categories for one user group

Declaration
Task SetTicketCategoriesForUserGroupAsync(int userGroupId, int[] categoryIds, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int userGroupId

The ids of the user groups we want tickets categories from
int[] categoryIds

The ids of the user groups we want tickets categories from
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

SetTicketPrioritySortOrderAsync(int, int, CancellationToken)

This method will set sort order of ticket priority in a list

Declaration
Task SetTicketPrioritySortOrderAsync(int ticketPriorityId, int sortOrder, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketPriorityId

Id of ticket priority
int sortOrder

Indicates the sort order for this priority. 1 is first. Any records following this one will be renumbered automatically
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

SetTicketRelationDefinitionSortOrderAsync(int, int, CancellationToken)

This method will set sort order of ticket relation definition in a list

Declaration
Task SetTicketRelationDefinitionSortOrderAsync(int ticketRelationDefId, int sortOrder, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketRelationDefId

Id of ticket relation definition
int sortOrder

Indicates the sort order for this relation definition. 1 is first. Any records following this one will be renumbered automatically
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

SetTicketStatusSortOrderAsync(int, int, CancellationToken)

This method will set sort order of ticket status in a list

Declaration
Task SetTicketStatusSortOrderAsync(int ticketStatusId, int sortOrder, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketStatusId

Id of ticket status
int sortOrder

Indicates the sort order for this status. 1 is first. Any records following this one will be renumbered automatically
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

SetTicketTypeSortOrderAsync(int, int, CancellationToken)

This method will set sort order of ticket type in a list

Declaration
Task SetTicketTypeSortOrderAsync(int ticketTypeId, int sortOrder, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketTypeId

Id of ticket type
int sortOrder

Indicates the sort order for this ticket type. 1 is first. Any records following this one will be renumbered automatically
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

SetVisibleForUserGroupAsync(int, int, int[], bool, CancellationToken)

Set a group which this list item should be visible for

Declaration
Task SetVisibleForUserGroupAsync(int udListDefinitionId, int listItemId, int[] userGroupId, bool enable, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
int listItemId

The id of the list item
int[] userGroupId

The id of the user groups to set for this list item
bool enable

Set to true to enable, false to disable
CancellationToken cancellationToken
Returns
Type Description
Task

SetVisibleForUserGroupsAsync(int, int, SelectableMDOListItem[], CancellationToken)

Update User groups that this list item is visible for

Declaration
Task<SelectableMDOListItem[]> SetVisibleForUserGroupsAsync(int udListDefinitionId, int listItemId, SelectableMDOListItem[] userGroups, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
int listItemId

The id of the list item
SelectableMDOListItem[] userGroups

The selectable user groups.
CancellationToken cancellationToken
Returns
Type Description
Task<SelectableMDOListItem[]>

Array of selectable user groups

SetVisibleForUserGroupsFromListNameAsync(string, int, SelectableMDOListItem[], CancellationToken)

Update User groups that this list item is visible for

Declaration
Task<SelectableMDOListItem[]> SetVisibleForUserGroupsFromListNameAsync(string udListDefinitionName, int listItemId, SelectableMDOListItem[] userGroups, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string udListDefinitionName

The name of the list definition, indicating which list to update the items from.
int listItemId

The id of the list item
SelectableMDOListItem[] userGroups

The selectable user groups.
CancellationToken cancellationToken
Returns
Type Description
Task<SelectableMDOListItem[]>

Array of selectable user groups

SortListItemsAsync(int, string, CancellationToken)

Sort the list items in a given list alphabetically

Declaration
Task SortListItemsAsync(int udListDefinitionId, string cultureName, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int udListDefinitionId

Id of the list you want to sort. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
string cultureName

Sort list in this language
CancellationToken cancellationToken
Returns
Type Description
Task

UpdateCategoryMembershipsAsync(int, TicketCategoryMembershipEntity[], TicketCategoryMembershipEntity[], TicketCategoryMembershipEntity[], CancellationToken)

Updates category memberships

Declaration
Task UpdateCategoryMembershipsAsync(int ticketCategoryId, TicketCategoryMembershipEntity[] membershipsToAdd, TicketCategoryMembershipEntity[] membershipsToUpdate, TicketCategoryMembershipEntity[] membershipsToDelete, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int ticketCategoryId

Id of ticket category to update memberships for
TicketCategoryMembershipEntity[] membershipsToAdd

List of memberships to add
TicketCategoryMembershipEntity[] membershipsToUpdate

List of memberships to update
TicketCategoryMembershipEntity[] membershipsToDelete

List of memberships to delete
CancellationToken cancellationToken
Returns
Type Description
Task

This method has no return value

UpdateHierarchyFromPathAsync(Domain, string, HierarchyEntity, CancellationToken)

Update a hierarchy item from a path

Declaration
Task<HierarchyEntity> UpdateHierarchyFromPathAsync(Domain domain, string path, HierarchyEntity entity, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Domain domain

Type of items to get
string path

Hierarchy path to item
HierarchyEntity entity

The hierarchy node to update.
CancellationToken cancellationToken
Returns
Type Description
Task<HierarchyEntity>

The hierarchy node updated to the path