Class ListAgent
Namespace: SuperOffice.WebApi.AgentsAssembly: SuperOffice.WebApi.dll Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.
Inheritance
object ← AgentBase ← ListAgentImplements
IListAgent, IAgentBase, IDisposableInherited Members
AgentBase._json, AgentBase._binary, AgentBase._config, AgentBase._client, AgentBase._disposeClient, AgentBase.Merge(RequestOptions), AgentBase.BuildRequestFromObject(HttpMethod, string, object, WebApiOptions, string), AgentBase.BuildRequestFromStream(HttpMethod, string, Stream, WebApiOptions, string), AgentBase.BuildRequestFromObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string), AgentBase.ParseAuthorization(IAuthorization), AgentBase.CancelRequest(), AgentBase.SendRequestObject(HttpMethod, string, object, WebApiOptions, string), AgentBase.SendRequestObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string), AgentBase.SendRequest(HttpRequestMessage, RequestOptions), AgentBase.ThrowOnResponseErrorAsync(HttpRequestMessage, HttpResponseMessage), AgentBase.ParseResponse<T>(HttpResponseMessage), AgentBase.Finally(RequestOptions), AgentBase.Dispose(), AgentBase.Configuration, AgentBase.Client, AgentBase.HasRunningRequest, AgentBase.ClientCancellationTokenSource, AgentBase.ProgressListener, AgentBase.UploadProgressListener, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()Examples
<pre><code class=“lang-csharp”>using SuperOffice.WebApi; using SuperOffice.WebApi.Agents; var mySession = new WebApiOptions(“http://example.com/super/api”); mySession.Authorization = new AuthorizationUsernamePassword(“user”, “pass”); using (ListAgent agent = new ListAgent(mySession)) { // call methods on agent here… }</code></pre>Constructors
ListAgent(HttpClient)
Constructor: Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.Parameters
httpClient HttpClient
Use this HTTP client instead of making own HttpClient instance.
ListAgent(WebApiOptions, HttpClient)
Constructor: Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.Parameters
options WebApiOptions
Base URL and authentication values.
httpClient HttpClient
Optional: Use this HTTP client instead of making a new one.
Methods
AddFromListDefinitionAsync(int, ListItemEntity, RequestOptions)
Save a new list item for the specified list defintionParameters
udListDefinitionId int
The name of the list definition, indicating which list to save the item to.
item ListItemEntity
The item to save
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListItemEntity> The saved list itemAddFromListNameAsync(string, ListItemEntity, RequestOptions)
Save a new list item for the specified list defintionParameters
udListDefinitionName string
The name of the list definition, indicating which list to save the item to.
item ListItemEntity
The item to save
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListItemEntity> The saved list itemAddHierarchyToPathAsync(Domain, string, string, RequestOptions)
Add a hierarchy item to a pathParameters
domain Domain
Type of items to get
path string
Hierarchy path to parent item
name string
Name of node to add
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HierarchyEntity> The hierarchy node added to the pathChangeCurrencyAsync(double, string, string, RequestOptions)
Recalculates the amount to the new currency.Parameters
amount double
The amount in the old currency
fromCurrency string
The old currency name
toCurrency string
The new currency name
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<double> Amount in new currencyCreateDefaultAmountClassEntityAsync(RequestOptions)
Set default values into a new AmountClassEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AmountClassEntity> A blank AmountClassEntityCreateDefaultCategoryEntityAsync(RequestOptions)
Set default values into a new CategoryEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<CategoryEntity> A blank CategoryEntityCreateDefaultCountryAsync(RequestOptions)
Gets a new countryParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Country> A new country with default valuesCreateDefaultCurrencyEntityAsync(RequestOptions)
Set default values into a new CurrencyEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<CurrencyEntity> A blank CurrencyEntityCreateDefaultDocumentTemplateEntityAsync(RequestOptions)
Set default values into a new DocumentTemplateEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DocumentTemplateEntity> A blank DocumentTemplateEntityCreateDefaultDocumentTemplateLanguageAsync(int, string, RequestOptions)
Create a new document template language based on an existing templateParameters
documentTemplateId int
The id of the document template
languageCode string
The language code (‘en-US, ‘nb-NO’, etc)
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task Returns nothing - throws on errorCreateDefaultExtAppEntityAsync(RequestOptions)
Set default values into a new ExtAppEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ExtAppEntity> A blank ExtAppEntityCreateDefaultHeadingEntityAsync(RequestOptions)
Set default values into a new HeadingEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HeadingEntity> A blank HeadingEntityCreateDefaultHeadingFromListDefinitionAsync(int, RequestOptions)
Get a heading for the specified list defintionParameters
udListDefinitionId int
The id of the list definition, indicating which list to get the item from
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HeadingEntity> The loaded headingCreateDefaultHierarchyEntityAsync(RequestOptions)
Set default values into a new HierarchyEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HierarchyEntity> A blank HierarchyEntityCreateDefaultListEntityAsync(RequestOptions)
Set default values into a new ListEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListEntity> A blank ListEntityCreateDefaultListItemEntityAsync(RequestOptions)
Set default values into a new ListItemEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListItemEntity> A blank ListItemEntityCreateDefaultPictureFolderEntityAsync(RequestOptions)
Set default values into a new PictureFolderEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<PictureFolderEntity> A blank PictureFolderEntityCreateDefaultProjectTypeEntityAsync(RequestOptions)
Set default values into a new ProjectTypeEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectTypeEntity> A blank ProjectTypeEntityCreateDefaultRelationDefinitionEntityAsync(RequestOptions)
Set default values into a new RelationDefinitionEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<RelationDefinitionEntity> A blank RelationDefinitionEntityCreateDefaultResourceEntityAsync(RequestOptions)
Set default values into a new ResourceEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ResourceEntity> A blank ResourceEntityCreateDefaultSaleStageEntityAsync(RequestOptions)
Set default values into a new SaleStageEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleStageEntity> A blank SaleStageEntityCreateDefaultSaleTypeEntityAsync(RequestOptions)
Set default values into a new SaleTypeEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleTypeEntity> A blank SaleTypeEntityCreateDefaultTaskMenuAsync(RequestOptions)
Set default values into a new TaskMenu. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TaskMenu> A blank TaskMenuCreateDefaultTicketCategoryEntityAsync(RequestOptions)
Set default values into a new TicketCategoryEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketCategoryEntity> A blank TicketCategoryEntityCreateDefaultTicketPriorityEntityAsync(RequestOptions)
Set default values into a new TicketPriorityEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketPriorityEntity> A blank TicketPriorityEntityCreateDefaultTicketRelationDefinitionEntityAsync(RequestOptions)
Set default values into a new TicketRelationDefinitionEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketRelationDefinitionEntity> A blank TicketRelationDefinitionEntityCreateDefaultTicketStatusEntityAsync(RequestOptions)
Set default values into a new TicketStatusEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketStatusEntity> A blank TicketStatusEntityCreateDefaultTicketTypeEntityAsync(RequestOptions)
Set default values into a new TicketTypeEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketTypeEntity> A blank TicketTypeEntityCreateDefaultWebPanelEntityAsync(RequestOptions)
Set default values into a new WebPanelEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WebPanelEntity> A blank WebPanelEntityDeleteAllFromListDefinitionAsync(int, RequestOptions)
Marks all items in the list deletedParameters
udListDefinitionId int
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.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueDeleteAllFromListNameAsync(string, RequestOptions)
Marks all items in the list deletedParameters
udListDefinitionName string
The name of the list definition, indicating which list to delete the items from.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueDeleteAllHeadingsFromListDefinitionAsync(int, RequestOptions)
Delete all headings for list resolved by the provided id.Parameters
id int
The id of the list to look up.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueDeleteAllHeadingsFromNameAsync(string, RequestOptions)
Delete all headings for list resolved by the provided name.Parameters
name string
The name of the list to look up.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueDeleteAppTaskMenusAsync(RequestOptions)
Permanentely delete all task menus owned by your app; works in Online only, for registered Apps that send a valid ApplicationToken; otherwise nothing happensParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueDeleteAppWebPanelsAsync(RequestOptions)
Permanentely delete all web panels owned by your app; works in Online only, for registered Apps that send a valid ApplicationToken; otherwise nothing happensParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueDeleteDocumentTemplateLanguageAsync(int, string, RequestOptions)
Deletes language variant of the document templateParameters
documentTemplateId int
The id of the document template
languageCode string
The language code (‘en-US, ‘nb-NO’, etc)
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueDeleteFromListDefinitionAsync(int, int, RequestOptions)
Delete a list item from the specified list defintionParameters
id int
The identity of the list item to delete
udListDefinitionId int
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.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueDeleteFromListNameAsync(int, string, RequestOptions)
Delete a list item from the specified list defintionParameters
id int
The identity of the list item to delete
udListDefinitionName string
The name of the list definition, indicating which list to delete the items from.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueDeleteHierarchyEntityAsync(int, RequestOptions)
Deletes the HierarchyEntityParameters
hierarchyEntityId int
The identity of the HierarchyEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteHierarchyFromPathAsync(Domain, string, RequestOptions)
Remove a hierarchy item and its children from a pathParameters
domain Domain
Type of items to get
path string
Hierarchy path to item to delete
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueDeleteListEntityAsync(int, RequestOptions)
Deletes the ListEntityParameters
listEntityId int
The identity of the ListEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteListEntityByNameAsync(string, RequestOptions)
Delete a ListEntity resolved by the provided name.Parameters
name string
The name of the list to delete.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueDeletePictureFolderEntityAsync(int, RequestOptions)
Deletes the PictureFolderEntityParameters
pictureFolderEntityId int
The identity of the PictureFolderEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteProjectStatusAsync(int, RequestOptions)
Deletes a project statusParameters
projectStatusId int
The project status id to delete
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task No returnDeleteResourceEntityAsync(int, RequestOptions)
Deletes the ResourceEntityParameters
resourceEntityId int
The identity of the ResourceEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteTaskMenuAsync(int, RequestOptions)
Deletes the TaskMenuParameters
taskMenuId int
The identity of the TaskMenu
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteTicketCategoryEntityAsync(int, RequestOptions)
Deletes the TicketCategoryEntityParameters
ticketCategoryEntityId int
The identity of the TicketCategoryEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteTicketPriorityEntityAsync(int, RequestOptions)
Deletes the TicketPriorityEntityParameters
ticketPriorityEntityId int
The identity of the TicketPriorityEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteTicketRelationDefinitionEntityAsync(int, RequestOptions)
Deletes the TicketRelationDefinitionEntityParameters
ticketRelationDefinitionEntityId int
The identity of the TicketRelationDefinitionEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteTicketStatusEntityAsync(int, RequestOptions)
Deletes the TicketStatusEntityParameters
ticketStatusEntityId int
The identity of the TicketStatusEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteTicketTypeEntityAsync(int, RequestOptions)
Deletes the TicketTypeEntityParameters
ticketTypeEntityId int
The identity of the TicketTypeEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteWebPanelAsync(int, RequestOptions)
Hard-delete (real, permanent DELETE in the database) the given web panel. Use with care!Parameters
id int
Database id of web panel to delete
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueGenerateNavigationUrlAsync(Navigation, string, RequestOptions)
This methods generates the navigation URL to be used to navigate to the panelParameters
visibleIn Navigation
The visble in/navigation to generate for
windowName string
The name of the web panel window
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> The navigation urlGetAllAutomatedCategoryUpdatesAsync(RequestOptions)
Save the automated category update settingsParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AutomatedCategoryUpdate[]> Returns all settingsGetAllConsentSourceAsync(RequestOptions)
Gets array of all ConsentSource objects.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConsentSource[]> Array of all ConsentSource objectsGetAllCountriesAsync(bool, RequestOptions)
Returns all available countries a contact or person could belong to.Parameters
includeDeleted bool
Include deleted items in result?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Country[]> An array of all available countriesGetAllCurrenciesAsync(bool, RequestOptions)
Returns all currenciesParameters
includeDeleted bool
Include deleted items in result?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<CurrencyEntity[]> Array of currenciesGetAllDocumentTemplatesAsync(bool, RequestOptions)
Returns all templatesParameters
includeDeleted bool
Include deleted items in result?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DocumentTemplateEntity[]> Array of all template itemsGetAllDomainsAsync(RequestOptions)
Get list of all domainsParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Domain[]> Domain types (scripts, extra tables, etc)GetAllFromListDefinitionAsync(int, bool, RequestOptions)
Get all list items for the specified list defintionParameters
udListDefinitionId int
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.
includeDeleted bool
Include deleted items in result?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListItemEntity[]> The list itemsGetAllFromListNameAsync(string, bool, RequestOptions)
Get all list items for the specified list defintionParameters
udListDefinitionName string
The name of the list definition, indicating which list to get the item from.
includeDeleted bool
Include deleted items in result?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListItemEntity[]> The list itemsGetAllInDomainAsync(Domain, bool, RequestOptions)
Get all items in a domainParameters
domain Domain
Type of items to get (scripts, extra tables, etc)
children bool
Include sub-items?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HierarchyEntity[]> All items and child items within a domainGetAllLegalBaseAsync(RequestOptions)
Gets array of all LegalBase objects.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LegalBase[]> Array of all LegalBase objectsGetAllReasonSoldAsync(RequestOptions)
Gets array of all ReasonSold objects.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ReasonSold[]> Array of all ReasonSold objectsGetAllReasonStalledAsync(RequestOptions)
Gets array of all ReasonStalled objects.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ReasonStalled[]> Array of all ReasonStalled objectsGetAllSaleStagesAsync(bool, RequestOptions)
Returns all ratingsParameters
includeDeleted bool
Include deleted items in result?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleStageEntity[]> Array of sale stage ratingsGetAllSaleTypeAsync(RequestOptions)
Returns all sale types as simple list itemsParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleType[]> Array of simple sale type list itemsGetAllSaleTypeEntitiesAsync(bool, RequestOptions)
Returns all sale types as entities with stakeholders, guide and quote propertiesParameters
includeDeleted bool
Include deleted items in result?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleTypeEntity[]> Array of sale type entities with stakeholders, guide and quote propertiesGetAllSelectionCategoryAsync(RequestOptions)
Gets array of all SelectionCategory objects.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectionCategory[]> Array of all SelectionCategory objectsGetAllTasksAsync(bool, RequestOptions)
Returns all appointment tasksParameters
includeDeleted bool
Include deleted items in result?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TaskListItem[]> An array of all available tasksGetAllTicketPrioritiesAsync(bool, RequestOptions)
Returns all available ticket priorities.Parameters
includeDeleted bool
Include deleted items in result?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketPriorityEntity[]> An array of all available ticket prioritiesGetAllTicketRelationDefinitionEntitiesAsync(RequestOptions)
Returns all non-built-in ticket relation definitions, including their source and destination ticket type associations.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketRelationDefinitionEntity[]> An array of all non-built-in ticket relation definition entitiesGetAmountClassEntityAsync(int, RequestOptions)
Gets a specific AmountClassEntity object.Parameters
amountClassEntityId int
The identifier of the AmountClassEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AmountClassEntity> AmountClassEntityGetAppTaskMenusAsync(RequestOptions)
Get all task menus owned by your app; works in Online only, for registered Apps that send a valid ApplicationTokenParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TaskMenu[]> List of all task menus owned by the current AppGetAppWebPanelsAsync(RequestOptions)
Get all web panels owned by your app; works in Online only, for registered Apps that send a valid ApplicationTokenParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WebPanelEntity[]> List of all web panels owned by the current AppGetBaseCurrencyAsync(RequestOptions)
Get the base currency, used for calculating exchange ratesParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<CurrencyEntity> The base currency that other currencies are expressed in terms ofGetBusinessAsync(int, RequestOptions)
Gets a specific Business object.Parameters
businessId int
The identifier of the Business object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Business> BusinessGetBusinessListAsync(int[], RequestOptions)
Gets an array of specific Business objects.Parameters
businessIds int[]
The identifiers of the Business object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Business[]> Array of Business objectsGetBusinessesAsync(RequestOptions)
Returns all available businesses that a contact could have.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Business[]> An array of all available businessesGetCategoriesAsync(RequestOptions)
Returns all categories a contact could belong toParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Category[]> An array of all available categoriesGetCategoryAsync(int, RequestOptions)
Gets a specific Category object.Parameters
categoryId int
The identifier of the Category object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Category> CategoryGetCategoryEntityAsync(int, RequestOptions)
Gets a specific CategoryEntity object.Parameters
categoryEntityId int
The identifier of the CategoryEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<CategoryEntity> CategoryEntityGetCategoryListAsync(int[], RequestOptions)
Gets an array of specific Category objects.Parameters
categoryIds int[]
The identifiers of the Category object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Category[]> Array of Category objectsGetCompetitorAsync(int, RequestOptions)
Gets a specific Competitor object.Parameters
competitorId int
The identifier of the Competitor object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Competitor> CompetitorGetCompetitorListAsync(int[], RequestOptions)
Gets an array of specific Competitor objects.Parameters
competitorIds int[]
The identifiers of the Competitor object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Competitor[]> Array of Competitor objectsGetCompetitorsAsync(RequestOptions)
Returns all competitorsParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Competitor[]>GetConsentPurposeAsync(int, RequestOptions)
Gets a specific ConsentPurpose object.Parameters
consentPurposeId int
The identifier of the ConsentPurpose object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConsentPurpose> ConsentPurposeGetConsentPurposeListAsync(int[], RequestOptions)
Gets an array of specific ConsentPurpose objects.Parameters
consentPurposeIds int[]
The identifiers of the ConsentPurpose object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConsentPurpose[]> Array of ConsentPurpose objectsGetConsentPurposesAsync(RequestOptions)
Returns all defined purposes.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConsentPurpose[]> An array of all defined purposesGetConsentSourceAsync(int, RequestOptions)
Gets a specific ConsentSource object.Parameters
consentSourceId int
The identifier of the ConsentSource object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConsentSource> ConsentSourceGetConsentSourceListAsync(int[], RequestOptions)
Gets an array of specific ConsentSource objects.Parameters
consentSourceIds int[]
The identifiers of the ConsentSource object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConsentSource[]> Array of ConsentSource objectsGetConsentSourcesAsync(RequestOptions)
Returns all defined Sources.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConsentSource[]> An array of all defined SourcesGetCountriesAsync(RequestOptions)
Returns all available countries a contact or person could belong to.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Country[]> An array of all available countriesGetCountryAsync(int, RequestOptions)
Gets a specific Country object.Parameters
countryId int
The identifier of the Country object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Country> CountryGetCountryListAsync(int[], RequestOptions)
Gets an array of specific Country objects.Parameters
countryIds int[]
The identifiers of the Country object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Country[]> Array of Country objectsGetCreditedAsync(int, RequestOptions)
Gets a specific Credited object.Parameters
creditedId int
The identifier of the Credited object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Credited> CreditedGetCreditedListAsync(int[], RequestOptions)
Gets an array of specific Credited objects.Parameters
creditedIds int[]
The identifiers of the Credited object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Credited[]> Array of Credited objectsGetCreditedsAsync(RequestOptions)
Returns all creditedParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Credited[]>GetCurrenciesAsync(RequestOptions)
Returns all currenciesParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Currency[]> Array of currenciesGetCurrencyAsync(int, RequestOptions)
Gets a specific Currency object.Parameters
currencyId int
The identifier of the Currency object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Currency> CurrencyGetCurrencyEntityAsync(int, RequestOptions)
Gets a specific CurrencyEntity object.Parameters
currencyEntityId int
The identifier of the CurrencyEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<CurrencyEntity> CurrencyEntityGetCurrencyListAsync(int[], RequestOptions)
Gets an array of specific Currency objects.Parameters
currencyIds int[]
The identifiers of the Currency object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Currency[]> Array of Currency objectsGetCustomerLanguageAsync(int, RequestOptions)
Gets a specific CustomerLanguage object.Parameters
customerLanguageId int
The identifier of the CustomerLanguage object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<CustomerLanguage> CustomerLanguageGetCustomerLanguageListAsync(int[], RequestOptions)
Gets an array of specific CustomerLanguage objects.Parameters
customerLanguageIds int[]
The identifiers of the CustomerLanguage object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<CustomerLanguage[]> Array of CustomerLanguage objectsGetCustomerLanguagesAsync(RequestOptions)
Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<CustomerLanguage[]>GetDeliveryTermAsync(int, RequestOptions)
Gets a specific DeliveryTerm object.Parameters
deliveryTermId int
The identifier of the DeliveryTerm object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DeliveryTerm> DeliveryTermGetDeliveryTermsAsync(RequestOptions)
Returns all DeliveryTerms in SuperOffice db.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DeliveryTerm[]> An array of all available DeliveryTermsGetDeliveryTypeAsync(int, RequestOptions)
Gets a specific DeliveryType object.Parameters
deliveryTypeId int
The identifier of the DeliveryType object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DeliveryType> DeliveryTypeGetDeliveryTypesAsync(RequestOptions)
Returns all DeliveryTypes in SuperOffice db.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DeliveryType[]> An array of all available DeliveryTypeGetDepartmentAsync(int, RequestOptions)
Gets a specific Department object.Parameters
departmentId int
The identifier of the Department object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Department> DepartmentGetDepartmentListAsync(int[], RequestOptions)
Gets an array of specific Department objects.Parameters
departmentIds int[]
The identifiers of the Department object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Department[]> Array of Department objectsGetDepartmentsAsync(RequestOptions)
Getting all departments/user groups for the internal phone list with the user’s colleagues.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Department[]> Returns all departments.GetDocumentTemplateAsync(int, RequestOptions)
Gets a specific DocumentTemplate object.Parameters
documentTemplateId int
The identifier of the DocumentTemplate object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DocumentTemplate> DocumentTemplateGetDocumentTemplateEntityAsync(int, RequestOptions)
Gets a specific DocumentTemplateEntity object.Parameters
documentTemplateEntityId int
The identifier of the DocumentTemplateEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DocumentTemplateEntity> DocumentTemplateEntityGetDocumentTemplateExtensionAsync(int, RequestOptions)
Get the file extension for the document templateParameters
documentTemplateId int
The primary key of the document template
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> File name extension including ’.’: ‘.doc’ or ‘.xlsx’GetDocumentTemplateLanguagesAsync(int, RequestOptions)
Get the supported language variations for a document templateParameters
documentTemplateId int
The id of the document template
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string[]> Returns the list of languages as ISO cultures (en-US, no, sv, etc)GetDocumentTemplateListAsync(int[], RequestOptions)
Gets an array of specific DocumentTemplate objects.Parameters
documentTemplateIds int[]
The identifiers of the DocumentTemplate object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DocumentTemplate[]> Array of DocumentTemplate objectsGetDocumentTemplatePropertiesAsync(int, string[], RequestOptions)
Get document template propertiesParameters
documentTemplateId int
The primary key id of the document template
requestedProperties string[]
An array of properties to get the values for
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<StringDictionary> Dictionary of key=value pairs of requested propertiesGetDocumentTemplateStreamFromIdAsync(int, string, string, RequestOptions)
Retrieve a stream to a document template based on its idParameters
documentTemplateId int
Id of template to retrieve
languageCode string
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”.
returnContentType string
Accept content-type. Default “application/octet-stream”. Could also be “application/pdf”, “text/plain”, “text/html”, or “multipart/related”
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<byte[]> Open stream to the template contentGetDocumentTemplateTaskAsync(int, RequestOptions)
Returns a Document Template list item as a TaskListItem. The appointment’s task is a Document template item when the appointment is a document.Parameters
documentTemplateId int
Id of the document template, i.e. the Appointment.TaskIdx
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SoTask> Document Template item as TaskListItem.GetDocumentTemplateUrlAsync(int, bool, string, RequestOptions)
Get a url to the document templateParameters
documentTemplateId int
The id of the template
writableUrl bool
Get a writeable url to the document template?
languageCode string
The language code (‘en-US’, ‘nb-NO’, etc). Use empty string if not supported or used.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string> The URL to the document templateGetDocumentTemplateUsedInProjectStageAsync(int, RequestOptions)
Get a String array of names in project guide that this template is used inParameters
documentTemplateId int
The id of the template
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string[]> The name of the projectguides that use this templateGetDocumentTemplateUsedInSalesStageAsync(int, RequestOptions)
Get a String array of names in sales guide that this template is used inParameters
documentTemplateId int
The id of the template
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<string[]> The name of the salesguides that use this templateGetDocumentTemplatesAsync(RequestOptions)
Returns all available document templatesParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DocumentTemplate[]> Array of DocumentTemplatesGetDocumentTemplatesTasksAsync(RequestOptions)
The appointment’s task is a Document template item when the appointment is a document.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SoTask[]> Document Template list as a array of TasksGetDocumentTypesForPluginAsync(int, RequestOptions)
Get a list of document types supported by a given document plugin. Use the document template type when creating a new template.Parameters
pluginId int
Numeric document plugin id, corresponding to the doctmpl.AutoeventId, doctmpl.LoadTemplateFromPlugin.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<IntStringDictionary> Dictionary mapping document type id=nameGetEmarketingStrictModeAsync(RequestOptions)
Get the value of the Emarketing strict mode settingParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool> Returns true if Emarkerint strict mode is set, false otherwiseGetExtAppEntityAsync(int, RequestOptions)
Gets a specific ExtAppEntity object.Parameters
extAppEntityId int
The identifier of the ExtAppEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ExtAppEntity> ExtAppEntityGetFromListDefinitionAsync(int, int, RequestOptions)
Get a list item for the specified list defintionParameters
id int
The identity of the list item to load
udListDefinitionId int
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.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListItemEntity> The loaded list itemGetFromListNameAsync(int, string, RequestOptions)
Get a list item for the specified list defintionParameters
id int
The identity of the list item to load
udListDefinitionName string
The name of the list definition, indicating which list to get the item from.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListItemEntity> The loaded list itemGetHeadingEntityAsync(int, RequestOptions)
Gets a specific HeadingEntity object.Parameters
headingEntityId int
The identifier of the HeadingEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HeadingEntity> HeadingEntityGetHeadingsAsync(int, int, bool, RequestOptions)
Gets a selectable MDO list of the headings for this list itemParameters
udListDefinitionId int
The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
listItemId int
The id of the list item
showDeleted bool
Set to true if you want deleted headings
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectableMDOListItem[]> Array of headingsGetHeadingsForListItemFromListNameAsync(string, int, bool, RequestOptions)
Gets a selectable MDO list of the headings for this list itemParameters
udListDefinitionName string
The name of the list definition, indicating which list to delete the items from.
listItemId int
The id of the list item
showDeleted bool
Set to true if you want deleted headings
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectableMDOListItem[]> Array of headingsGetHeadingsFromListDefinitionAsync(int, RequestOptions)
Gets headings for list resolved by the provided id.Parameters
id int
The id of the list to look up.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HeadingEntity[]> List of headingsGetHeadingsFromNameAsync(string, RequestOptions)
Gets headings for list resolved by the provided name.Parameters
name string
The name of the list to look up.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HeadingEntity[]> List of headingsGetHierarchyEntityAsync(int, RequestOptions)
Gets a specific HierarchyEntity object.Parameters
hierarchyEntityId int
The identifier of the HierarchyEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HierarchyEntity> HierarchyEntityGetHierarchyFromPathAsync(Domain, string, bool, RequestOptions)
Get a hierarchy item from a pathParameters
domain Domain
Type of items to get
path string
Hierarchy path to item
children bool
Include sub-items?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HierarchyEntity> The hierarchy node at the pathGetInstalledLanguagesAsync(RequestOptions)
Returns the list of all languages installed in this database.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LanguageInfo[]> Array of installed languagesGetLanguageInfoAsync(int, RequestOptions)
Gets a specific LanguageInfo object.Parameters
languageInfoId int
The identifier of the LanguageInfo object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LanguageInfo> LanguageInfoGetLanguageInfoListAsync(int[], RequestOptions)
Gets an array of specific LanguageInfo objects.Parameters
languageInfoIds int[]
The identifiers of the LanguageInfo object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LanguageInfo[]> Array of LanguageInfo objectsGetLegalBaseAsync(int, RequestOptions)
Gets a specific LegalBase object.Parameters
legalBaseId int
The identifier of the LegalBase object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LegalBase> LegalBaseGetLegalBaseListAsync(int[], RequestOptions)
Gets an array of specific LegalBase objects.Parameters
legalBaseIds int[]
The identifiers of the LegalBase object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LegalBase[]> Array of LegalBase objectsGetLegalBasesAsync(RequestOptions)
Returns all defined bases.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LegalBase[]> An array of all defined basesGetLinkAsync(int, RequestOptions)
Gets a specific Link object.Parameters
linkId int
The identifier of the Link object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Link> LinkGetLinkListAsync(int[], RequestOptions)
Gets an array of specific Link objects.Parameters
linkIds int[]
The identifiers of the Link object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Link[]> Array of Link objectsGetListDefinitionsAsync(bool, RequestOptions)
Get a list of the lists - built-in and user-defined.Parameters
includeDeleted bool
Include deleted items in result?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListEntity[]> The list definitionsGetListEntityAsync(int, RequestOptions)
Gets a specific ListEntity object.Parameters
listEntityId int
The identifier of the ListEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListEntity> ListEntityGetListEntityByNameAsync(string, RequestOptions)
Gets a ListEntity resolved by the provided name.Parameters
name string
The name of the list to look up.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListEntity> A ListEntity or null.GetListItemsForHeadingAsync(int, int, RequestOptions)
List of list items that is selected if under this headingParameters
udListDefinitionId int
The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
headingId int
The id of the heading
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectableMDOListItem[]> Array of selectable list itemsGetListItemsForHeadingFromListNameAsync(string, int, RequestOptions)
List of list items that is selected if under this headingParameters
udListDefinitionName string
The name of the list definition.
headingId int
The id of the heading
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectableMDOListItem[]> Array of selectable list itemsGetListItemsForUserGroupAsync(int, int, RequestOptions)
List of list items that is visible in the usergroupParameters
udListDefinitionId int
The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
groupId int
The id of the usergroup
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectableMDOListItem[]> Array of selectable list itemsGetListItemsForUserGroupFromListNameAsync(string, int, RequestOptions)
List of list items that is visible in the usergroupParameters
udListDefinitionName string
The name of the list definition.
groupId int
The id of the usergroup
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectableMDOListItem[]> Array of selectable list itemsGetLocalizedTextAsync(int, RequestOptions)
Gets a specific LocalizedText object.Parameters
localizedTextId int
The identifier of the LocalizedText object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LocalizedText> LocalizedTextGetLocalizedTextByTypeAsync(LocalizedTextType, int, int, RequestOptions)
Returns a localized text based on the resource id for the selected language.Parameters
textType LocalizedTextType
Type of the localized text
resourceId int
The resource id. This id has different meaning based on the LocalizedTextType.
languageId int
The LCID number of the language.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LocalizedText> A LocalizedText carrier.GetLocalizedTextListAsync(int[], RequestOptions)
Gets an array of specific LocalizedText objects.Parameters
localizedTextIds int[]
The identifiers of the LocalizedText object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LocalizedText[]> Array of LocalizedText objectsGetLocalizedTextsAsync(RequestOptions)
Gets all localized texts in the CRM database.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LocalizedText[]> Array of LocalizedText objectsGetLocalizedTextsByLanguageIdAsync(int, RequestOptions)
Gets all localized text belonging to a specific language.Parameters
languageId int
The LCID number of the language.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LocalizedText[]> Array of LocalizedText objectsGetLocalizedTextsByTypeAsync(LocalizedTextType[], RequestOptions)
Gets localized text by their typeParameters
textTypes LocalizedTextType[]
Array of LocalizedTextTypes. If null all texts are returned.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LocalizedText[]> Array of LocalizedText objectsGetMrMrsAsync(int, RequestOptions)
Gets a specific MrMrs object.Parameters
mrMrsId int
The identifier of the MrMrs object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<MrMrs> MrMrsGetMrMrsListAsync(int[], RequestOptions)
Gets an array of specific MrMrs objects.Parameters
mrMrsIds int[]
The identifiers of the MrMrs object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<MrMrs[]> Array of MrMrs objectsGetMrMrsesAsync(RequestOptions)
Returns all Items from the MrMrs table sorted by their value.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<MrMrs[]> All items from the MrMrs table sorted by their valueGetNeedCategoryUpdateForPersonAsync(int, int, int, int, RequestOptions)
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 personParameters
leadStatus int
The new leadstatus that might trigger the category update
personId int
The person id that might trigger the category update
contactId int
The contact id that might get the resulting update
categoryId int
The person id that might get the resulting update
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AutomatedCategoryUpdate> Returns the info on the trigger that will update with userconfirmation. Returns void if no update or no need for confirmationGetNeedCategoryUpdateForSaleAsync(SaleStatus, int, int, int, RequestOptions)
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 personParameters
saleStatus SaleStatus
The new salestatus that might trigger the category update
saleId int
The sale id that might trigger the category update
contactId int
The contact id that might get the resulting update
personId int
The person id that might get the resulting update
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AutomatedCategoryUpdate> Returns the info on the trigger that will update with userconfirmation. Returns void if no update or no need for confirmationGetOurCurrencyAsync(RequestOptions)
Gets the Our currency object if currency is enabledParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Currency> Our currencyGetOwnerCompanysCurrencyAsync(RequestOptions)
Get the currency of the user’s owner companyParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Currency> Currency of the user’s owner companyGetPaymentTermAsync(int, RequestOptions)
Gets a specific PaymentTerm object.Parameters
paymentTermId int
The identifier of the PaymentTerm object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<PaymentTerm> PaymentTermGetPaymentTermsAsync(RequestOptions)
Returns all PaymentTerms in SuperOffice db.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<PaymentTerm[]> An array of all available PaymentTermsGetPaymentTypeAsync(int, RequestOptions)
Gets a specific PaymentType object.Parameters
paymentTypeId int
The identifier of the PaymentType object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<PaymentType> PaymentTypeGetPaymentTypesAsync(RequestOptions)
Returns all PaymentTypes in SuperOffice db.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<PaymentType[]> An array of all available PaymentTypesGetPictureFolderEntityAsync(int, RequestOptions)
Gets a specific PictureFolderEntity object.Parameters
pictureFolderEntityId int
The identifier of the PictureFolderEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<PictureFolderEntity> PictureFolderEntityGetPluginCapabilitiesAsync(int, RequestOptions)
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.Parameters
pluginId int
Numeric document plugin id, corresponding to the document.archiveProvider id or doctmpl.AutoeventId.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<StringDictionary> Dictionary mapping capability names=valuesGetPluginListAsync(RequestOptions)
Get a list of installed document pluginsParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<StringDictionary> Dictionary mapping plugin id=plugin nameGetPositionAsync(int, RequestOptions)
Gets a specific Position object.Parameters
positionId int
The identifier of the Position object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Position> PositionGetPositionListAsync(int[], RequestOptions)
Gets an array of specific Position objects.Parameters
positionIds int[]
The identifiers of the Position object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Position[]> Array of Position objectsGetPositionsAsync(RequestOptions)
Returns all the positions a person could have.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Position[]> An array of all available positionsGetPrioritiesAsync(RequestOptions)
Returns all priorities an appointment could have.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Priority[]> An array of all available prioritiesGetPriorityAsync(int, RequestOptions)
Gets a specific Priority object.Parameters
priorityId int
The identifier of the Priority object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Priority> PriorityGetPriorityListAsync(int[], RequestOptions)
Gets an array of specific Priority objects.Parameters
priorityIds int[]
The identifiers of the Priority object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Priority[]> Array of Priority objectsGetProductCategoriesAsync(RequestOptions)
Returns all ProductCategories in SuperOffice list.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProductCategory[]> An array of all available ProductCategoryGetProductCategoryAsync(int, RequestOptions)
Gets a specific ProductCategory object.Parameters
productCategoryId int
The identifier of the ProductCategory object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProductCategory> ProductCategoryGetProductFamiliesAsync(RequestOptions)
Returns all ProductFamily in SuperOffice list.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProductFamily[]> An array of all available ProductFamiliesGetProductFamilyAsync(int, RequestOptions)
Gets a specific ProductFamily object.Parameters
productFamilyId int
The identifier of the ProductFamily object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProductFamily> ProductFamilyGetProductTypeAsync(int, RequestOptions)
Gets a specific ProductType object.Parameters
productTypeId int
The identifier of the ProductType object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProductType> ProductTypeGetProductTypesAsync(RequestOptions)
Returns all ProductTypes in SuperOffice list.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProductType[]> An array of all available ProductTypesGetProjectStatusAsync(int, RequestOptions)
Gets a specific ProjectStatus object.Parameters
projectStatusId int
The identifier of the ProjectStatus object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectStatus> ProjectStatusGetProjectStatusListAsync(int[], RequestOptions)
Gets an array of specific ProjectStatus objects.Parameters
projectStatusIds int[]
The identifiers of the ProjectStatus object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectStatus[]> Array of ProjectStatus objectsGetProjectStatusesAsync(RequestOptions)
Gets all items from the Project Status (ProjStatus) table.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectStatus[]> List of all Project statuses.GetProjectTypeAsync(int, RequestOptions)
Gets a specific ProjectType object.Parameters
projectTypeId int
The identifier of the ProjectType object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectType> ProjectTypeGetProjectTypeEntityAsync(int, RequestOptions)
Gets a specific ProjectTypeEntity object.Parameters
projectTypeEntityId int
The identifier of the ProjectTypeEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectTypeEntity> ProjectTypeEntityGetProjectTypeListAsync(int[], RequestOptions)
Gets an array of specific ProjectType objects.Parameters
projectTypeIds int[]
The identifiers of the ProjectType object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectType[]> Array of ProjectType objectsGetProjectTypesAsync(RequestOptions)
Gets all items from the Project Type (ProjType) table.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectType[]> List of all project types.GetQuickRepliesAsync(RequestOptions)
Method to return all quick replies for a given associateParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<QuickReply[]> Array of quick repliesGetQuoteApproveReasonAsync(int, RequestOptions)
Gets a specific QuoteApproveReason object.Parameters
quoteApproveReasonId int
The identifier of the QuoteApproveReason object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<QuoteApproveReason> QuoteApproveReasonGetQuoteApproveReasonListAsync(int[], RequestOptions)
Gets an array of specific QuoteApproveReason objects.Parameters
quoteApproveReasonIds int[]
The identifiers of the QuoteApproveReason object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<QuoteApproveReason[]> Array of QuoteApproveReason objectsGetQuoteApproveReasonsAsync(RequestOptions)
Returns all available QuoteApproveReasons.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<QuoteApproveReason[]> An array of all non-deleted QuoteApproveReasonGetQuoteDenyReasonAsync(int, RequestOptions)
Gets a specific QuoteDenyReason object.Parameters
quoteDenyReasonId int
The identifier of the QuoteDenyReason object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<QuoteDenyReason> QuoteDenyReasonGetQuoteDenyReasonListAsync(int[], RequestOptions)
Gets an array of specific QuoteDenyReason objects.Parameters
quoteDenyReasonIds int[]
The identifiers of the QuoteDenyReason object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<QuoteDenyReason[]> Array of QuoteDenyReason objectsGetQuoteDenyReasonsAsync(RequestOptions)
Returns all available QuoteDenyReasons.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<QuoteDenyReason[]> An array of all non-deleted QuoteDenyReasonGetRatingAsync(int, RequestOptions)
Gets a specific Rating object.Parameters
ratingId int
The identifier of the Rating object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Rating> RatingGetRatingListAsync(int[], RequestOptions)
Gets an array of specific Rating objects.Parameters
ratingIds int[]
The identifiers of the Rating object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Rating[]> Array of Rating objectsGetRatingsAsync(RequestOptions)
Returns all ratingsParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Rating[]> Array of ratingsGetReasonAsync(int, RequestOptions)
Gets a specific Reason object.Parameters
reasonId int
The identifier of the Reason object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Reason> ReasonGetReasonListAsync(int[], RequestOptions)
Gets an array of specific Reason objects.Parameters
reasonIds int[]
The identifiers of the Reason object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Reason[]> Array of Reason objectsGetReasonSoldAsync(int, RequestOptions)
Gets a specific ReasonSold object.Parameters
reasonSoldId int
The identifier of the ReasonSold object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ReasonSold> ReasonSoldGetReasonSoldListAsync(int[], RequestOptions)
Gets an array of specific ReasonSold objects.Parameters
reasonSoldIds int[]
The identifiers of the ReasonSold object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ReasonSold[]> Array of ReasonSold objectsGetReasonStalledAsync(int, RequestOptions)
Gets a specific ReasonStalled object.Parameters
reasonStalledId int
The identifier of the ReasonStalled object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ReasonStalled> ReasonStalledGetReasonStalledListAsync(int[], RequestOptions)
Gets an array of specific ReasonStalled objects.Parameters
reasonStalledIds int[]
The identifiers of the ReasonStalled object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ReasonStalled[]> Array of ReasonStalled objectsGetReasonsAsync(RequestOptions)
Returns all reasonsParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Reason[]> Array of reasonsGetRelationDefinitionEntityAsync(int, RequestOptions)
Gets a specific RelationDefinitionEntity object.Parameters
relationDefinitionEntityId int
The identifier of the RelationDefinitionEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<RelationDefinitionEntity> RelationDefinitionEntityGetResourceEntityAsync(int, RequestOptions)
Gets a specific ResourceEntity object.Parameters
resourceEntityId int
The identifier of the ResourceEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ResourceEntity> ResourceEntityGetSaleStageEntityAsync(int, RequestOptions)
Gets a specific SaleStageEntity object.Parameters
saleStageEntityId int
The identifier of the SaleStageEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleStageEntity> SaleStageEntityGetSaleTypeAsync(int, RequestOptions)
Gets a specific SaleType object.Parameters
saleTypeId int
The identifier of the SaleType object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleType> SaleTypeGetSaleTypeEntityAsync(int, RequestOptions)
Gets a specific SaleTypeEntity object.Parameters
saleTypeEntityId int
The identifier of the SaleTypeEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleTypeEntity> SaleTypeEntityGetSaleTypeListAsync(int[], RequestOptions)
Gets an array of specific SaleType objects.Parameters
saleTypeIds int[]
The identifiers of the SaleType object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleType[]> Array of SaleType objectsGetSelectionCategoryAsync(int, RequestOptions)
Gets a specific SelectionCategory object.Parameters
selectionCategoryId int
The identifier of the SelectionCategory object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectionCategory> SelectionCategoryGetSelectionCategoryListAsync(int[], RequestOptions)
Gets an array of specific SelectionCategory objects.Parameters
selectionCategoryIds int[]
The identifiers of the SelectionCategory object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectionCategory[]> Array of SelectionCategory objectsGetSoTaskAsync(int, RequestOptions)
Gets a specific SoTask object.Parameters
soTaskId int
The identifier of the SoTask object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SoTask> SoTaskGetSourceAsync(int, RequestOptions)
Gets a specific Source object.Parameters
sourceId int
The identifier of the Source object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Source> SourceGetSourceListAsync(int[], RequestOptions)
Gets an array of specific Source objects.Parameters
sourceIds int[]
The identifiers of the Source object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Source[]> Array of Source objectsGetSourcesAsync(RequestOptions)
Returns all sourcesParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Source[]> Array of sourcesGetTaskListAsync(int[], RequestOptions)
Gets an array of specific SoTask objects.Parameters
soTaskIds int[]
The identifiers of the SoTask object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SoTask[]> Array of SoTask objectsGetTaskMenuAsync(int, RequestOptions)
Gets a specific TaskMenu object.Parameters
taskMenuId int
The identifier of the TaskMenu object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TaskMenu> TaskMenuGetTaskMenuByProgIdAsync(string, RequestOptions)
Get a task menu using the ProgId key that was specified when it was createdParameters
progId string
String key that can be used to uniquely retrieve the taskmenu, set in the TaskMenu when saving
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TaskMenu> The task menuGetTasksAsync(RequestOptions)
Returns all appointment tasksParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SoTask[]> An array of all available tasksGetTicketCategoriesAsync(RequestOptions)
Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketCategoryEntity[]>GetTicketCategoriesForUserGroupsAsync(int[], RequestOptions)
Ticket categories for user groupsParameters
userGroupIds int[]
The ids of the user groups we want tickets categories from
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<MDOListItem[]>GetTicketCategoryAsync(int, RequestOptions)
Gets a specific TicketCategory object.Parameters
ticketCategoryId int
The identifier of the TicketCategory object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketCategory> TicketCategoryGetTicketCategoryEntityAsync(int, RequestOptions)
Gets a specific TicketCategoryEntity object.Parameters
ticketCategoryEntityId int
The identifier of the TicketCategoryEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketCategoryEntity> TicketCategoryEntityGetTicketCategoryListAsync(int[], RequestOptions)
Gets an array of specific TicketCategoryEntity objects.Parameters
ticketCategoryEntityIds int[]
The identifiers of the TicketCategoryEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketCategoryEntity[]> Array of TicketCategoryEntity objectsGetTicketPrioritiesAsync(RequestOptions)
Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketPriority[]>GetTicketPriorityAsync(int, RequestOptions)
Gets a specific TicketPriority object.Parameters
ticketPriorityId int
The identifier of the TicketPriority object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketPriority> TicketPriorityGetTicketPriorityEntityAsync(int, RequestOptions)
Gets a specific TicketPriorityEntity object.Parameters
ticketPriorityEntityId int
The identifier of the TicketPriorityEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketPriorityEntity> TicketPriorityEntityGetTicketPriorityListAsync(int[], RequestOptions)
Gets an array of specific TicketPriority objects.Parameters
ticketPriorityIds int[]
The identifiers of the TicketPriority object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketPriority[]> Array of TicketPriority objectsGetTicketRelationDefinitionEntityAsync(int, RequestOptions)
Gets a specific TicketRelationDefinitionEntity object.Parameters
ticketRelationDefinitionEntityId int
The identifier of the TicketRelationDefinitionEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketRelationDefinitionEntity> TicketRelationDefinitionEntityGetTicketStatusEntityAsync(int, RequestOptions)
Gets a specific TicketStatusEntity object.Parameters
ticketStatusEntityId int
The identifier of the TicketStatusEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketStatusEntity> TicketStatusEntityGetTicketStatusListAsync(int[], RequestOptions)
Gets an array of specific TicketStatusEntity objects.Parameters
ticketStatusEntityIds int[]
The identifiers of the TicketStatusEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketStatusEntity[]> Array of TicketStatusEntity objectsGetTicketStatusesAsync(RequestOptions)
Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketStatusEntity[]>GetTicketTypeEntityAsync(int, RequestOptions)
Gets a specific TicketTypeEntity object.Parameters
ticketTypeEntityId int
The identifier of the TicketTypeEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketTypeEntity> TicketTypeEntityGetTicketTypeListAsync(int[], RequestOptions)
Gets an array of specific TicketTypeEntity objects.Parameters
ticketTypeEntityIds int[]
The identifiers of the TicketTypeEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketTypeEntity[]> Array of TicketTypeEntity objectsGetTicketTypesAsync(RequestOptions)
Get all TicketTypesParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketTypeEntity[]>GetVisibleForUserGroupsAsync(int, int, RequestOptions)
List of User groups that this list item is visible forParameters
udListDefinitionId int
The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
listItemId int
The id of the list item
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectableMDOListItem[]> Array of selectable user groupsGetVisibleForUserGroupsFromListNameAsync(string, int, RequestOptions)
List of User groups that this list item is visible forParameters
udListDefinitionName string
The name of the list definition.
listItemId int
The id of the list item
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectableMDOListItem[]> Array of selectable user groupsGetWebPanelByProgIdAsync(string, RequestOptions)
Get a web panel using the ProgId key that was specified when it was createdParameters
progId string
String key that can be used to uniquely retrieve the panel, set in the WebPanelEntity when saving
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WebPanelEntity> The Web panel informationGetWebPanelEntityAsync(int, RequestOptions)
Gets a specific WebPanelEntity object.Parameters
webPanelEntityId int
The identifier of the WebPanelEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WebPanelEntity> WebPanelEntityGetWebPanelListAsync(RequestOptions)
Return a list of all web panels.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WebPanelEntity[]> List of all web panelsGlobalChangeTicketStatusAsync(int, int, RequestOptions)
This method will change all references from one ticket status to another. Typically used in conjuction with deleteParameters
fromTicketStatusId int
The id of the ticket status to change from
toTicketStatusId int
The id of the ticket status to change to
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task Does not return anythingGlobalChangeTicketTypeAsync(int, int, RequestOptions)
Change all references from one ticket type to another. Typically used in conjuction with ticket type deleteParameters
fromTicketTypeId int
The id of the ticket type to change from
toTicketTypeId int
The id of the ticket type to change to
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueMoveAllTicketsAsync(int, int, RequestOptions)
Move all tickets from one ticket category to anotherParameters
fromTicketCategoryId int
The id of the category we want to move tickets from
toTicketCategoryId int
The id of the category we want to move the tickets to
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueMoveListItemAsync(int, int, int, RequestOptions)
Move a list item up or down in the list based on rankParameters
udListDefinitionId int
Id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
listItemId int
Id of the list item
direction int
-1 moves the item up one position, 1 moves the item down one position
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskPerformNeededCategoryUpdateAsync(int, int, int, AutomatedCategoryUpdate, RequestOptions)
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 updateParameters
personId int
The person id that will get the resulting update
contactId int
The contact id that will get the resulting update
categoryId int
The category id person and contact will be updated to
setting AutomatedCategoryUpdate
The setting that triggered the update
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueRebuildFullnamesAsync(RequestOptions)
Update the fullname field of all categories. Use this e.g. when changing parentId or renaming a category with children.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueSaveAllAutomatedCategoryUpdatesAsync(AutomatedCategoryUpdate[], RequestOptions)
Save the automated category update settingsParameters
settings AutomatedCategoryUpdate[]
All settings for autoupdate category
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AutomatedCategoryUpdate[]> Returns the saved settingsSaveAllFromListDefinitionAsync(int, ListItemEntity[], RequestOptions)
Save all list items for the specified list defintionParameters
udListDefinitionId int
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.
items ListItemEntity[]
The list items
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListItemEntity[]> The list itemsSaveAllFromListNameAsync(string, ListItemEntity[], RequestOptions)
Save all list items for the specified list defintionParameters
udListDefinitionName string
The name of the list definition, indicating which list to save the items to.
items ListItemEntity[]
The list items
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListItemEntity[]> The list itemsSaveAmountClassEntityAsync(AmountClassEntity, RequestOptions)
Updates the existing AmountClassEntity or creates a new AmountClassEntity if the id parameter is 0.Parameters
amountClassEntity AmountClassEntity
The AmountClassEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<AmountClassEntity> New or updated AmountClassEntitySaveCategoryEntityAsync(CategoryEntity, RequestOptions)
Updates the existing CategoryEntity or creates a new CategoryEntity if the id parameter is 0.Parameters
categoryEntity CategoryEntity
The CategoryEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<CategoryEntity> New or updated CategoryEntitySaveConsentPurposeAsync(ConsentPurpose, RequestOptions)
Save a ConsentPurpose objectParameters
consentPurpose ConsentPurpose
The ConsentPurpose object to save
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConsentPurpose> The saved ConsentPurpose object, updated with the ConsentPurposeId if it is a new database entrySaveConsentSourceAsync(ConsentSource, RequestOptions)
Parameters
consentSource ConsentSource
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ConsentSource>SaveCountryAsync(Country, RequestOptions)
Saves a countryParameters
country Country
The country to save
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Country> The country that is savedSaveCurrencyEntityAsync(CurrencyEntity, RequestOptions)
Updates the existing CurrencyEntity or creates a new CurrencyEntity if the id parameter is 0.Parameters
currencyEntity CurrencyEntity
The CurrencyEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<CurrencyEntity> New or updated CurrencyEntitySaveDocumentTemplateEntityAsync(DocumentTemplateEntity, RequestOptions)
Updates the existing DocumentTemplateEntity or creates a new DocumentTemplateEntity if the id parameter is 0.Parameters
documentTemplateEntity DocumentTemplateEntity
The DocumentTemplateEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DocumentTemplateEntity> New or updated DocumentTemplateEntitySaveDocumentTemplateStreamAsync(int, byte[], string, int, RequestOptions)
Writes content in stream to document template fileParameters
documentTemplateId int
Identifier for document template
content byte[]
Stream containing content to be saved to document template file
languageCode string
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”.
pluginId int
Plugin to use for storing document content. 0 = SOARC. Use -1 to use the plugin specified in the template.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TemplateInfo> Template infoSaveExtAppEntityAsync(ExtAppEntity, RequestOptions)
Updates the existing ExtAppEntity or creates a new ExtAppEntity if the id parameter is 0.Parameters
extAppEntity ExtAppEntity
The ExtAppEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ExtAppEntity> New or updated ExtAppEntitySaveFromListDefinitionAsync(int, int, ListItemEntity, RequestOptions)
Save a list item for the specified list defintionParameters
id int
The identity of the list item to load
udListDefinitionId int
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.
item ListItemEntity
The item to save
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListItemEntity> The saved list itemSaveFromListNameAsync(int, string, ListItemEntity, RequestOptions)
Save a list item for the specified list defintionParameters
id int
The identity of the list item to load
udListDefinitionName string
The name of the list definition, indicating which list to save the item to.
item ListItemEntity
The item to save
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListItemEntity> The saved list itemSaveHeadingEntityAsync(HeadingEntity, RequestOptions)
Updates the existing HeadingEntity or creates a new HeadingEntity if the id parameter is 0.Parameters
headingEntity HeadingEntity
The HeadingEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HeadingEntity> New or updated HeadingEntitySaveHeadingFromListDefinitionAsync(int, HeadingEntity, RequestOptions)
Save new heading for list resolved by the provided id.Parameters
id int
The id of the list to look up.
entity HeadingEntity
The new heading to save
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HeadingEntity> The saved entity.SaveHeadingFromNameAsync(string, HeadingEntity, RequestOptions)
Save new heading for list resolved by the provided name.Parameters
name string
The name of the list to look up.
entity HeadingEntity
The new heading to save
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HeadingEntity> The saved entity.SaveHeadingsForListItemFromListDefinitionAsync(int, int, SelectableMDOListItem[], RequestOptions)
Saves the active headings for the list item.Parameters
udListDefinitionId int
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.
listItemId int
The identity of the list item to delete
headings SelectableMDOListItem[]
The headings to save.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectableMDOListItem[]> Array of headingsSaveHeadingsForListItemFromListNameAsync(string, int, SelectableMDOListItem[], RequestOptions)
Saves the headings for the list item.Parameters
udListDefinitionName string
The name of the list definition, indicating which list to update.
listItemId int
The identity of the list item
headings SelectableMDOListItem[]
The headings to save.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SelectableMDOListItem[]> Array of selectable headingsSaveHeadingsFromListDefinitionAsync(int, HeadingEntity[], RequestOptions)
Save headings for list resolved by the provided id.Parameters
id int
The id of the list to look up.
entities HeadingEntity[]
The headings to save
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HeadingEntity[]> List of headingsSaveHeadingsFromNameAsync(string, HeadingEntity[], RequestOptions)
Save headings for list resolved by the provided name.Parameters
name string
The name of the list to look up.
entities HeadingEntity[]
The headings to save
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HeadingEntity[]> List of headingsSaveHierarchyEntityAsync(HierarchyEntity, RequestOptions)
Updates the existing HierarchyEntity or creates a new HierarchyEntity if the id parameter is 0.Parameters
hierarchyEntity HierarchyEntity
The HierarchyEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<HierarchyEntity> New or updated HierarchyEntitySaveLegalBaseAsync(LegalBase, RequestOptions)
Parameters
legalBase LegalBase
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<LegalBase>SaveListEntityAsync(ListEntity, RequestOptions)
Updates the existing ListEntity or creates a new ListEntity if the id parameter is 0.Parameters
listEntity ListEntity
The ListEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListEntity> New or updated ListEntitySaveListEntityByNameAsync(string, ListEntity, RequestOptions)
Save a ListEntity resolved by the provided name.Parameters
name string
The name of the list to save.
listEntity ListEntity
The ListEntity to save.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListEntity> A ListEntity or null.SaveListItemEntityAsync(ListItemEntity, RequestOptions)
Save the ListItemEntity.Parameters
listItemEntity ListItemEntity
The ListItemEntity to save.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ListItemEntity> The saved ListItemEntity.SavePictureFolderEntityAsync(PictureFolderEntity, RequestOptions)
Updates the existing PictureFolderEntity or creates a new PictureFolderEntity if the id parameter is 0.Parameters
pictureFolderEntity PictureFolderEntity
The PictureFolderEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<PictureFolderEntity> New or updated PictureFolderEntitySaveProjectTypeEntityAsync(ProjectTypeEntity, RequestOptions)
Updates the existing ProjectTypeEntity or creates a new ProjectTypeEntity if the id parameter is 0.Parameters
projectTypeEntity ProjectTypeEntity
The ProjectTypeEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectTypeEntity> New or updated ProjectTypeEntitySaveQuickRepliesAsync(QuickReply[], RequestOptions)
Method to save all quick replies for a given associateParameters
quickReplies QuickReply[]
Array of quick replies
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSaveRelationDefinitionEntityAsync(RelationDefinitionEntity, RequestOptions)
Updates the existing RelationDefinitionEntity or creates a new RelationDefinitionEntity if the id parameter is 0.Parameters
relationDefinitionEntity RelationDefinitionEntity
The RelationDefinitionEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<RelationDefinitionEntity> New or updated RelationDefinitionEntitySaveResourceEntityAsync(ResourceEntity, RequestOptions)
Updates the existing ResourceEntity or creates a new ResourceEntity if the id parameter is 0.Parameters
resourceEntity ResourceEntity
The ResourceEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ResourceEntity> New or updated ResourceEntitySaveSaleStageEntityAsync(SaleStageEntity, RequestOptions)
Updates the existing SaleStageEntity or creates a new SaleStageEntity if the id parameter is 0.Parameters
saleStageEntity SaleStageEntity
The SaleStageEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleStageEntity> New or updated SaleStageEntitySaveSaleTypeEntityAsync(SaleTypeEntity, RequestOptions)
Updates the existing SaleTypeEntity or creates a new SaleTypeEntity if the id parameter is 0.Parameters
saleTypeEntity SaleTypeEntity
The SaleTypeEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleTypeEntity> New or updated SaleTypeEntitySaveTaskMenuAsync(TaskMenu, RequestOptions)
Updates the existing TaskMenu or creates a new TaskMenu if the id parameter is 0.Parameters
taskMenu TaskMenu
The TaskMenu that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TaskMenu> New or updated TaskMenuSaveTicketCategoryEntityAsync(TicketCategoryEntity, RequestOptions)
Updates the existing TicketCategoryEntity or creates a new TicketCategoryEntity if the id parameter is 0.Parameters
ticketCategoryEntity TicketCategoryEntity
The TicketCategoryEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketCategoryEntity> New or updated TicketCategoryEntitySaveTicketPriorityEntityAsync(TicketPriorityEntity, RequestOptions)
Updates the existing TicketPriorityEntity or creates a new TicketPriorityEntity if the id parameter is 0.Parameters
ticketPriorityEntity TicketPriorityEntity
The TicketPriorityEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketPriorityEntity> New or updated TicketPriorityEntitySaveTicketRelationDefinitionEntityAsync(TicketRelationDefinitionEntity, RequestOptions)
Updates the existing TicketRelationDefinitionEntity or creates a new TicketRelationDefinitionEntity if the id parameter is 0.Parameters
ticketRelationDefinitionEntity TicketRelationDefinitionEntity
The TicketRelationDefinitionEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketRelationDefinitionEntity> New or updated TicketRelationDefinitionEntitySaveTicketStatusEntityAsync(TicketStatusEntity, RequestOptions)
Updates the existing TicketStatusEntity or creates a new TicketStatusEntity if the id parameter is 0.Parameters
ticketStatusEntity TicketStatusEntity
The TicketStatusEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketStatusEntity> New or updated TicketStatusEntitySaveTicketTypeEntityAsync(TicketTypeEntity, RequestOptions)
Updates the existing TicketTypeEntity or creates a new TicketTypeEntity if the id parameter is 0.Parameters
ticketTypeEntity TicketTypeEntity
The TicketTypeEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<TicketTypeEntity> New or updated TicketTypeEntitySaveWebPanelEntityAsync(WebPanelEntity, RequestOptions)
Updates the existing WebPanelEntity or creates a new WebPanelEntity if the id parameter is 0.Parameters
webPanelEntity WebPanelEntity
The WebPanelEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<WebPanelEntity> New or updated WebPanelEntitySetDocumentPluginForAllDocumentTemplatesAsync(int, RequestOptions)
Sets the document-plugin to be used for all templates of type ‘document’.Parameters
documentPluginId int
The numerical ID of the document-plugin to use.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueSetDocumentTemplateFromDocumentTemplateAsync(int, DocumentTemplateEntity, RequestOptions)
Create a new document template based on another templateParameters
sourceDocumentTemplateId int
The document template to copy contents from.
documentTemplateEntity DocumentTemplateEntity
The new document template entity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DocumentTemplateEntity> The new document template entitySetDocumentTemplateStreamAsync(DocumentTemplateEntity, byte[], string, int, RequestOptions)
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.Parameters
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 byte[]
The document as a stream.
languageCode string
The language code (‘en-US’, ‘nb-NO’, etc). Use empty string if not supported or used.
pluginId int
The plugin id to store the template with. 0 for SOArc
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
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, RequestOptions)
Turn on the Emarketing strict mode, which will enable full GDPR rules concerning Emarketing consents and subscriptionsParameters
enable bool
Set to true to enable strict mode
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task A void returnSetHeadingsForListItemAsync(int, int, int[], bool, RequestOptions)
Set headings which this list item should be listed underParameters
udListDefinitionId int
The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
listItemId int
The id of the list item
headingIds int[]
The ids of the headings to set for this list item
enable bool
Set to true to enable, false to disable
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSetListItemsForHeadingAsync(int, int, int[], bool, RequestOptions)
Update listItems that will be visible for this usergroupParameters
udListDefinitionId int
The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
headingId int
The id of the heading
listItemIds int[]
The ids of the list items.
enable bool
True to enable, false to disable
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSetListItemsForHeadingFromListNameAsync(string, int, int[], bool, RequestOptions)
Update listItems under this headingParameters
udListDefinitionName string
The name of the list definition.
headingId int
The id of the heading
listItemIds int[]
The ids of the list items.
enable bool
True to enable, false to disable
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSetListItemsForUserGroupAsync(int, int, int[], bool, RequestOptions)
Update listItems that will be visible for this usergroupParameters
udListDefinitionId int
The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
usergroupId int
The id of the userGroup
listItemIds int[]
The id of the list items.
enable bool
True to enable, false to disable
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSetListItemsForUserGroupFromListNameAsync(string, int, int[], bool, RequestOptions)
Update listItems that will be visible for this usergroupParameters
udListDefinitionName string
The name of the list definition.
usergroupId int
The id of the userGroup
listItemsID int[]
The id of the list items.
enable bool
True to enable, false to disable
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSetRankOnHeadingsAsync(int, int[], RequestOptions)
Set rank order on headingsParameters
udListDefinitionId int
The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
headingIds int[]
The ids of the headings in the order you want
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSetRankOnProjectActivityAsync(int, int[], RequestOptions)
Set rank order on project activityParameters
projectTypeStatusLinkId int
The id of the list
itemsIds int[]
The ids of the items in the order you want
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSetRankOnProjectDocumentAsync(int, int[], RequestOptions)
Set rank order on project documentParameters
projectTypeStatusLinkId int
The id of the list
itemsIds int[]
The ids of the items in the order you want
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSetRankOnSaleActivityAsync(int, int[], RequestOptions)
Set rank order on sale activityParameters
saleTypeStageLinkId int
The id of the list
itemsIds int[]
The ids of the items in the order you want
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSetRankOnSaleDocumentAsync(int, int[], RequestOptions)
Set rank order on project documentParameters
saleTypeStageLinkId int
The id of the list
itemsIds int[]
The ids of the items in the order you want
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSetTicketCategoriesForUserGroupAsync(int, int[], RequestOptions)
Set ticket categories for one user groupParameters
userGroupId int
The ids of the user groups we want tickets categories from
categoryIds int[]
The ids of the user groups we want tickets categories from
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueSetTicketPrioritySortOrderAsync(int, int, RequestOptions)
This method will set sort order of ticket priority in a listParameters
ticketPriorityId int
Id of ticket priority
sortOrder int
Indicates the sort order for this priority. 1 is first. Any records following this one will be renumbered automatically
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueSetTicketRelationDefinitionSortOrderAsync(int, int, RequestOptions)
This method will set sort order of ticket relation definition in a listParameters
ticketRelationDefId int
Id of ticket relation definition
sortOrder int
Indicates the sort order for this relation definition. 1 is first. Any records following this one will be renumbered automatically
requestOptions RequestOptions
Override language/culture codes on this request.